@conarti/eslint-plugin-feature-sliced 2.0.0-rc.1 → 2.0.0-rc.2

package/README.md

@@ -71,9 +71,7 @@ npm i eslint --save-dev
 Next, install `@conarti/eslint-plugin-feature-sliced`:
 
 ```sh
-npm install -D @conarti/eslint-plugin-feature-sliced
-# or by yarn
-yarn add -D @conarti/eslint-plugin-feature-sliced
+npm i -D @conarti/eslint-plugin-feature-sliced
 ```
 
 Note: the plugin may conflict with other import sorting plugins installed in your project. 
@@ -81,45 +79,49 @@ If you do not want to use this plugin's sorting, disable it. More about this bel
 
 ## Usage
 
-[//]: # (// TODO)
+For simple use with loose settings, just call the function:
 
-Add `@conarti/feature-sliced/recommended` to extends section of your `.eslintrc` configuration file. 
-It enables all rules and additional recommended configs of other eslint plugins, like `eslint-plugin-import`. 
+```js
+// eslint.config.js
+import featureSliced from '@conarti/eslint-plugin-feature-sliced';
 
-```json
-{
-  "extends": [
-    "plugin:@conarti/feature-sliced/recommended"
-  ]
-}
+export default [
+    featureSliced(),
+]
 ```
 
 ## Customisation
 
-If you want to use only plugin rules, add `@conarti/feature-sliced/rules` instead.
-
-```json
-{
-  "extends": [
-    "plugin:@conarti/feature-sliced/rules"
-  ]
-}
-```
-
-If you only want to use certain rules, you can add them individually. To do this, you need to add `@conarti/feature-sliced` to the 'plugins'
-section of the configuration file and add the desired rules to the 'rules' section. Also now you don't need to use the 'extends' section like before
-
-```json
-{
-  "plugins": [
-    "@conarti/feature-sliced"
-  ],
-  "rules": {
-    "@conarti/feature-sliced/layers-slices": "error",
-    "@conarti/feature-sliced/absolute-relative": "error",
-    "@conarti/feature-sliced/public-api": "error"
-  }
-}
+You can also manage any rule and disable them:
+
+```js
+import featureSliced from '@conarti/eslint-plugin-feature-sliced';
+
+export default [
+    featureSliced({
+        /* Enables public api check in segments */
+        publicApi: { level: 'segments' },
+        /* Uses a different import sorter. You can disable it and use your own plugins and configurations */
+        sortImports: 'with-newlines',
+        /* This is how you can completely disable the rule */
+        absoluteRelative: false,
+        layersSlices: {
+            /* This is how you can disable the rule for imports in any files (ignore paths in code) */
+            ignorePatterns: [
+                /**
+                 * Please note that the plugin reads the entire file path from the root of your system, not the project.
+                 * That's why we added "**" to the beginning.
+                 */
+                "**/src/components/**/*"
+            ],
+            /* This is how you can disable the rule for files or folders (ignore all paths in files or folders) */
+            ignoreInFilesPatterns: [
+                /* Do not check imports like "import foo from '@/app/some-module/foo'" */
+                "@/app/some-module/*",
+            ],
+        },
+    }),
+]
 ```
 
 ## Rules

package/dist/index.cjs

@@ -34,11 +34,14 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
-// src/create-plugin.ts
-var import_eslint_flat_config_utils = require("eslint-flat-config-utils");
-
 // src/config.ts
 var PLUGIN_NAME = "@conarti/feature-sliced";
+var RULE_NAMES = {
+  LAYERS_SLICES: `${PLUGIN_NAME}/layers-slices`,
+  ABSOLUTE_RELATIVE: `${PLUGIN_NAME}/absolute-relative`,
+  PUBLIC_API: `${PLUGIN_NAME}/public-api`,
+  IMPORT_ORDER: `${PLUGIN_NAME}/import-order`
+};
 var layers = [
   "shared",
   "entities",
@@ -63,136 +66,12 @@ var segments = [
 ];
 var pathSeparator = "/";
 
-// src/configs/import-order/shared.ts
-var import_eslint_plugin_import_x = __toESM(require("eslint-plugin-import-x"), 1);
-var plugins = {
-  import: import_eslint_plugin_import_x.default
-};
-var LAYERS_REVERSED = [...layers].reverse();
-
-// src/configs/import-order/recommended.ts
-var recommended = {
-  name: "@conarti/sort-imports/recommended",
-  plugins,
-  rules: {
-    "import/order": [
-      2,
-      {
-        "alphabetize": {
-          order: "asc",
-          caseInsensitive: true
-        },
-        "newlines-between": "never",
-        "pathGroups": LAYERS_REVERSED.map(
-          (layer) => ({
-            pattern: `**/?(*)${layer}{,/**}`,
-            group: "internal",
-            position: "after"
-          })
-        ),
-        "distinctGroup": false,
-        "pathGroupsExcludedImportTypes": ["builtin"],
-        "groups": ["builtin", "external", "internal", "parent", "sibling", "index"]
-      }
-    ]
-  }
-};
-
-// src/configs/import-order/with-newlines.ts
-var withNewlines = {
-  name: "@conarti/sort-imports/with-newlines",
-  plugins,
-  rules: {
-    "import/order": [
-      2,
-      {
-        "alphabetize": {
-          order: "asc",
-          caseInsensitive: true
-        },
-        "newlines-between": "always",
-        "pathGroups": LAYERS_REVERSED.map(
-          (layer) => ({
-            pattern: `**/?(*)${layer}{,/**}`,
-            group: "internal",
-            position: "after"
-          })
-        ),
-        "distinctGroup": false,
-        "pathGroupsExcludedImportTypes": ["builtin"],
-        "groups": ["builtin", "external", "internal", "parent", "sibling", "index"]
-      }
-    ]
-  }
-};
-
-// src/configs/import-order/with-newlines-and-type-group.ts
-var withNewlinesAndTypeGroup = {
-  name: "@conarti/sort-imports/with-newlines-and-type-group",
-  plugins,
-  rules: {
-    "import/order": [
-      2,
-      {
-        "alphabetize": {
-          order: "asc",
-          caseInsensitive: true
-        },
-        "newlines-between": "always",
-        "pathGroups": LAYERS_REVERSED.map(
-          (layer) => ({
-            pattern: `**/?(*)${layer}{,/**}`,
-            group: "internal",
-            position: "after"
-          })
-        ),
-        "distinctGroup": false,
-        "pathGroupsExcludedImportTypes": ["builtin", "type"],
-        "groups": ["builtin", "external", "internal", "type", "parent", "sibling", "index"]
-      }
-    ]
-  }
-};
-
-// src/configs/import-order/with-type-group.ts
-var withTypeGroup = {
-  name: "@conarti/sort-imports/with-type-group",
-  plugins,
-  rules: {
-    "import/order": [
-      2,
-      {
-        "alphabetize": {
-          order: "asc",
-          caseInsensitive: true
-        },
-        "newlines-between": "never",
-        "pathGroups": LAYERS_REVERSED.map(
-          (layer) => ({
-            pattern: `**/?(*)${layer}{,/**}`,
-            group: "internal",
-            position: "after"
-          })
-        ),
-        "distinctGroup": false,
-        "pathGroupsExcludedImportTypes": ["builtin", "type"],
-        "groups": ["builtin", "external", "internal", "type", "parent", "sibling", "index"]
-      }
-    ]
-  }
-};
-
-// src/configs/import-order/index.ts
-var importOrder = {
-  recommended,
-  "with-newlines": withNewlines,
-  "with-type-group": withTypeGroup,
-  "with-newlines-and-type-group": withNewlinesAndTypeGroup
-};
-
 // package.json
 var version = "2.0.0-rc.1";
 
+// src/rules/index.ts
+var import_eslint_plugin_import_x = __toESM(require("eslint-plugin-import-x"), 1);
+
 // src/lib/rule/create-rule.ts
 var import_eslint_utils = require("@typescript-eslint/utils/eslint-utils");
 var blobUrl = "https://github.com/conarti/eslint-plugin-feature-sliced/blob/master/src/rules";
@@ -1019,6 +898,7 @@ var public_api_default = createEslintRule({
 // src/rules/index.ts
 var rules = {
   "absolute-relative": absolute_relative_default,
+  "import-order": import_eslint_plugin_import_x.default.rules.order,
   "layers-slices": layers_slices_default,
   "public-api": public_api_default
 };
@@ -1033,6 +913,57 @@ var plugin = {
   rules: rules_default
 };
 
+// src/rules/import-order/configs.ts
+var LAYERS_REVERSED = [...layers].reverse();
+var baseConfig = {
+  alphabetize: {
+    order: "asc",
+    caseInsensitive: true
+  },
+  pathGroups: LAYERS_REVERSED.map((layer) => ({
+    pattern: `**/?(*)${layer}{,/**}`,
+    group: "internal",
+    position: "after"
+  })),
+  distinctGroup: false,
+  pathGroupsExcludedImportTypes: ["builtin"],
+  groups: ["builtin", "external", "internal", "parent", "sibling", "index"]
+};
+var importOrderRuleConfigs = {
+  "recommended": [
+    "error",
+    {
+      ...baseConfig,
+      "newlines-between": "never"
+    }
+  ],
+  "with-newlines": [
+    "error",
+    {
+      ...baseConfig,
+      "newlines-between": "always"
+    }
+  ],
+  "with-type-group": [
+    "error",
+    {
+      ...baseConfig,
+      "newlines-between": "never",
+      "pathGroupsExcludedImportTypes": ["builtin", "type"],
+      "groups": ["builtin", "external", "internal", "type", "parent", "sibling", "index"]
+    }
+  ],
+  "with-newlines-and-type-group": [
+    "error",
+    {
+      ...baseConfig,
+      "newlines-between": "always",
+      "pathGroupsExcludedImportTypes": ["builtin", "type"],
+      "groups": ["builtin", "external", "internal", "type", "parent", "sibling", "index"]
+    }
+  ]
+};
+
 // src/create-plugin.ts
 function createPlugin(options = {}) {
   const {
@@ -1041,41 +972,32 @@ function createPlugin(options = {}) {
     layersSlices,
     publicApi
   } = options;
-  const rules2 = defineRules({ absoluteRelative, layersSlices, publicApi });
-  const config = {
+  const rules2 = defineRules({ absoluteRelative, layersSlices, publicApi, sortImports });
+  return {
     name: PLUGIN_NAME,
     plugins: {
       [PLUGIN_NAME]: plugin
     },
     rules: rules2
   };
-  return enhanceWithImportOrder(config, sortImports);
 }
 function defineRules(options) {
   const {
     absoluteRelative = {},
     layersSlices = {},
-    publicApi = {}
+    publicApi = {},
+    sortImports = "recommended"
   } = options;
-  const createRuleName = (rule) => `${PLUGIN_NAME}/${rule}`;
   const createRuleEntry = (ruleOptions) => ruleOptions ? ["error", ruleOptions] : ["off"];
   const rules2 = {
-    [createRuleName("layers-slices")]: createRuleEntry(layersSlices),
-    [createRuleName("absolute-relative")]: createRuleEntry(absoluteRelative),
-    [createRuleName("public-api")]: createRuleEntry(publicApi)
+    [RULE_NAMES.LAYERS_SLICES]: createRuleEntry(layersSlices),
+    [RULE_NAMES.ABSOLUTE_RELATIVE]: createRuleEntry(absoluteRelative),
+    [RULE_NAMES.PUBLIC_API]: createRuleEntry(publicApi)
   };
-  return rules2;
-}
-function enhanceWithImportOrder(config, importOrderConfigName) {
-  if (!importOrderConfigName) {
-    return config;
+  if (sortImports) {
+    rules2[RULE_NAMES.IMPORT_ORDER] = importOrderRuleConfigs[sortImports];
   }
-  const importOrderConfig = importOrder[importOrderConfigName];
-  return (0, import_eslint_flat_config_utils.mergeConfigs)(
-    importOrderConfig,
-    config
-    // the last one is to set the configuration name as 'PLUGIN_NAME'
-  );
+  return rules2;
 }
 
 // src/index.ts

package/dist/index.d.cts

@@ -50,12 +50,10 @@ interface PublicApiOptions {
      */
     ignoreInFilesPatterns: string[];
 }
-interface ESLintPluginFeatureSlicedRuleOptions {
+interface ESLintPluginFeatureSlicedOptions {
     absoluteRelative?: false | AbsoluteRelativeOptions;
     layersSlices?: false | LayersSlicesOptions;
     publicApi?: false | PublicApiOptions;
-}
-interface ESLintPluginFeatureSlicedOptions extends ESLintPluginFeatureSlicedRuleOptions {
     sortImports?: false | ImportOrderConfigName;
 }
 declare function createPlugin(options?: ESLintPluginFeatureSlicedOptions): TypedFlatConfigItem;

package/dist/index.d.ts

@@ -50,12 +50,10 @@ interface PublicApiOptions {
      */
     ignoreInFilesPatterns: string[];
 }
-interface ESLintPluginFeatureSlicedRuleOptions {
+interface ESLintPluginFeatureSlicedOptions {
     absoluteRelative?: false | AbsoluteRelativeOptions;
     layersSlices?: false | LayersSlicesOptions;
     publicApi?: false | PublicApiOptions;
-}
-interface ESLintPluginFeatureSlicedOptions extends ESLintPluginFeatureSlicedRuleOptions {
     sortImports?: false | ImportOrderConfigName;
 }
 declare function createPlugin(options?: ESLintPluginFeatureSlicedOptions): TypedFlatConfigItem;

package/dist/index.js

@@ -1,8 +1,11 @@
-// src/create-plugin.ts
-import { mergeConfigs } from "eslint-flat-config-utils";
-
 // src/config.ts
 var PLUGIN_NAME = "@conarti/feature-sliced";
+var RULE_NAMES = {
+  LAYERS_SLICES: `${PLUGIN_NAME}/layers-slices`,
+  ABSOLUTE_RELATIVE: `${PLUGIN_NAME}/absolute-relative`,
+  PUBLIC_API: `${PLUGIN_NAME}/public-api`,
+  IMPORT_ORDER: `${PLUGIN_NAME}/import-order`
+};
 var layers = [
   "shared",
   "entities",
@@ -27,136 +30,12 @@ var segments = [
 ];
 var pathSeparator = "/";
 
-// src/configs/import-order/shared.ts
-import pluginImport from "eslint-plugin-import-x";
-var plugins = {
-  import: pluginImport
-};
-var LAYERS_REVERSED = [...layers].reverse();
-
-// src/configs/import-order/recommended.ts
-var recommended = {
-  name: "@conarti/sort-imports/recommended",
-  plugins,
-  rules: {
-    "import/order": [
-      2,
-      {
-        "alphabetize": {
-          order: "asc",
-          caseInsensitive: true
-        },
-        "newlines-between": "never",
-        "pathGroups": LAYERS_REVERSED.map(
-          (layer) => ({
-            pattern: `**/?(*)${layer}{,/**}`,
-            group: "internal",
-            position: "after"
-          })
-        ),
-        "distinctGroup": false,
-        "pathGroupsExcludedImportTypes": ["builtin"],
-        "groups": ["builtin", "external", "internal", "parent", "sibling", "index"]
-      }
-    ]
-  }
-};
-
-// src/configs/import-order/with-newlines.ts
-var withNewlines = {
-  name: "@conarti/sort-imports/with-newlines",
-  plugins,
-  rules: {
-    "import/order": [
-      2,
-      {
-        "alphabetize": {
-          order: "asc",
-          caseInsensitive: true
-        },
-        "newlines-between": "always",
-        "pathGroups": LAYERS_REVERSED.map(
-          (layer) => ({
-            pattern: `**/?(*)${layer}{,/**}`,
-            group: "internal",
-            position: "after"
-          })
-        ),
-        "distinctGroup": false,
-        "pathGroupsExcludedImportTypes": ["builtin"],
-        "groups": ["builtin", "external", "internal", "parent", "sibling", "index"]
-      }
-    ]
-  }
-};
-
-// src/configs/import-order/with-newlines-and-type-group.ts
-var withNewlinesAndTypeGroup = {
-  name: "@conarti/sort-imports/with-newlines-and-type-group",
-  plugins,
-  rules: {
-    "import/order": [
-      2,
-      {
-        "alphabetize": {
-          order: "asc",
-          caseInsensitive: true
-        },
-        "newlines-between": "always",
-        "pathGroups": LAYERS_REVERSED.map(
-          (layer) => ({
-            pattern: `**/?(*)${layer}{,/**}`,
-            group: "internal",
-            position: "after"
-          })
-        ),
-        "distinctGroup": false,
-        "pathGroupsExcludedImportTypes": ["builtin", "type"],
-        "groups": ["builtin", "external", "internal", "type", "parent", "sibling", "index"]
-      }
-    ]
-  }
-};
-
-// src/configs/import-order/with-type-group.ts
-var withTypeGroup = {
-  name: "@conarti/sort-imports/with-type-group",
-  plugins,
-  rules: {
-    "import/order": [
-      2,
-      {
-        "alphabetize": {
-          order: "asc",
-          caseInsensitive: true
-        },
-        "newlines-between": "never",
-        "pathGroups": LAYERS_REVERSED.map(
-          (layer) => ({
-            pattern: `**/?(*)${layer}{,/**}`,
-            group: "internal",
-            position: "after"
-          })
-        ),
-        "distinctGroup": false,
-        "pathGroupsExcludedImportTypes": ["builtin", "type"],
-        "groups": ["builtin", "external", "internal", "type", "parent", "sibling", "index"]
-      }
-    ]
-  }
-};
-
-// src/configs/import-order/index.ts
-var importOrder = {
-  recommended,
-  "with-newlines": withNewlines,
-  "with-type-group": withTypeGroup,
-  "with-newlines-and-type-group": withNewlinesAndTypeGroup
-};
-
 // package.json
 var version = "2.0.0-rc.1";
 
+// src/rules/index.ts
+import pluginImport from "eslint-plugin-import-x";
+
 // src/lib/rule/create-rule.ts
 import { RuleCreator } from "@typescript-eslint/utils/eslint-utils";
 var blobUrl = "https://github.com/conarti/eslint-plugin-feature-sliced/blob/master/src/rules";
@@ -993,6 +872,7 @@ var public_api_default = createEslintRule({
 // src/rules/index.ts
 var rules = {
   "absolute-relative": absolute_relative_default,
+  "import-order": pluginImport.rules.order,
   "layers-slices": layers_slices_default,
   "public-api": public_api_default
 };
@@ -1007,6 +887,57 @@ var plugin = {
   rules: rules_default
 };
 
+// src/rules/import-order/configs.ts
+var LAYERS_REVERSED = [...layers].reverse();
+var baseConfig = {
+  alphabetize: {
+    order: "asc",
+    caseInsensitive: true
+  },
+  pathGroups: LAYERS_REVERSED.map((layer) => ({
+    pattern: `**/?(*)${layer}{,/**}`,
+    group: "internal",
+    position: "after"
+  })),
+  distinctGroup: false,
+  pathGroupsExcludedImportTypes: ["builtin"],
+  groups: ["builtin", "external", "internal", "parent", "sibling", "index"]
+};
+var importOrderRuleConfigs = {
+  "recommended": [
+    "error",
+    {
+      ...baseConfig,
+      "newlines-between": "never"
+    }
+  ],
+  "with-newlines": [
+    "error",
+    {
+      ...baseConfig,
+      "newlines-between": "always"
+    }
+  ],
+  "with-type-group": [
+    "error",
+    {
+      ...baseConfig,
+      "newlines-between": "never",
+      "pathGroupsExcludedImportTypes": ["builtin", "type"],
+      "groups": ["builtin", "external", "internal", "type", "parent", "sibling", "index"]
+    }
+  ],
+  "with-newlines-and-type-group": [
+    "error",
+    {
+      ...baseConfig,
+      "newlines-between": "always",
+      "pathGroupsExcludedImportTypes": ["builtin", "type"],
+      "groups": ["builtin", "external", "internal", "type", "parent", "sibling", "index"]
+    }
+  ]
+};
+
 // src/create-plugin.ts
 function createPlugin(options = {}) {
   const {
@@ -1015,41 +946,32 @@ function createPlugin(options = {}) {
     layersSlices,
     publicApi
   } = options;
-  const rules2 = defineRules({ absoluteRelative, layersSlices, publicApi });
-  const config = {
+  const rules2 = defineRules({ absoluteRelative, layersSlices, publicApi, sortImports });
+  return {
     name: PLUGIN_NAME,
     plugins: {
       [PLUGIN_NAME]: plugin
     },
     rules: rules2
   };
-  return enhanceWithImportOrder(config, sortImports);
 }
 function defineRules(options) {
   const {
     absoluteRelative = {},
     layersSlices = {},
-    publicApi = {}
+    publicApi = {},
+    sortImports = "recommended"
   } = options;
-  const createRuleName = (rule) => `${PLUGIN_NAME}/${rule}`;
   const createRuleEntry = (ruleOptions) => ruleOptions ? ["error", ruleOptions] : ["off"];
   const rules2 = {
-    [createRuleName("layers-slices")]: createRuleEntry(layersSlices),
-    [createRuleName("absolute-relative")]: createRuleEntry(absoluteRelative),
-    [createRuleName("public-api")]: createRuleEntry(publicApi)
+    [RULE_NAMES.LAYERS_SLICES]: createRuleEntry(layersSlices),
+    [RULE_NAMES.ABSOLUTE_RELATIVE]: createRuleEntry(absoluteRelative),
+    [RULE_NAMES.PUBLIC_API]: createRuleEntry(publicApi)
   };
-  return rules2;
-}
-function enhanceWithImportOrder(config, importOrderConfigName) {
-  if (!importOrderConfigName) {
-    return config;
+  if (sortImports) {
+    rules2[RULE_NAMES.IMPORT_ORDER] = importOrderRuleConfigs[sortImports];
   }
-  const importOrderConfig = importOrder[importOrderConfigName];
-  return mergeConfigs(
-    importOrderConfig,
-    config
-    // the last one is to set the configuration name as 'PLUGIN_NAME'
-  );
+  return rules2;
 }
 
 // src/index.ts

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@conarti/eslint-plugin-feature-sliced",
   "type": "module",
-  "version": "2.0.0-rc.1",
+  "version": "2.0.0-rc.2",
   "description": "Feature-sliced design methodology plugin",
   "author": "Aleksandr Belous <abelous2009@gmail.com>",
   "license": "ISC",