@mimik/eslint-plugin-document-env 2.0.5 → 2.0.7

package/index.js

@@ -2,58 +2,96 @@ const HEADER = ' * | Env variable name | Description | Default | Comments |\n';
 const LINE = ' * | ----------------- | ----------- | ------- | -------- |\n';
 const SINGLE = 1;
 const NO_DESCRIPTION = 2;
+const FIRST = 0;
+const EMPTY = 0;
+
+const isProcessEnvAccess = node => (
+  node.object?.name === 'process'
+  && !node.computed
+  && node.property?.name === 'env'
+);
+const regular = propName => new RegExp(
+  `^ \\* \\| (${propName.replace(/[|\\{}()[\]^$+*?.]/gu, '\\$&')}) \\| *([^\\|]*)`,
+  'mgu',
+);
+const extractEnvVarName = (node, context) => node.parent?.property?.name
+  || context.getSourceCode().text.slice(node.parent.property.start, node.parent.property.end);
+const findEnvDocInComments = (comments, propName) => {
+  const regex = regular(propName);
+
+  return comments.filter(comment =>
+    comment.type === 'Block'
+    && comment.value.includes(HEADER)
+    && comment.value.includes(LINE)
+    && comment.value.match(regex),
+  );
+};
 
 const plugin = {
   rules: {
     'validate-document-env': {
       create(context) {
+        const { comments } = context.getSourceCode().ast;
+
         return {
           MemberExpression(node) {
-            const objectName = node.object.name;
-            const propertyName = node.property.name;
-
-            if (objectName === 'process' && !node.computed && propertyName && propertyName === 'env') {
-              if (node.parent && node.parent.property) {
-                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(/[|\\{}()[\]^$+*?.]/gu, '\\$&')}) \\| *([^\\|]*)`, 'mgu');
-
-                allComments.forEach((comment) => {
-                  if (!foundDocument && comment.type === 'Block' && comment.value.includes(HEADER) && comment.value.includes(LINE)) {
-                    let match = comment.value.match(reg);
-
-                    if (match) {
-                      foundDocument = true;
-                      if (match.length > SINGLE) context.report({ data: { name: propName }, messageId: 'duplicatedProcessEnv', node });
-                      else {
-                        match = reg.exec(comment.value);
-                        if (!match[NO_DESCRIPTION]) context.report({ data: { name: propName }, messageId: 'unDesribedProcessEnv', node });
-                      }
-                    }
-                  }
+            if (!isProcessEnvAccess(node) || !node.parent?.property) return;
+
+            const propName = extractEnvVarName(node, context);
+            const matchedComment = findEnvDocInComments(comments, propName);
+
+            if (!matchedComment || matchedComment.length === EMPTY) {
+              context.report({
+                node,
+                messageId: 'unDocumentedProcessEnv',
+                data: { name: propName },
+              });
+              return;
+            }
+            if (matchedComment.length > SINGLE) {
+              context.report({
+                node,
+                messageId: 'duplicatedProcessEnv',
+                data: { name: propName },
+              });
+              return;
+            }
+            const regex = regular(propName);
+            let match = matchedComment[FIRST].value.match(regex);
+
+            if (match?.length > SINGLE) {
+              context.report({
+                node,
+                messageId: 'duplicatedProcessEnv',
+                data: { name: propName },
+              });
+            }
+            else {
+              match = regex.exec(matchedComment[FIRST].value);
+              if (!match[NO_DESCRIPTION]) {
+                context.report({
+                  node,
+                  messageId: 'unDescribedProcessEnv',
+                  data: { name: propName },
                 });
-                if (!foundDocument) context.report({ data: { name: propName }, messageId: 'unDocumentedProcessEnv', node });
               }
             }
           },
         };
       },
       meta: {
+        type: 'problem',
         docs: {
           category: 'Node.js',
-          description: 'Validate document for environment variables',
+          description: 'Validate documentation for environment variables.',
           recommended: false,
         },
+        schema: [],
         messages: {
           duplicatedProcessEnv: 'Duplicated definition for environment variable: {{ name }}',
-          unDesribedProcessEnv: 'Undescribed environment variable: {{ name }}',
+          unDescribedProcessEnv: 'Undescribed environment variable: {{ name }}',
           unDocumentedProcessEnv: 'Undocumented environment variable: {{ name }}',
         },
-        schema: [],
-        type: 'problem',
       },
     },
   },

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@mimik/eslint-plugin-document-env",
-  "version": "2.0.5",
+  "version": "2.0.7",
   "description": "validation of environement variable documentation",
   "main": "./index.js",
   "type": "module",
   "scripts": {
     "lint": "eslint . --no-error-on-unmatched-pattern",
-    "test": "echo \"Error: no test specified\" && exit 0",
-     "prepublishOnly": "npm run lint && npm run test"
+    "test": "node --test test/*.test.js",
+    "prepublishOnly": "npm run lint && npm run test"
   },
   "husky": {
     "hooks": {
@@ -26,13 +26,13 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://bitbucket.org/mimiktech/eslit-plugin-document-env"
+    "url": "git+https://bitbucket.org/mimiktech/eslint-plugin-document-env.git"
   },
   "devDependencies": {
-    "@eslint/js": "9.23.0",
-    "@stylistic/eslint-plugin": "4.2.0",
-    "eslint": "9.23.0",
-    "eslint-plugin-import": "2.31.0",
+    "@eslint/js": "9.30.1",
+    "@stylistic/eslint-plugin": "5.1.0",
+    "eslint": "9.30.1",
+    "eslint-plugin-import": "2.32.0",
     "husky": "9.1.7"
   }
 }

package/test/validate-document-env.test.js

@@ -0,0 +1,69 @@
+import { RuleTester } from 'eslint';
+import rule from '../index.js';
+
+const tester = new RuleTester({
+  languageOptions: { ecmaVersion: 2022, sourceType: 'module' },
+});
+
+tester.run('validate-document-env', rule.rules['validate-document-env'], {
+  valid: [
+    {
+      code: `
+/**
+ * | Env variable name | Description | Default | Comments |
+ * | ----------------- | ----------- | ------- | -------- |
+ * | MY_VAR | when existent on non null, will translate an IPV6 address into IPV4 address when possible | | 
+ */
+        const v = process.env.MY_VAR;
+      `,
+    },
+  ],
+  invalid: [
+    {
+      code: `
+        const v = process.env.UNDOCUMENTED_VAR;
+      `,
+      errors: [{ messageId: 'unDocumentedProcessEnv' }],
+    },
+    {
+      code: `
+/**
+ * | Env variable name | Description | Default | Comments |
+ * | ----------------- | ----------- | ------- | -------- |
+ * | UNDESCRIBED_VAR |             | none    | -        |
+ */
+        const v = process.env.UNDESCRIBED_VAR;
+      `,
+      errors: [{ messageId: 'unDescribedProcessEnv' }],
+    },
+    {
+      code: `
+/**
+ * | Env variable name | Description | Default | Comments |
+ * | ----------------- | ----------- | ------- | -------- |
+ * | DUP_VAR | a           | none    | -        |
+ */
+        const separation = 'test';
+/**
+ * | Env variable name | Description | Default | Comments |
+ * | ----------------- | ----------- | ------- | -------- |
+ * | DUP_VAR | b           | none    | -        |
+ */
+        const v = process.env.DUP_VAR;
+      `,
+      errors: [{ messageId: 'duplicatedProcessEnv' }],
+    },
+    {
+      code: `
+/**
+ * | Env variable name | Description | Default | Comments |
+ * | ----------------- | ----------- | ------- | -------- |
+ * | DUP_VAR | a           | none    | -        |
+ * | DUP_VAR | b           | none    | -        |
+ */
+        const v = process.env.DUP_VAR;
+        `,
+      errors: [{ messageId: 'duplicatedProcessEnv' }],
+    },
+  ],
+});

package/.eslintrc

@@ -1,34 +0,0 @@
-{
-  "env": {
-    "node": true
-  },
-  "parserOptions": {
-    "ecmaVersion": 2020
-  },
-  "extends": "airbnb",
-  "rules": {
-    "import/no-extraneous-dependencies": ["error", {"devDependencies": true}],
-    "brace-style": [1, "stroustrup", {"allowSingleLine": true}],
-    "no-confusing-arrow": [0], // arrow isnt confusing
-    "max-len": [1, 180, { "ignoreComments": true }],
-    "linebreak-style": 0,
-    "quotes": [1, "single"],
-    "semi": [1, "always"],
-    "no-process-env": ["error"]
-  },
-  "settings":{
-    "react": {
-      "version": "detect"
-    }
-  },
-  "globals": {
-    "module": true,
-    "require": true,
-    "const": false,
-    "it": false,
-    "describe": false,
-    "before": true,
-    "after": true,
-    "JSON": true
-  }
-}