chore: add @distributive eslint config

In addition to adding the config, lint issues were addressed.

.eslintrc.js

@@ -1,29 +1,38 @@
-"use strict";
+/**
+ * @file    .eslintrc.js - Configures ESLint for the plugin repo.
+ *
+ * @author  Joash Mathew <[email protected]>
+ * @author  Bryan Hoang <[email protected]>
+ * @date    June 2023, Aug. 2023
+ */
+'use strict';
 
 /** @type {import('eslint').Linter.Config} */
 module.exports = {
   root: true,
   extends: [
-    "eslint:recommended",
-    "plugin:n/recommended",
-    "plugin:eslint-plugin/tests",
-    "plugin:eslint-plugin/rules-recommended",
+    'eslint:recommended',
+    'plugin:n/recommended',
+    'plugin:eslint-plugin/tests',
+    'plugin:eslint-plugin/rules-recommended',
+    '@distributive',
+    'plugin:@distributive/recommended',
   ],
   env: {
     node: true,
   },
-  overrides: [
-    {
-      files: ["tests/**/*.js"],
-      env: { mocha: true },
+  overrides: [ {
+    files: ['**/*.mjs'],
+    parserOptions: {
+      sourceType: 'module',
     },
+  },
   ],
   rules: {
-    "eslint-plugin/meta-property-ordering": "error",
-    "eslint-plugin/report-message-format": ["error", "^[A-Z].*\\.$"],
-    "eslint-plugin/require-meta-docs-description": [
-      "error",
-      {
+    'eslint-plugin/meta-property-ordering': 'error',
+    'eslint-plugin/report-message-format': ['error', '^[A-Z].*\\.$'],
+    'eslint-plugin/require-meta-docs-description': [
+      'error', {
         pattern: '^(Enforce|Require|Disallow)',
       },
     ],

lib/index.js

@@ -1,20 +1,24 @@
 /**
- * @fileoverview Plugin containing Distributive style guide stuff
- * @author Joash Mathew
+ * @file    lib/index.js - Entrypoint for the plugin.
+ *
+ * @author  Joash Mathew <[email protected]>
+ * @author  Bryan Hoang <[email protected]>
+ * @date    June 2023, Aug. 2023
  */
-"use strict";
 
-//------------------------------------------------------------------------------
+'use strict';
+
+// ------------------------------------------------------------------------------
 // Requirements
-//------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
 
 // ------------------------------------------------------------------------------
 // Plugin Definition
-//------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
 
 module.exports.meta = {
-  name: "eslint-plugin-distributive",
-  version: "1.0.0",
+  name: 'eslint-plugin-distributive',
+  version: '1.0.0',
 }
 
 // import all rules in lib/rules

package.json

@@ -32,13 +32,12 @@
     "test": "vitest",
     "update:eslint-docs": "eslint-doc-generator"
   },
-  "dependencies": {
-    "requireindex": "^1.2.0"
-  },
   "devDependencies": {
+    "@distributive/eslint-config": "1.0.4",
     "eslint": "^8.48.0",
     "eslint-doc-generator": "^1.4.3",
     "eslint-plugin-eslint-plugin": "^5.1.1",
+    "eslint-plugin-jsdoc": "46.5.0",
     "eslint-plugin-n": "^16.0.2",
     "npm-run-all": "^4.1.5",
     "vitest": "^0.34.3"

tests/lib/rules/brace-style.test.js

@@ -1,7 +1,12 @@
 /**
- * @fileoverview Enforce bracing styles in accordance to the Distributive style guide
- * @author Joash Mathew
+ * @file    brace-style.test.js - Tests the custom brace-style rule against
+ *          valid & invalid test cases.
+ *
+ * @author  Joash Mathew <[email protected]>
+ * @author  Bryan Hoang <[email protected]>
+ * @date    June 2023, Aug. 2023
  */
+
 'use strict';
 
 // ------------------------------------------------------------------------------

vitest.config.mjs

@@ -1,3 +1,12 @@
+/**
+ * @file    vitest.config.mjs - Configures `vitest` for testing the project.
+ *
+ *          See {@link https://vitest.dev/config/}.
+ *
+ * @author  Bryan Hoang <[email protected]>
+ * @date    Aug. 2023
+ */
+
 import { defineConfig } from 'vitest/config';
 
 export default defineConfig({