chore: add enforce-node-prefix on readme by default

eggjs · Sep 17, 2023 · 29cf704 · 29cf704
1 parent f467f54
commit 29cf704
Show file tree

Hide file tree

Showing 24 changed files with 19 additions and 63 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@
 [download-image]: https://img.shields.io/npm/dm/eslint-config-egg.svg?style=flat-square
 [download-url]: https://npmjs.org/package/eslint-config-egg
 
-Node.js Style Guide for Egg.
+Node.js Style Guide for Eggjs and Node.js
 
 ## Install
 
@@ -27,6 +27,8 @@ npm i eslint eslint-config-egg --save-dev
 
 ## Usage
 
+### Use with JavaScript project
+
 - `package.json`
 
 ```json
@@ -38,12 +40,15 @@ npm i eslint eslint-config-egg --save-dev
 }
 ```
 
-- `.eslintrc.js`
+- `.eslintrc`
 
-```js
-module.exports = {
-  extends: 'eslint-config-egg',
-};
+```json
+{
+  "extends": [
+    "eslint-config-egg",
+    "eslint-config-egg/lib/rules/enforce-node-prefix"
+  ]
+}
 ```
 
 ### Use with TypeScript project
@@ -59,18 +64,15 @@ module.exports = {
 }
 ```
 
-- `.eslintrc.js`
+- `.eslintrc`
 
-```js
-module.exports = {
-  extends: 'eslint-config-egg/typescript',
-  parserOptions: {
-    // recommend to use another config file like tsconfig.eslint.json and extends tsconfig.json in it.
-    // because you may be need to lint test/**/*.test.ts but no need to emit to js.
-    // @see https://github.com/typescript-eslint/typescript-eslint/issues/890
-    project: './tsconfig.json'
-  }
-};
+```json
+{
+  "extends": [
+    "eslint-config-egg/typescript",
+    "eslint-config-egg/lib/rules/enforce-node-prefix"
+  ]
+}
 ```
 
 - `scripts`

diff --git a/lib/rules/best-practices.js b/lib/rules/best-practices.js
@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = {
   rules: {
     /**

diff --git a/lib/rules/browser.js b/lib/rules/browser.js
@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = {
   env: {
     browser: true,

diff --git a/lib/rules/errors.js b/lib/rules/errors.js
@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = {
   rules: {
     /**

diff --git a/lib/rules/es2020.js b/lib/rules/es2020.js
@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = {
   env: {
     es2020: true,

diff --git a/lib/rules/es6.js b/lib/rules/es6.js
@@ -2,8 +2,6 @@
  * ES6
  */
 
-'use strict';
-
 module.exports = {
   env: {
     es6: true,

diff --git a/lib/rules/import.js b/lib/rules/import.js
@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = {
   env: {
     es6: true,

diff --git a/lib/rules/jsdoc.js b/lib/rules/jsdoc.js
@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = {
   plugins: [ 'jsdoc' ],
   settings: {

diff --git a/lib/rules/node.js b/lib/rules/node.js
@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = {
   env: {
     node: true,

diff --git a/lib/rules/react-a11y.js b/lib/rules/react-a11y.js
@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = {
   plugins: [
     'jsx-a11y',

diff --git a/lib/rules/react.js b/lib/rules/react.js
@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = {
   plugins: [
     'react',

diff --git a/lib/rules/strict.js b/lib/rules/strict.js
@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = {
   rules: {
     /**

diff --git a/lib/rules/style.js b/lib/rules/style.js
@@ -1,5 +1,3 @@
-'use strict';
-
 const os = require('os');
 
 module.exports = {

diff --git a/lib/rules/typescript.js b/lib/rules/typescript.js
@@ -1,5 +1,3 @@
-'use strict';
-
 /**
  * all rules https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin#supported-rules
  */

diff --git a/lib/rules/variables.js b/lib/rules/variables.js
@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = {
   rules: {
     /**

diff --git a/test/eggache.test.js b/test/eggache.test.js
@@ -1,5 +1,3 @@
-'use strict';
-
 const path = require('path');
 const coffee = require('coffee');
 

diff --git a/test/es2018.test.js b/test/es2018.test.js
@@ -1,5 +1,3 @@
-'use strict';
-
 const path = require('path');
 const coffee = require('coffee');
 

diff --git a/test/es2020.test.js b/test/es2020.test.js
@@ -1,5 +1,3 @@
-'use strict';
-
 const path = require('path');
 const coffee = require('coffee');
 

diff --git a/test/es8.test.js b/test/es8.test.js
@@ -1,5 +1,3 @@
-'use strict';
-
 const path = require('path');
 const coffee = require('coffee');
 

diff --git a/test/index.test.js b/test/index.test.js
@@ -1,5 +1,3 @@
-'use strict';
-
 const path = require('path');
 const coffee = require('coffee');
 

diff --git a/test/jsdoc.test.js b/test/jsdoc.test.js
@@ -1,5 +1,3 @@
-'use strict';
-
 const path = require('path');
 const coffee = require('coffee');
 

diff --git a/test/legacy.test.js b/test/legacy.test.js
@@ -1,5 +1,3 @@
-'use strict';
-
 const path = require('path');
 const coffee = require('coffee');
 

diff --git a/test/node.test.js b/test/node.test.js
@@ -1,5 +1,3 @@
-'use strict';
-
 const path = require('path');
 const coffee = require('coffee');
 

diff --git a/test/react.test.js b/test/react.test.js
@@ -1,5 +1,3 @@
-'use strict';
-
 const path = require('path');
 const coffee = require('coffee');