@mimik/eslint-plugin-document-env 1.0.6 → 2.0.0

package/README.md

@@ -6,15 +6,17 @@
 npm install @mimik/eslint-plugin-document-env
 ```
 
-In your `.eslintrc`:
+In your `eslint.config.js`:
+
+```js
+import processDoc from '@mimik/eslint-plugin-document-env';
 
-```json
 {
-  "plugins": [
-    "@mimik/document-env"
-  ],
-  "rules": {
-    "@mimik/document-env/validate-document-env": 2
+  plugins: {
+    processDoc,
+  },
+  rules: {
+    processDoc/validate-document-env: ['error']
   }
 }
 ```
@@ -24,7 +26,7 @@ An [eslint](https://github.com/eslint/eslint) plugin that ...
 
 ### `document-env/validate-document-env`
 
-Verifies that when an environment variable is used, there is a document ation about it after the following header: 
+Verifies that when an environment variable is used, there is a documentation about it after the following header: 
  * | Env variable name | Description | Default | Comments |
  * | ----------------- | ----------- | ------- | -------- |
 

package/eslint.config.js

@@ -0,0 +1,52 @@
+import importPlugin from 'eslint-plugin-import';
+import js from '@eslint/js';
+import stylistic from '@stylistic/eslint-plugin';
+
+const MAX_LENGTH_LINE = 180;
+const MAX_FUNCTION_PARAMETERS = 6;
+const MAX_LINES_IN_FILES = 400;
+const MAX_LINES_IN_FUNCTION = 100;
+const MAX_STATEMENTS_IN_FUNCTION = 40;
+const MIN_KEYS_IN_OBJECT = 10;
+
+export default [
+  {
+    ignores: ['mochawesome-report/**', 'node_modules/**', 'dist/**'],
+  },
+  importPlugin.flatConfigs.recommended,
+  stylistic.configs['recommended-flat'],
+  js.configs.all,
+  {
+    languageOptions: {
+      ecmaVersion: 2022,
+      globals: {
+        console: 'readonly',
+        describe: 'readonly',
+        it: 'readonly',
+        require: 'readonly',
+      },
+      sourceType: 'module',
+    },
+    rules: {
+      '@stylistic/brace-style': ['warn', 'stroustrup', { allowSingleLine: true }],
+      '@stylistic/semi': ['error', 'always'],
+      'capitalized-comments': ['off'],
+      'curly': ['off'],
+      'import/no-extraneous-dependencies': ['error', { devDependencies: true }],
+      'import/no-unresolved': ['error', { amd: true, caseSensitiveStrict: true, commonjs: true }],
+      'init-declarations': ['off'],
+      'linebreak-style': ['off'],
+      'max-len': ['warn', MAX_LENGTH_LINE, { ignoreComments: true }],
+      'max-lines': ['warn', MAX_LINES_IN_FILES],
+      'max-lines-per-function': ['warn', MAX_LINES_IN_FUNCTION],
+      'max-params': ['error', MAX_FUNCTION_PARAMETERS],
+      'max-statements': ['warn', MAX_STATEMENTS_IN_FUNCTION],
+      'no-confusing-arrow': ['off'], // arrow isnt confusing
+      'no-inline-comments': ['off'],
+      'no-process-env': ['error'],
+      'one-var': ['error', 'never'],
+      'quotes': ['warn', 'single'],
+      'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false }],
+    },
+  },
+];

package/index.js

@@ -1,23 +1,11 @@
 const HEADER = ' * | Env variable name | Description | Default | Comments |\n';
 const LINE = ' * | ----------------- | ----------- | ------- | -------- |\n';
-module.exports = {
+const SINGLE = 1;
+const NO_DESCRIPTION = 2;
+
+const plugin = {
   rules: {
     'validate-document-env': {
-      meta: {
-        type: 'problem',
-        docs: {
-          description: 'validate document for environment variables',
-          category: 'Node.js and CommonJS',
-          recommended: false,
-        },
-        schema: [],
-        messages: {
-          unDesribedProcessEnv: 'Undescribed environement variable: {{ name }}',
-          unDocumentedProcessEnv: 'Undocumented environment variable: {{ name }}',
-          duplicatedProcessEnv: 'Duplicated definition for environment variable: {{ name }}',
-        },
-      },
-
       create(context) {
         return {
           MemberExpression(node) {
@@ -26,12 +14,12 @@ module.exports = {
 
             if (objectName === 'process' && !node.computed && propertyName && propertyName === 'env') {
               if (node.parent && node.parent.property) {
-                const allComments = context.getAllComments();
+                const allComments = context.getSourceCode().ast.comments;
                 let foundDocument = false;
                 let propName = node.parent.property.name;
 
                 if (!propName) propName = context.getSourceCode().text.substring(node.parent.property.start, node.parent.property.end);
-                const reg = new RegExp(`^ \\* \\| (${propName.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&')}) \\| *([^\\|]*)`, 'mg');
+                const reg = new RegExp(`^ \\* \\| (${propName.replace(/[|\\{}()[\]^$+*?.]/gu, '\\$&')}) \\| *([^\\|]*)/u`, 'mgu');
 
                 allComments.forEach((comment) => {
                   if (!foundDocument && comment.type === 'Block' && comment.value.includes(HEADER) && comment.value.includes(LINE)) {
@@ -39,20 +27,36 @@ module.exports = {
 
                     if (match) {
                       foundDocument = true;
-                      if (match.length > 1) context.report({ node, messageId: 'duplicatedProcessEnv', data: { name: propName } });
+                      if (match.length > SINGLE) context.report({ data: { name: propName }, messageId: 'duplicatedProcessEnv', node });
                       else {
                         match = reg.exec(comment.value);
-                        if (!match[2]) context.report({ node, messageId: 'unDesribedProcessEnv', data: { name: propName } });
+                        if (!match[NO_DESCRIPTION]) context.report({ data: { name: propName }, messageId: 'unDesribedProcessEnv', node });
                       }
                     }
                   }
                 });
-                if (!foundDocument) context.report({ node, messageId: 'unDocumentedProcessEnv', data: { name: propName } });
+                if (!foundDocument) context.report({ data: { name: propName }, messageId: 'unDocumentedProcessEnv', node });
               }
             }
           },
         };
       },
+      meta: {
+        docs: {
+          category: 'Node.js',
+          description: 'Validate document for environment variables',
+          recommended: false,
+        },
+        messages: {
+          duplicatedProcessEnv: 'Duplicated definition for environment variable: {{ name }}',
+          unDesribedProcessEnv: 'Undescribed environment variable: {{ name }}',
+          unDocumentedProcessEnv: 'Undocumented environment variable: {{ name }}',
+        },
+        schema: [],
+        type: 'problem',
+      },
     },
   },
 };
+
+export default plugin;

package/package.json

@@ -1,8 +1,16 @@
 {
   "name": "@mimik/eslint-plugin-document-env",
-  "version": "1.0.6",
+  "version": "2.0.0",
   "description": "validation of environement variable documentation",
-  "main": "index.js",
+  "main": "./dist/index.cjs.js",
+  "type": "module",
+  "module": "./index.js",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs.js",
+      "import": "./index.js"
+    }
+  },
   "keywords": [
     "eslint",
     "eslint-plugin",
@@ -20,16 +28,20 @@
     "url": "https://bitbucket.org/mimiktech/eslit-plugin-document-env"
   },
   "scripts": {
-    "lint": "eslint --ignore-path .gitignore .",
+    "lint": "eslint . --no-error-on-unmatched-pattern",
     "test": "echo \"Error: no test specified\" && exit 0",
-     "prepublishOnly": "npm run lint && npm run test"
+    "prepublishOnly": "npm run lint && npm run test && npm run build",
+    "build": "rollup -c"
   },
   "devDependencies": {
-    "eslint": "8.55.0",
-    "eslint-config-airbnb": "19.0.4",
-    "eslint-plugin-import": "2.29.0",
-    "eslint-plugin-jsx-a11y": "6.8.0",
-    "eslint-plugin-react": "7.33.2",
-    "eslint-plugin-react-hooks": "4.6.0"
+    "@eslint/js": "9.17.0",
+    "@mimik/eslint-plugin-document-env": "1.0.6",
+    "@rollup/plugin-commonjs": "^28.0.2",
+    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@rollup/plugin-terser": "0.4.4",
+    "@stylistic/eslint-plugin": "2.12.1",
+    "eslint": "9.17.0",
+    "eslint-plugin-import": "2.31.0",
+    "rollup": "^2.79.2"
   }
 }

package/rollup.config.js

@@ -0,0 +1,14 @@
+import commonjs from '@rollup/plugin-commonjs';
+import resolve from '@rollup/plugin-node-resolve';
+import terser from '@rollup/plugin-terser';
+
+export default {
+  input: './index.js', // Entry point
+  output: [
+    {
+      file: './dist/index.cjs.js',
+      format: 'cjs',
+    },
+  ],
+  plugins: [resolve(), commonjs(), terser()],
+};