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 授權許可證。

貢獻

當您要做出任何貢獻前，請您參考此處。

表示支持

如果這份備用單能夠幫助到您，請您支持並 ⭐️

貢獻者們

感謝這群無與倫比的人們：