@markof/eslint-plugin-no-chinese 1.0.2

package/README.md

@@ -0,0 +1,28 @@
+# eslint-plugin-no-chinese
+eslint plugin to forbid chinese
+
+## Install
+```
+npm i @markof/eslint-plugin-no-chinese --save-dev
+```
+
+## Usage
+Add '@markof/eslint-plugin-no-chinese' to plugins in .eslintrc file.
+```javascript
+{
+  "plugins": [
+    "@markof/eslint-plugin-no-chinese"
+  ]
+}
+```
+
+Config rules in .eslintrc file.
+```javascript
+{
+  "rules": {
+    "@markof/eslint-plugin-no-chinese/no-chinese-code": "error",
+    "@markof/eslint-plugin-no-chinese/no-chinese-comment": "error",
+    "@markof/eslint-plugin-no-chinese/no-chinese-console": "error",
+  }
+}
+```

package/lib/index.js

@@ -0,0 +1,21 @@
+const pkg = require('../package.json')
+
+const plugin = {
+  meta: {
+    name: pkg.name,
+    version: pkg.version,
+  },
+  configs: {},
+  rules: {
+    "no-chinese-code": require('./rules/no-chinese-code.js'),
+    "no-chinese-comment": require('./rules/no-chinese-comment.js'),
+    "no-chinese-console": require('./rules/no-chinese-console.js'),
+  },
+  processors: {}
+}
+
+// for ESM
+export default plugin;
+
+// OR for CommonJS
+module.exports = plugin;

package/lib/rules/no-chinese-code.js

@@ -0,0 +1,29 @@
+
+const REGEX = /[\u4e00-\u9fff\uff00-\uffef\u3000-\u303f\u2014\u2018-\u2019\u2026\u201c\u201d]/
+
+function hasChinese(value) {
+  return REGEX.test(value)
+}
+
+module.exports = {
+  create: function(context) {
+    return {
+      Literal: function(node) {
+        const { value } = node
+        // check if the node is in the console
+        if (node && node.parent && node.parent.callee && node.parent.callee.object && node.parent.callee.object.name === 'console') {
+          return;
+        }
+        if (hasChinese(value)) {
+          context.report({
+            node,
+            message: '{{ str }} Avoid using Chinese in the code',
+            data: {
+              str: node.value,
+            },
+          });
+        }
+      },
+    };
+  },
+};

package/lib/rules/no-chinese-comment.js

@@ -0,0 +1,29 @@
+const REGEX = /[\u4e00-\u9fff\uff00-\uffef\u3000-\u303f\u2014\u2018-\u2019\u2026\u201c\u201d]/
+
+function hasChinese(value) {
+  return REGEX.test(value)
+}
+
+module.exports = {
+  create: function (context) {
+
+    const sourceCode = context.getSourceCode()
+
+    return {
+      Program() {
+        const comments = sourceCode.getAllComments();
+        comments.forEach(comment => {
+          if (hasChinese(comment.value)) {
+            context.report({
+              node: comment,
+              message: '{{ str }} Avoid using Chinese in the comments.',
+              data: {
+                str: comment.value,
+              },
+            });
+          }
+        })
+      }
+    }
+  }
+}

package/lib/rules/no-chinese-console.js

@@ -0,0 +1,27 @@
+
+const REGEX = /[\u4e00-\u9fff\uff00-\uffef\u3000-\u303f\u2014\u2018-\u2019\u2026\u201c\u201d]/
+
+function hasChinese(value) {
+  return REGEX.test(value)
+}
+
+module.exports = {
+  create: function(context) {
+    return {
+      Literal: function(node) {
+        const { value } = node;
+        if (node && node.parent && node.parent.callee && node.parent.callee.object && node.parent.callee.object.name === 'console') {
+          if (hasChinese(value)) {
+            context.report({
+              node,
+              message: '{{ str }} Avoid using Chinese in the console.',
+              data: {
+                str: node.value,
+              },
+            });
+          }
+        }
+      },
+    };
+  },
+};

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@markof/eslint-plugin-no-chinese",
+  "version": "1.0.2",
+  "description": "eslint plugin to forbid chinese",
+  "keywords": ["eslint", "eslint-plugin", "chinese"],
+  "repository": "https://github.com/markof/eslint-plugin-no-chinese",
+  "author": "Markof",
+  "main": "lib/index.js",
+  "scripts": {
+    "lint": "eslint .",
+    "test": "mocha tests --recursive"
+  },
+  "dependencies": {
+    "requireindex": "^1.2.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.0.1",
+    "eslint-plugin-eslint-plugin": "^4.0.1",
+    "eslint-plugin-node": "^11.1.0",
+    "mocha": "^9.2.2"
+  },
+  "engines": {
+    "node": ">= 16"
+  },
+  "peerDependencies": {
+    "eslint": ">=6"
+  },
+  "license": "ISC"
+}

package/tests/index.js

@@ -0,0 +1,53 @@
+const RuleTester = require("eslint").RuleTester
+var ruleTester = new RuleTester()
+const ruleNoChineseCode = require("../lib/rules/no-chinese-code")
+const ruleNoChineseComments = require("../lib/rules/no-chinese-comments")
+const ruleNoChineseConsole = require("../lib/rules/no-chinese-console")
+
+ruleTester.run("no-chinese-code", ruleNoChineseCode, {
+  valid: ["function test(d, e, f) { console.log('中文'); return 'chinese' }"],
+  invalid: [
+    {
+      code: "function test(d, e, f) { console.log('中文'); return '中文' }",
+      errors: [{message: "中文 Avoid using Chinese in the code"}]
+    },
+    {
+      code: "function test(d, e, f) { console.log('chinese'); return 'it’s name is chinese' }",
+      errors: [{message: "it’s name is chinese Avoid using Chinese in the code"}]
+    },
+    {
+      code: "function test(d, e, f) {return 'it“s name is chinese'}",
+      errors: [{message: "it“s name is chinese Avoid using Chinese in the code"}]
+    },
+  ],
+})
+
+ruleTester.run("no-chinese-console", ruleNoChineseConsole, {
+  valid: ["function test(d, e, f) { console.log('chinese'); return 'chinese' }"],
+  invalid: [
+    {
+      code: "function test(d, e, f) { console.log('中文'); return 'chinese' }",
+      errors: [{
+        message: "中文 Avoid using Chinese in the console.",
+      }]
+    },
+  ],
+})
+
+ruleTester.run("no-chinese-comments", ruleNoChineseComments, {
+  valid: [`// this is a comment`, `/* this is a comment */`],
+  invalid: [
+    {
+      code: `// 中文`,
+      errors: [{
+        message: " 中文 Avoid using Chinese in the comments.",
+      }]
+    },
+    {
+      code: `/* 中文 */`,
+      errors: [{
+        message: " 中文  Avoid using Chinese in the comments.",
+      }]
+    },
+  ],
+})