npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

eslint-plugin-fsd-checker-imports

v0.0.16

Published

Plugin for checking the compliance of imports using the FSD methodology

Downloads

9

Readme

eslint-plugin-fsd-checker-imports

Плагин для проверки импорта файлов согласно FSD(Feature Sliced Design) методологии. Плагин подсвечивает ошибку если файл импортирован не верно и помогает исправить путь(относительный/абсолютный).

Github

Ссылка на проект

Установка

Сначала необходимо установить сам ESLint:

npm i eslint --save-dev

Затем устанавливаем eslint-plugin-fsd-checker-imports:

npm install --save-dev eslint-plugin-fsd-checker-imports 

Использование

Добавляем плагин eslint-plugin-fsd-checker-imports в секцию плагинов вашего конфигурационного файла .eslintrc . Префикс eslint-plugin- в названии плагина исключаем :

module.exports = {
    // other info ...
    "plugins": [ 
      // "other-plugins",
      "fsd-checker-imports"
    ],
  // other info ...
}

Использование в секции rules

path-checker - используется для проверки правильности пути(относительный/абсолютный). Относительными пути могут быть только внутри модуля, между слоями(shared, feature) пути должны быть абсолютными. Для shared слоя пути по умолчанию абсолютные. Если используется алиас, необходимо его указать.

module.exports = {
    //...
    "rules": {
      "fsd-checker-imports/path-checker": [
        "error", { alias: "@" }
      ]
    },
    //...
}

layer-imports - проверка импорта слоев согласно методологии. Например, shared можно импортировать в любой слой, а во features можно имортировать только 'shared' и 'entities'. Данное правильно это проверяет. Если используется алиас, необходимо его указать. ignoreImportPatterns - указывает какие паттерны файлов игнорировать.

module.exports = {
    "rules": {
      //...
      "fsd-checker-imports/layer-imports": [
        "error",
        {
          alias: "@",
          ignoreImportPatterns: ["**/StoryProvider", "**/testing"],
        },
      ],
      //...
    }
}

public-api-imports проверяет правильность импорта публичного api. Правило проверяет что бы код экспортировался только из публичного api. Если используется алиас, необходимо его указать. testFilesPatterns - указывает какие паттерны файлов игнорировать.

module.exports = {
    "rules": {
      //..
      "fsd-checker-imports/public-api-imports": [
        "error",
        {
          alias: "@",
          testFilesPatterns: [
            "**/*.test.*",
            "**/*.story.*",
            "**/StoryDecorator.tsx",
          ],
        },
      ],
      //...
    }
}