fix: update recommended config

README.md

@@ -40,20 +40,25 @@ Then configure the rules you want to use under the rules section.
 
 <!-- begin auto-generated configs list -->
 
-TODO: Run eslint-doc-generator to generate the configs list (or delete this section if no configs are offered).
+|    | Name          |
+| :- | :------------ |
+| ✅  | `recommended` |
 
 <!-- end auto-generated configs list -->
 
 ## Rules
 
 <!-- begin auto-generated rules list -->
 
-| Name                                                             | Description                                   |
-| :--------------------------------------------------------------- | :-------------------------------------------- |
-| [always-camel-case](docs/rules/always-camel-case.md)             | Always camel case every thing                 |
-| [comments-need-space](docs/rules/comments-need-space.md)         | comments need space                           |
-| [kebab-case](docs/rules/kebab-case.md)                           | kebab case your file name and directory name. |
-| [no-then](docs/rules/no-then.md)                                 | No then with promise                          |
-| [prefer-template-literal](docs/rules/prefer-template-literal.md) | prefer template literal                       |
+💼 Configurations enabled in.\
+✅ Set in the `recommended` configuration.
+
+| Name                                                             | Description                                   | 💼 |
+| :--------------------------------------------------------------- | :-------------------------------------------- | :- |
+| [always-camel-case](docs/rules/always-camel-case.md)             | Always camel case every thing                 | ✅  |
+| [comments-need-space](docs/rules/comments-need-space.md)         | comments need space                           | ✅  |
+| [kebab-case](docs/rules/kebab-case.md)                           | kebab case your file name and directory name. | ✅  |
+| [no-then](docs/rules/no-then.md)                                 | No then with promise                          | ✅  |
+| [prefer-template-literal](docs/rules/prefer-template-literal.md) | prefer template literal                       | ✅  |
 
 <!-- end auto-generated rules list -->

docs/rules/always-camel-case.md

@@ -1,5 +1,7 @@
 # Always camel case every thing (`jlc/always-camel-case`)
 
+💼 This rule is enabled in the ✅ `recommended` config.
+
 <!-- end auto-generated rule header -->
 
 ## Rule Details

docs/rules/comments-need-space.md

@@ -1,5 +1,7 @@
 # Comments need space (`jlc/comments-need-space`)
 
+💼 This rule is enabled in the ✅ `recommended` config.
+
 <!-- end auto-generated rule header -->
 
 Comments like below is not ok:

docs/rules/kebab-case.md

@@ -1,5 +1,7 @@
 # Kebab case your file name and directory name (`jlc/kebab-case`)
 
+💼 This rule is enabled in the ✅ `recommended` config.
+
 <!-- end auto-generated rule header -->
 
 If you naming filename like this, it's bad case:

docs/rules/no-then.md

@@ -1,5 +1,7 @@
 # No then with promise (`jlc/no-then`)
 
+💼 This rule is enabled in the ✅ `recommended` config.
+
 <!-- end auto-generated rule header -->
 
 That is bad:

docs/rules/prefer-template-literal.md

@@ -1,5 +1,7 @@
 # Prefer template literal (`jlc/prefer-template-literal`)
 
+💼 This rule is enabled in the ✅ `recommended` config.
+
 <!-- end auto-generated rule header -->
 
 That is bad:

eslint.config.mjs

@@ -2,8 +2,23 @@ import pluginJs from "@eslint/js";
 import pluginNode from "eslint-plugin-n";
 import eslintPlugin from "eslint-plugin-eslint-plugin";
 
+import * as jlc from "./lib/index.js";
+
 export default [
   pluginJs.configs.recommended,
   ...pluginNode.configs["flat/mixed-esm-and-cjs"],
   eslintPlugin.configs["flat/recommended"],
+
+  {
+    files: ["**/*.js"],
+    languageOptions: {
+      sourceType: "commonjs",
+      ecmaVersion: "latest",
+    },
+    // Using the eslint-plugin-example plugin defined locally
+    plugins: { jlc },
+    rules: {
+      "jlc/kebab-case": "error",
+    },
+  },
 ];

lib/configs.js

@@ -0,0 +1,5 @@
+"use strict";
+
+module.exports = {
+  recommended: require("./configs/recommended"),
+};

lib/configs/recommended.js

@@ -0,0 +1,10 @@
+module.exports = {
+  plugins: ["jlc"],
+  rules: {
+    "jlc/always-camel-case": "error",
+    "jlc/comments-need-space": "error",
+    "jlc/kebab-case": "error",
+    "jlc/no-then": "error",
+    "jlc/prefer-template-literal": "error",
+  },
+};

lib/index.js

@@ -1,6 +1,6 @@
 /**
- * @fileoverview Preferences eslint rule  for zeng
- * @author eslint-plugin-zeng
+ * @fileoverview An opinionated collection of ESLint rules used by JLC.
+ * @author zengxiaoluan
  */
 "use strict";
 
@@ -14,9 +14,7 @@ const requireIndex = require("requireindex");
 // Plugin Definition
 //------------------------------------------------------------------------------
 
-
 // import all rules in lib/rules
 module.exports.rules = requireIndex(__dirname + "/rules");
 
-
-
+module.exports.configs = requireIndex(__dirname + "/configs");

lib/rules/kebab-case.js

@@ -8,14 +8,16 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
+let { url, parseFilename } = require("../utils");
+
 /** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
   meta: {
     type: `problem`, // `problem`, `suggestion`, or `layout`
     docs: {
       description: "kebab case your file name and directory name.",
       recommended: false,
-      url: require("../utils").url(module), // URL to the documentation page for this rule
+      url: url(module), // URL to the documentation page for this rule
     },
     fixable: null, // Or `code` or `whitespace`
     schema: [], // Add a schema if the rule has options
@@ -43,8 +45,11 @@ module.exports = {
     return {
       Program: function (node) {
         let filename = context.filename;
+        let physicalFilename = context.physicalFilename;
+
+        let parsed = parseFilename(physicalFilename);
 
-        let matchesRegex = conventionRegexp.test(filename);
+        let matchesRegex = conventionRegexp.test(parsed.base);
 
         if (matchesRegex) {
           context.report({

lib/utils.js

@@ -9,6 +9,18 @@ function url({ id }) {
   return url.toString();
 }
 
+function parseFilename(filename) {
+  let ext = path.extname(filename);
+
+  return {
+    dir: path.dirname(filename),
+    base: path.basename(filename),
+    ext: ext,
+    name: path.basename(filename, ext),
+  };
+}
+
 module.exports = {
   url,
+  parseFilename,
 };