sergeysova

martis

illright

@feature-sliced/eslint-config

  "name": "@feature-sliced/eslint-config",

  "description": "🍰 Lint feature-sliced concepts by existing eslint plugins",

  "repository": "https://github.com/feature-sliced/eslint-config.git",

  "author": "FeatureSliced core-team<feature.sliced@gmail.com>",

    "publish:prepatch": "npm version prepatch && npm publish",

    "publish:patch": "npm version patch && npm publish",

    "publish:minor": "npm version minor && npm publish",

    "publish:major": "npm version major && npm publish",

    "test": "mocha \"*(test|rules)/**/*.test.js\""

    "@typescript-eslint/parser": "^5.6.0",

    "eslint-import-resolver-node": "^0.3.6",

    "eslint-plugin-boundaries": "^2.6.0",

# [@feature-sliced/eslint-config](https://www.npmjs.com/package/@feature-sliced/eslint-config)

> `WIP:` At the moment at alpha testing - [use carefully](https://github.com/feature-sliced/eslint-config/discussions/55)

[npm]: https://www.npmjs.com/package/@feature-sliced/eslint-config

[![npm](https://img.shields.io/npm/v/@feature-sliced/eslint-config?style=flat-square)][npm]

[![npm](https://img.shields.io/npm/dw/@feature-sliced/eslint-config?style=flat-square)][npm]

[![npm bundle size](https://img.shields.io/bundlephobia/min/@feature-sliced/eslint-config?style=flat-square)][npm]

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/feature-sliced/eslint-config/Test%20current%20build?label=tests&style=flat-square)](https://github.com/feature-sliced/eslint-config/actions)

Linting of [FeatureSliced](https://github.com/feature-sliced/documentation) concepts *by existing eslint-plugins*

- Control [**Isolation**](https://feature-sliced.design/docs/concepts/low-coupling)

- Control [**Decomposition**](https://feature-sliced.design/docs/concepts/app-splitting)

- Control [**Public API**](https://feature-sliced.design/docs/concepts/public-api)

- Control [**Layers & Scopes**](https://feature-sliced.design/docs/reference/layers)

- Control [**Naming**](https://feature-sliced.design/docs/concepts/naming-adaptability)

- [`layers-slices`](./rules/layers-slices)

1. You'll first need to install [ESLint](http://eslint.org):

2. Next, install `@feature-sliced/eslint-config` and dependencies:

    $ npm install -D @feature-sliced/eslint-config eslint-plugin-import eslint-plugin-boundaries

    $ yarn add -D @feature-sliced/eslint-config eslint-plugin-import eslint-plugin-boundaries

3. Add config to the `extends` section of your `.eslintrc` configuration file (for **recommended** rules). You can omit the `eslint-config` postfix:

   > **WARN:** Don't use main config (`"@feature-sliced"`) in customization to avoid rules conflicts.

       "@feature-sliced/eslint-config/rules/import-order",

       "@feature-sliced/eslint-config/rules/public-api",

       "@feature-sliced/eslint-config/rules/layers-slices"

2. You can use [advanced FeatureSliced-specific messages processing](https://www.npmjs.com/package/@feature-sliced/eslint-plugin-messages)

   - 'Reaching to "features/search/ui" is not allowed.'

   + 'Violated usage of modules Public API | https://git.io/Jymjf'

3. You can use *warnings* instead of *errors* for specific rules

   "import/no-internal-modules": "warn" // ~ 1,

   "boundaries/element-types": "warn" // ~ 1,

This plugin can be used also in TypeScript projects using `@typescript-eslint/eslint-plugin`. Follow next steps to configure it:

   $ npm i -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-import-resolver-typescript

   $ yarn add -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-import-resolver-typescript

2. Configure `@typescript-eslint/parser` as parser and setup the `eslint-import-resolver-typescript` resolver in the `.eslintrc` config file:

     "parser": "@typescript-eslint/parser",

- [Releases & Changelog](https://github.com/feature-sliced/eslint-config/releases)

- [**How can I help?**](./CONTRIBUTING.md)

  - 💫 Any assistance is important - from feedback to participation in the development of the methodology!

		{
		"name": "@feature-sliced/eslint-config",
		"version": "0.1.0-alpha.3",
		"version": "0.1.0-alpha.4",
		"description": "🍰 Lint feature-sliced concepts by existing eslint plugins",
		@@ -5,0 +5,0 @@ "main": "index.js",

		@@ -88,2 +88,13 @@ # [@feature-sliced/eslint-config](https://www.npmjs.com/package/@feature-sliced/eslint-config)

		3. You can use warnings instead of errors for specific rules

		```json
		// feature-sliced/import-order
		"import/order": "warn" // ~ 1,
		// feature-sliced/public-api
		"import/no-internal-modules": "warn" // ~ 1,
		// feature-sliced/layers-slices
		"boundaries/element-types": "warn" // ~ 1,
		```

		## TypeScript
		@@ -90,0 +101,0 @@

Improved metrics