eslint-plugin-fsd-turbo

eslint plugin for FSD architecture

Installation

You'll first need to install ESLint:

npm i -D eslint

or

yarn add -D eslint

or

pnpm i -D eslint

Next, install eslint-plugin-fsd-turbo:

npm i -D eslint-plugin-fsd-turbo

or

yarn add -D eslint-plugin-fsd-turbo

or

pnpm i -D eslint-plugin-fsd-turbo

Usage

In your configuration file, import the plugin eslint-plugin-fsd-turbo and add fsd-turbo to the plugins key:

import fsdTurboPlugin from "eslint-plugin-fsd-turbo";

export default [
  {
    plugins: {
      "fsd-turbo": fsdTurboPlugin,
    },
  },
];

Or if you are using the old ESLint config format

export default {
  plugins: ["fsd-turbo"],
};

Then configure the rules you want to use under the rules key.

import fsdTurboPlugin from "eslint-plugin-fsd-turbo";

export default [
  {
    plugins: {
      "fsd-turbo": fsdTurboPlugin,
    },
    rules: {
      "fsd-turbo/fsd-path-checker": [
        "error",
        {
          alias: "@",
        },
      ],
    },
  },
];

Rules

| Name | Description | | :--------------------------------------------------- | :----------------------------------- | | fsd-path-checker | feature sliced design import checker | | public-api-import | only allow imports from public api, | | | from index.ts |