Merge pull request #10 from kyaido/option_message

Add custom message option
kyaido · Sep 22, 2021 · b9a23a6 · b9a23a6
2 parents 8524486 + 3c0d29a
commit b9a23a6
Show file tree

Hide file tree

Showing 9 changed files with 131 additions and 65 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,7 @@
+module.exports = {
+  env: {
+    es6: true,
+    node: true,
+  },
+  extends: ['eslint:recommended', 'prettier'],
+};
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
@@ -5,13 +5,12 @@ name: Node.js CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
@@ -20,12 +19,12 @@ jobs:
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-    - run: npm ci
-    - run: npm run build --if-present
-    - run: npm test
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}
diff --git a/README.md b/README.md
@@ -8,22 +8,25 @@ An ESLint micro plugin.
 $ npm install eslint-plugin-literal-blacklist --save-dev
 ```
 
-
 ## Usage
 
+You can put string or object in an array.
+
 ```
 // .eslintrc
 {
   "plugins": [
     "literal-blacklist"
   ],
   "rules": {
-    "literal-blacklist/literal-blacklist": [2, ["put", "your", "rule"]]
+    "literal-blacklist/literal-blacklist": [2, ["put", "your", "string", "or", {
+      term: "object",
+      message: "custom message",
+    }]]
   }
 }
 ```
 
-
 ## Supported Rules
 
 ### `literal-blacklist`

diff --git a/index.js b/index.js
@@ -1,5 +1,5 @@
 'use strict';
 
 module.exports.rules = {
-  'literal-blacklist': require('./rules/literal-blacklist.js')
-};
+  'literal-blacklist': require('./rules/literal-blacklist.js'),
+};
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,14 +1,16 @@
 {
   "name": "eslint-plugin-literal-blacklist",
   "description": "An ESLint micro plugin",
-  "version": "0.1.3",
+  "version": "1.0.0",
   "author": "kyaido",
   "bugs": {
     "url": "https://github.com/kyaido/eslint-plugin-literal-blacklist/issues"
   },
   "devDependencies": {
     "eslint": "^7.32.0",
-    "mocha": "^9.1.1"
+    "eslint-config-prettier": "^8.3.0",
+    "mocha": "^9.1.1",
+    "prettier": "^2.4.1"
   },
   "homepage": "https://github.com/kyaido/eslint-plugin-literal-blacklist",
   "keywords": [
@@ -23,6 +25,8 @@
     "url": "https://github.com/kyaido/eslint-plugin-literal-blacklist.git"
   },
   "scripts": {
-    "test": "mocha tests/**/*.js"
+    "test": "mocha tests/**/*.js",
+    "format": "prettier --write .",
+    "lint": "eslint --fix ."
   }
 }
diff --git a/rules/literal-blacklist.js b/rules/literal-blacklist.js
@@ -1,29 +1,56 @@
 'use strict';
 
-module.exports = function(context) {
+module.exports = {
+  meta: {
+    schema: [
+      {
+        type: 'array',
+        items: {
+          oneOf: [
+            {
+              type: 'string',
+            },
+            {
+              type: 'object',
+              properties: {
+                term: {
+                  type: 'string',
+                },
+                message: {
+                  type: 'string',
+                },
+              },
+              additionalProperties: false,
+            },
+          ],
+        },
+        uniqueItems: true,
+      },
+    ],
+  },
 
-  let options = [];
-  if (Array.isArray(context.options[0])) {
-    options = context.options[0];
-  }
+  create: (context) => {
+    let options = [];
+    if (Array.isArray(context.options[0])) {
+      options = context.options[0];
+    }
 
-  return {
-    'Literal': node => {
-      let message = null;
-      let value = String(node.value);
+    return {
+      Literal: (node) => {
+        const value = String(node.value);
 
-      options.forEach(option => {
-        if(value.indexOf(option) !== -1) {
-          message = `You should not use "${option}".`;
-          context.report({node: node, message: message});
-        }
-      });
-    }
-  };
-};
+        options.forEach((option) => {
+          const isStringOption = typeof option === 'string';
+          const term = isStringOption ? option : option.term;
 
-module.exports.schema = [{
-  type: 'array',
-  items: { type: 'string' },
-  uniqueItems: true
-}];
+          if (value.indexOf(term) !== -1) {
+            const message = isStringOption
+              ? `You should not use '${term}'.`
+              : option.message;
+            context.report({ node, message });
+          }
+        });
+      },
+    };
+  },
+};
diff --git a/tests/literal-blacklist.js b/tests/literal-blacklist.js
@@ -5,36 +5,47 @@ const tester = new RuleTester();
 
 tester.run('literal-blacklist', require('../rules/literal-blacklist'), {
   valid: [
-    { code: 'var https = "https:";',
-      options: [['http:']]
-    },
-    { code: 'var http = "https:";',
-      options: [['http:']]
-    },
-    { code: 'http();',
-      options: [['http:']
-    ]}
+    { code: 'var https = "https:";', options: [['http:']] },
+    { code: 'var http = "https:";', options: [['http:']] },
+    { code: 'http();', options: [['http:']] },
   ],
   invalid: [
-    { code: 'var http = "http://example.com";',
+    {
+      code: 'var http = "http://example.com";',
       options: [['http:']],
-      errors: ['You should not use "http:".']
+      errors: [`You should not use 'http:'.`],
     },
-    { code: 'document.body.innerHTML("<script src=\'http://example.com\'></script>");',
+    {
+      code: 'document.body.innerHTML("<script src=\'http://example.com\'></script>");',
       options: [['http:']],
-      errors: ['You should not use "http:".']
+      errors: [`You should not use 'http:'.`],
     },
-    { code: 'var obj = { url: "http://example.com" };',
+    {
+      code: 'var obj = { url: "http://example.com" };',
       options: [['http:']],
-      errors: ['You should not use "http:".']
+      errors: [`You should not use 'http:'.`],
     },
-    { code: 'var arr = [ "https://example.com", "http://example.com" ];',
+    {
+      code: 'var arr = [ "https://example.com", "http://example.com" ];',
       options: [['http:']],
-      errors: ['You should not use "http:".']
+      errors: [`You should not use 'http:'.`],
     },
-    { code: '(function() { return "http://example.com" })();',
+    {
+      code: '(function() { return "http://example.com" })();',
       options: [['http:']],
-      errors: ['You should not use "http:".']
-    }
-  ]
+      errors: [`You should not use 'http:'.`],
+    },
+    {
+      code: 'var http = "http://example.com";',
+      options: [
+        [
+          {
+            term: 'http:',
+            message: `You should use 'https:' instead of 'http:.'`,
+          },
+        ],
+      ],
+      errors: [`You should use 'https:' instead of 'http:.'`],
+    },
+  ],
 });