README.md

README.md: EN | 日本語 | 繁體中文 | हिंदी

eslint-plugin-nimbus-clean

コードをクリーンにする包括的なリンティングソリューション。コードベースを簡単に、正確に飛び回ろう！

目次

• インストール
• 利用方法
  • フルコンフィグ
  • 段階的な改善
  • Prettier 設定 (オプション)
• ライセンス
• コントリビューション
• あなたのサポートをお願いします
• コントリビュータ

インストール

インストールは以下の方法で行うことができます: npm、 yarn、 pnpm。

最初に ESLint と TypeScript をインストールする必要があります:

npm i eslint --save-dev
npm i typescript

# yarn を用いる場合
yarn add eslint --dev
yarn add typescript

# pnpm を用いる場合
pnpm add eslint --save-dev
pnpm add typescript

次に eslint-plugin-nimbus-clean をインストールします:

npm install eslint-plugin-nimbus-clean --save-dev

# yarn を用いる場合
yarn add eslint-plugin-nimbus-clean --dev

# pnpm を用いる場合
pnpm add eslint-plugin-nimbus-clean --save-dev

次に、本プラグインの peerDependencies をすべてインストールします:

npx install-peerdeps eslint-plugin-nimbus-clean

# yarn を用いる場合
npx install-peerdeps eslint-plugin-nimbus-clean --yarn

# pnpm を用いる場合
npx install-peerdeps eslint-plugin-nimbus-clean --pnpm

利用方法

フルコンフィグ

新しいプロジェクトや、既存プロジェクトの ESLint のエラーや警告をすべて表示したい場合にお勧めします。

nimbus-cleanを.eslintrc設定ファイルの extends、または plugins に追加します。eslint-plugin-プレフィックスは省略可能です:

{
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "ecmaVersion": 13,
    "sourceType": "module",
    "ecmaFeatures": {
      "jsx": true,
      "modules": true,
      "experimentalObjectRestSpread": true
    }
  },
  "ignorePatterns": [
    "**/*",
    "node_modules"
  ],
  "settings": {
    "react": {
      "pragma": "React",
      "fragment": "Fragment",
      "version": "detect"
    },
    "import/resolver": {
      "typescript": {
        "alwaysTryTypes": true
      }
    }
  },
  "extends": [
    "plugin:nimbus-clean/recommended"
  ],
  "plugins": [
    "nimbus-clean"
  ]
}

段階的な改善

既存のプロジェクトが大きかったり、古かったりする場合には、nimbus-clean 設定を段階的に適用することができます:

• plugin:nimbus-clean/common
• plugin:nimbus-clean/prettier
• plugin:nimbus-clean/import
• plugin:nimbus-clean/simpleImportSort
• plugin:nimbus-clean/react
• plugin:nimbus-clean/promise
• plugin:nimbus-clean/unicorn
• plugin:nimbus-clean/sonarjs
• plugin:nimbus-clean/typescript
• plugin:nimbus-clean/perfectionist

{
  ...
  "extends": [
    "plugin:nimbus-clean/common",
    "plugin:nimbus-clean/prettier",
    ...
  ],
  "plugins": [
    "nimbus-clean"
  ]
}

Prettier 設定 (オプション)

もし.prettierrcの設定がない場合には、追加してください（以下は例です）。

{
   "singleQuote": true,
   "printWidth": 150,
   "useTabs": false,
   "tabWidth": 2,
   "trailingComma": "all",
   "semi": false
 }

ライセンス

このコードのライセンスは MIT License です。

コントリビューション

コントリビューションをする前には、いかなる場合でもこちらを参照してください。

あなたのサポートをお願いします

このリポジトリが役立ったのなら、⭐️をつけてください。

コントリビュータ

これらの素晴らしい人々に感謝します: