update src code names

eslint · Jun 8, 2023 · d0df234 · d0df234
1 parent 1049acd
commit d0df234
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 14 deletions.
diff --git a/docs/_custom-rule-tutorial-code/foo-bar.js → ...tom-rule-tutorial-code/enforce-foo-bar.js b/docs/_custom-rule-tutorial-code/foo-bar.js → ...tom-rule-tutorial-code/enforce-foo-bar.js
@@ -1,6 +1,11 @@
+/** 
+ * @fileoverview Rule to enforce that `const foo` is assigned "bar".
+ * @author Ben Perlmutter
+*/
+
 "use strict";
 
-// The foo-bar rule definition
+// The enforce-foo-bar rule definition
 module.exports = {
     meta: {
         type: "fix",

diff --git a/...custom-rule-tutorial-code/foo-bar.test.js → ...ule-tutorial-code/enforce-foo-bar.test.js b/...custom-rule-tutorial-code/foo-bar.test.js → ...ule-tutorial-code/enforce-foo-bar.test.js
@@ -1,7 +1,7 @@
 "use strict";
 
 const {RuleTester} = require("eslint");
-const fooBarRule = require("./foo-bar");
+const fooBarRule = require("./enforce-foo-bar");
 
 const ruleTester = new RuleTester({
   // Must use at least ecmaVersion 2015 because

diff --git a/docs/_custom-rule-tutorial-code/eslint-plugin-example.js b/docs/_custom-rule-tutorial-code/eslint-plugin-example.js
@@ -0,0 +1,5 @@
+"use strict";
+
+const fooBarRule = require("./enforce-foo-bar");
+const plugin = { rules: { "foo-bar": fooBarRule } };
+module.exports = plugin;
diff --git a/docs/_custom-rule-tutorial-code/eslint-plugin-foo-bar.js b/docs/_custom-rule-tutorial-code/eslint-plugin-foo-bar.js
diff --git a/docs/_custom-rule-tutorial-code/eslint.config.js b/docs/_custom-rule-tutorial-code/eslint.config.js
@@ -1,7 +1,7 @@
 "use strict";
 
 // Import the ESLint plugin
-const eslintPluginFooBar = require("./eslint-plugin-foo-bar");
+const eslintPluginExample = require("./eslint-plugin-example");
 
 module.exports = [
     {
@@ -10,10 +10,10 @@ module.exports = [
             sourceType: "commonjs",
             ecmaVersion: "latest",
         },
-        // Using the eslint-plugin-foo-bar plugin downloaded from npm
-        plugins: {"foo-bar": eslintPluginFooBar},
+        // Using the eslint-plugin-example plugin downloaded from npm
+        plugins: {"example": eslintPluginExample},
         rules: {
-            "foo-bar/foo-bar": "error",
+            "example/foo-bar": "error",
         },
     }
 ]
diff --git a/docs/_custom-rule-tutorial-code/package.json b/docs/_custom-rule-tutorial-code/package.json
@@ -1,8 +1,8 @@
 {
-  "name": "eslint-plugin-foo-bar",
+  "name": "eslint-plugin-example",
   "version": "1.2.0",
-  "description": "ESLint plugin for foo-bar rule.",
-  "main": "eslint-plugin-foo-bar.js",
+  "description": "ESLint plugin for enforce-foo-bar rule.",
+  "main": "eslint-plugin-example.js",
   "keywords": [
     "eslint",
     "eslintplugin",
@@ -12,7 +12,7 @@
     "eslint": ">=0.8.0"
   },
   "scripts": {
-    "test": "node foo-bar.test.js",
+    "test": "node enforce-foo-bar.test.js",
     "pub": "np --yarn false"
   },
   "author": "",