@conarti/eslint-plugin-feature-sliced 1.0.3 → 1.0.5

package/CHANGELOG.md

@@ -1,21 +1,39 @@
-## [1.0.3](https://github.com/conarti/eslint-plugin-fsd/compare/v1.0.2...v1.0.3) (2023-06-27)
-
-
-### Bug Fixes
-
-* **configs:** add 'rules' config definition at main entry point ([a9eba73](https://github.com/conarti/eslint-plugin-fsd/commit/a9eba7319090177d284c9d846afb31f8f024d2d0))
-
-
-
-## [1.0.2](https://github.com/conarti/eslint-plugin-fsd/compare/v1.0.1...v1.0.2) (2023-06-27)
-
-
-### Features
-
-* **configs:** add config contain only rules ([e811a84](https://github.com/conarti/eslint-plugin-fsd/commit/e811a84900f63c95c72efa960e58c591b2d456d5))
-
-
-
+## [1.0.5](https://github.com/conarti/eslint-plugin-fsd/compare/v1.0.4...v1.0.5) (2023-08-08)
+
+
+### Bug Fixes
+
+* **layers-slices:** work with inline type imports ([247883e](https://github.com/conarti/eslint-plugin-fsd/commit/247883ec4154c229dadd540d22f04b9920763b3e))
+* **public-api:** add missed 'type' field at options validation schema ([54ec4e2](https://github.com/conarti/eslint-plugin-fsd/commit/54ec4e2b425d154e2118475fc7ba56699bcbd131))
+
+
+## [1.0.4](https://github.com/conarti/eslint-plugin-fsd/compare/v1.0.3...v1.0.4) (2023-07-03)
+
+
+### Bug Fixes
+
+* correct resolve slice if it contains layer name ([52c2bc7](https://github.com/conarti/eslint-plugin-fsd/commit/52c2bc7b02a16281cf7171dbfac8ee25de34030d))
+
+
+
+## [1.0.3](https://github.com/conarti/eslint-plugin-fsd/compare/v1.0.2...v1.0.3) (2023-06-27)
+
+
+### Bug Fixes
+
+* **configs:** add 'rules' config definition at main entry point ([a9eba73](https://github.com/conarti/eslint-plugin-fsd/commit/a9eba7319090177d284c9d846afb31f8f024d2d0))
+
+
+
+## [1.0.2](https://github.com/conarti/eslint-plugin-fsd/compare/v1.0.1...v1.0.2) (2023-06-27)
+
+
+### Features
+
+* **configs:** add config contain only rules ([e811a84](https://github.com/conarti/eslint-plugin-fsd/commit/e811a84900f63c95c72efa960e58c591b2d456d5))
+
+
+
 ## [1.0.1](https://github.com/conarti/eslint-plugin-fsd/compare/v1.0.0...v1.0.1) (2023-06-27)
 
 ### Bug Fixes

package/README.md

@@ -1,142 +1,132 @@
-# eslint-plugin-conarti-fsd
-
-Feature-sliced design methodology plugin.
-
-_Attention: the plugin is being actively developed and is in **beta**.
-The names of rules and configurations may change in new versions.
-If you find a bug, please open an issue or pull request.
-Feel free to contribute_
-
-## Features
-
-- Works with any framework
-
-- Support for **any aliases** out of the box
-
-```javascript
-import { AppButton } from "~/shared/ui/app-button";
-import { AppButton } from "@/shared/ui/app-button";
-import { AppButton } from "@shared/ui/app-button";
-import { AppButton } from "$shared/ui/app-button";
-import { AppButton } from "$@#$%%shared/ui/app-button";
-```
-
-- Checks for absolute and relative paths
-
-```javascript
-// file: src/widgets/TheHeader/ui/TheHeader.stories.tsx
-
-import { TheHeader } from './TheHeader'; // valid
-import { TheHeader } from 'src/widgets/TheHeader'; // error: should relative
-import { TheHeader } from 'widgets/TheHeader'; // error: should relative
-import { useBar } from '../../../shared/hooks'; // error: should absolute
-```
-
-- Checks for imports from public api and fix them
-
-```javascript
-// file: src/features/search-articles/...
-
-import { addCommentFormActions, addCommentFormReducer } from 'entities/Article/model/file.ts'; // error
-// fix: import { addCommentFormActions, addCommentFormReducer } from 'entities/Article';
-```
-
-- Sort imports
-
-```javascript
-import axios from "axios";                           // 1) external libs
-import { Header } from "widgets/header";             // 2.1) Layers: widgets
-import { Zero } from "widgets/zero";                 // 2.1) Layers: widget 
-import { LoginForm } from "features/login-form";     // 2.2) Layers: features
-import { globalEntities } from "entities";           // 2.4) Layers: entities
-import { authModel } from "entities/auth";           // 2.4) Layers: entities
-import { Cart } from "entities/cart";                // 2.4) Layers: entities 
-import { One } from "entities/one";                  // 2.4) Layers: entities 
-import { Two } from "entities/two";                  // 2.4) Layers: entities
-import { debounce } from "shared/lib/fp";            // 2.5) Layers: shared
-import { Button } from "shared/ui";                  // 2.5) Layers: shared
-import { Input } from "shared/ui";                   // 2.5) Layers: shared
-import { data } from "../fixtures";                  // 3) parent
-import { getSmth } from "./lib";                     // 4) sibling
-```
-
-## Installation
-
-You'll first need to install [ESLint](https://eslint.org/):
-
-```sh
-npm i eslint --save-dev
-```
-
-Next, install `eslint-plugin-conarti-fsd` and dependencies:
-
-```sh
-npm install -D eslint-plugin-conarti-fsd eslint-plugin-import
-# or by yarn
-yarn add -D eslint-plugin-conarti-fsd eslint-plugin-import
-```
-
-## Usage
-
-Add `conarti-fsd` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-`
-prefix:
-
-```json
-{
-  "plugins": [
-    "conarti-fsd"
-  ]
-}
-```
-
-Then enable rules:
-
-```json
-{
-  "extends": [
-    "plugin:conarti-fsd/recommended"
-  ]
-}
-```
-
-## Customization
-
-You can use _warnings_ instead of _errors_ for specific rules. Or turn off certain rules:
-
-```json
-{
-  "rules": {
-    "conarti-fsd/layers-slices": "warn",
-    "conarti-fsd/absolute-relative": "off",
-    "conarti-fsd/public-api": "warn",
-    "import/order": "warn"
-  }
-}
-```
-
-If you don't want to use the 'import/order' rule, you can choose not to install the 'eslint-plugin-import' package.
-And also you will have to configure all the rules separately, without using the config.
-Recommended settings:
-```json
-{
-  "rules": {
-    "conarti-fsd/layers-slices": ["error", { 
-      "allowTypeImports": true
-    }],
-    "conarti-fsd/absolute-relative": "error",
-    "conarti-fsd/public-api": "error"
-  }
-}
-```
-
-## Rules
-
-🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
-💡 Suggestion fix (no automatic fix)
-
-| Name                                                               | Description                               | 🔧 |
-|:-------------------------------------------------------------------|:------------------------------------------|:---|
-| [conarti-fsd/layers-slices](rules/layers-slices/README.md)         | Checks layer imports                      |    |
-| [conarti-fsd/absolute-relative](rules/absolute-relative/README.md) | Checks for absolute and relative paths    |    |
-| [conarti-fsd/public-api](rules/public-api/README.md)               | Check for module imports from public api  | 💡 |
-| import/order                                                       | Sort imports using 'eslint-plugin-import' | 🔧 |
+# @conarti/eslint-plugin-feature-sliced
+
+Feature-sliced design methodology plugin.
+
+_Attention: the plugin is being actively developed and is in **beta**.
+The names of rules and configurations may change in new versions.
+If you find a bug, please open an issue or pull request.
+Feel free to contribute_
+
+## Features
+
+- Works with any framework
+
+- Support for **any aliases** out of the box
+
+```javascript
+import { AppButton } from "~/shared/ui/app-button";
+import { AppButton } from "@/shared/ui/app-button";
+import { AppButton } from "@shared/ui/app-button";
+import { AppButton } from "$shared/ui/app-button";
+import { AppButton } from "$@#$%%shared/ui/app-button";
+```
+
+- Checks for absolute and relative paths
+
+```javascript
+// file: src/widgets/TheHeader/ui/TheHeader.stories.tsx
+
+import { TheHeader } from './TheHeader'; // valid
+import { TheHeader } from 'src/widgets/TheHeader'; // error: should relative
+import { TheHeader } from 'widgets/TheHeader'; // error: should relative
+import { useBar } from '../../../shared/hooks'; // error: should absolute
+```
+
+- Checks for imports from public api and fix them
+
+```javascript
+// file: src/features/search-articles/...
+
+import { addCommentFormActions, addCommentFormReducer } from 'entities/Article/model/file.ts'; // error
+// fix: import { addCommentFormActions, addCommentFormReducer } from 'entities/Article';
+```
+
+- Sort imports
+
+```javascript
+import axios from "axios";                           // 1) external libs
+import { Header } from "widgets/header";             // 2.1) Layers: widgets
+import { Zero } from "widgets/zero";                 // 2.1) Layers: widget 
+import { LoginForm } from "features/login-form";     // 2.2) Layers: features
+import { globalEntities } from "entities";           // 2.4) Layers: entities
+import { authModel } from "entities/auth";           // 2.4) Layers: entities
+import { Cart } from "entities/cart";                // 2.4) Layers: entities 
+import { One } from "entities/one";                  // 2.4) Layers: entities 
+import { Two } from "entities/two";                  // 2.4) Layers: entities
+import { debounce } from "shared/lib/fp";            // 2.5) Layers: shared
+import { Button } from "shared/ui";                  // 2.5) Layers: shared
+import { Input } from "shared/ui";                   // 2.5) Layers: shared
+import { data } from "../fixtures";                  // 3) parent
+import { getSmth } from "./lib";                     // 4) sibling
+```
+
+## Installation
+
+You'll first need to install [ESLint](https://eslint.org/):
+
+```sh
+npm i eslint --save-dev
+```
+
+Next, install `@conarti/eslint-plugin-feature-sliced` and dependencies:
+
+```sh
+npm install -D @conarti/eslint-plugin-feature-sliced eslint-plugin-import
+# or by yarn
+yarn add -D @conarti/eslint-plugin-feature-sliced eslint-plugin-import
+```
+
+Note: 'eslint-plugin-import' is optional. You can skip installing this plugin if you don't need to sort imports in your code.
+
+## Quick Usage
+
+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`. 
+
+```json
+{
+  "extends": [
+    "plugin:@conarti/feature-sliced/recommended"
+  ]
+}
+```
+
+## 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"
+  }
+}
+```
+
+## Rules
+
+🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
+💡 Suggestion fix (no automatic fix)
+
+| Name                                                                                | Description                               | 🔧 |
+|:------------------------------------------------------------------------------------|:------------------------------------------|:---|
+| [@conarti/feature-sliced/layers-slices](docs/rules/layers-slices/README.md)         | Checks layer imports                      |    |
+| [@conarti/feature-sliced/absolute-relative](docs/rules/absolute-relative/README.md) | Checks for absolute and relative paths    |    |
+| [@conarti/feature-sliced/public-api](docs/rules/public-api/README.md)               | Check for module imports from public api  | 💡 |
+| import/order                                                                        | Sort imports using 'eslint-plugin-import' | 🔧 |

package/dist/config.js

@@ -1,27 +1,27 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RULE_DOCS_URL = exports.pathSeparator = exports.segments = exports.layersWithSlices = exports.layersWithoutSlices = exports.layers = void 0;
-exports.layers = [
-    'shared',
-    'entities',
-    'features',
-    'widgets',
-    'pages',
-    'processes',
-    'app',
-];
-exports.layersWithoutSlices = [
-    'shared',
-    'app',
-];
-exports.layersWithSlices = exports.layers.filter((layer) => !exports.layersWithoutSlices.includes(layer));
-exports.segments = [
-    'ui',
-    'model',
-    'lib',
-    'api',
-    'config',
-    'assets',
-];
-exports.pathSeparator = '/';
-exports.RULE_DOCS_URL = 'https://example.com/rule/';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RULE_DOCS_URL = exports.pathSeparator = exports.segments = exports.layersWithSlices = exports.layersWithoutSlices = exports.layers = void 0;
+exports.layers = [
+    'shared',
+    'entities',
+    'features',
+    'widgets',
+    'pages',
+    'processes',
+    'app',
+];
+exports.layersWithoutSlices = [
+    'shared',
+    'app',
+];
+exports.layersWithSlices = exports.layers.filter((layer) => !exports.layersWithoutSlices.includes(layer));
+exports.segments = [
+    'ui',
+    'model',
+    'lib',
+    'api',
+    'config',
+    'assets',
+];
+exports.pathSeparator = '/';
+exports.RULE_DOCS_URL = 'https://example.com/rule/';

package/dist/configs/import-order/index.js

@@ -1,20 +1,20 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const recommended_1 = __importDefault(require("./recommended"));
-const with_newlines_1 = __importDefault(require("./with-newlines"));
-const with_newlines_and_type_group_1 = __importDefault(require("./with-newlines-and-type-group"));
-const with_type_group_1 = __importDefault(require("./with-type-group"));
-module.exports = {
-    parserOptions: {
-        ecmaVersion: '2015',
-        sourceType: 'module',
-    },
-    configs: {
-        recommended: recommended_1.default,
-        'with-newlines': with_newlines_1.default,
-        'with-type-group': with_type_group_1.default,
-        'with-newlines-and-type-group': with_newlines_and_type_group_1.default,
-    },
-};
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const recommended_1 = __importDefault(require("./recommended"));
+const with_newlines_1 = __importDefault(require("./with-newlines"));
+const with_newlines_and_type_group_1 = __importDefault(require("./with-newlines-and-type-group"));
+const with_type_group_1 = __importDefault(require("./with-type-group"));
+module.exports = {
+    parserOptions: {
+        ecmaVersion: '2015',
+        sourceType: 'module',
+    },
+    configs: {
+        recommended: recommended_1.default,
+        'with-newlines': with_newlines_1.default,
+        'with-type-group': with_type_group_1.default,
+        'with-newlines-and-type-group': with_newlines_and_type_group_1.default,
+    },
+};

package/dist/configs/import-order/recommended.js

@@ -1,28 +1,28 @@
-"use strict";
-const config_1 = require("../../config");
-const LAYERS_REVERSED = [...config_1.layers].reverse();
-module.exports = {
-    plugins: [
-        'import',
-    ],
-    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'],
-            },
-        ],
-    },
-};
+"use strict";
+const config_1 = require("../../config");
+const LAYERS_REVERSED = [...config_1.layers].reverse();
+module.exports = {
+    plugins: [
+        'import',
+    ],
+    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'],
+            },
+        ],
+    },
+};

package/dist/configs/import-order/with-newlines-and-type-group.js

@@ -1,28 +1,28 @@
-"use strict";
-const config_1 = require("../../config");
-const LAYERS_REVERSED = [...config_1.layers].reverse();
-module.exports = {
-    plugins: [
-        'import',
-    ],
-    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'],
-            },
-        ],
-    },
-};
+"use strict";
+const config_1 = require("../../config");
+const LAYERS_REVERSED = [...config_1.layers].reverse();
+module.exports = {
+    plugins: [
+        'import',
+    ],
+    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'],
+            },
+        ],
+    },
+};

package/dist/configs/import-order/with-newlines.js

@@ -1,28 +1,28 @@
-"use strict";
-const config_1 = require("../../config");
-const LAYERS_REVERSED = [...config_1.layers].reverse();
-module.exports = {
-    plugins: [
-        'import',
-    ],
-    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'],
-            },
-        ],
-    },
-};
+"use strict";
+const config_1 = require("../../config");
+const LAYERS_REVERSED = [...config_1.layers].reverse();
+module.exports = {
+    plugins: [
+        'import',
+    ],
+    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'],
+            },
+        ],
+    },
+};