eslint-config-pjchender

0.5.0 • Public • Published

eslint-config-pjchender

Installation

# install the eslint-config-pjchender
npm install -D eslint-config-pjchender

# install the peerDependencies of eslint-config-pjchender
npx install-peerdeps --dev eslint-config-pjchender

Usage

TypeScript (React)

In default, eslint-plugin-pjchender will use rules for TypeScript files. For preventing the conflict between ESLint and tsconfig, there are two simple ways to solve. Check the FAQs section regarding "I get errors telling me "ESLint was configured to run ... However, that TSConfig does not / none of those TSConfigs include this file" for more details.

Linting with Type Information

Use ESLint's overrides configuration to configure the file to not be parsed with type information. For example,

// .eslintrc.cjs
module.exports = {
  // ... the rest of your config ...
  extends: ['pjchender'],
  parserOptions: {
    project: true, // for monorepo, ["./tsconfig.base.json", "./apps/*/tsconfig.json"]
    tsconfigRootDir: __dirname, // "."
  },
};

JavaScript (React)

Extends the config with the extends field in eslint config if you only need JavaScript and React related rules:

// .eslintrc
{
  // if you only need JavaScript and React related rules
  "extends": ["pjchender/react"]
}

TypeScript

For projects only use TypeScript without React, you can extend from pjchender/typescript. This only setup the config for TypeScript files without .jsx or .tsx.

For example, create a tsconfig.eslint.json file in your project:

// tsconfig.eslint.json
{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "types": ["jest"]
  },
  "include": ["src/**/*", "tests/**/*", ".eslintrc.js", "jest.config.js", "commitlint.config.js"],
  "exclude": ["node_modules", "build", "scripts"]
}

Then refer this file in the config of parseOptions.project in .eslintrc:

// .eslintrc
{
  "extends": ["pjchender/typescript"],
  "parserOptions": {
    "project": "tsconfig.eslint.json"
  }
}

If you have some config files in the project root which is not need to be linted, you can add them to the exclude field in tsconfig.eslint.json or in .eslintignore file.

Linter for React Testing

If you want to use the ESLint config of eslint-plugin-jest-dom and eslint-plugin-testing-library from the React Testing , you can extend from pjchender/react-testing.

For example,

// .eslintrc
{
  "overrides": [
    {
      "files": ["**/__tests__/**/*.[jt]s?(x)", "**/?(*.)+(spec|test).[jt]s?(x)"],
      "extends": ["pjchender/react-testing"]
    }
  ]
}

Development and Deployment

Write files in the tests folder and see whether ESLint works as expected:

npm run test
npm run test -- --fix

After push to the main branch, the release job will automatically start.

MISC

Absolute Imports and Module Path Aliases for TypeScript

If you want to use import alias in your project, you can use import-resolver-typescript to do this by yourself. For example,

// .eslintrc
{
  // ...
  "rules": {
    "import/no-unresolved": "error"
  },
  "settings": {
    "import/resolver": {
      "typescript": {
        "alwaysTryTypes": true,
        "project": "tsconfig.json"
      }
    }
  }
}

xxx should be listed in the project's dependencies, not devDependencies

By default, eslint-config-pjchender does not care about the packages is dependencies or devDependencies in '**/*.test.ts', '**/*.test.tsx', '**/*.stories.ts', '**/*.stories.tsx'. However, you might still use some package that should be listed in devDependencies. In this case, you can modify the rule of import/no-extraneous-dependencies in eslint config file manually. For example,

{
  "rules": {
    "import/no-extraneous-dependencies": [
      "error",
      {
        "devDependencies": [
          "**/*.test.ts",
          "**/*.test.tsx",
          "**/*.stories.ts",
          "**/*.stories.tsx",
          "vite.config.ts"
        ]
      }
    ]
  }
}

Personal Preference

{
  "rules": {
    "import/extensions": [
      "error",
      "ignorePackages",
      {
        "js": "never",
        "jsx": "never",
        "ts": "never",
        "tsx": "never"
      }
    ],
    "react-refresh/only-export-components": "warn",
    "react/jsx-props-no-spreading": "off",
  }
}

Inspired By

Package Sidebar

Install

npm i eslint-config-pjchender

Weekly Downloads

54

Version

0.5.0

License

MIT

Unpacked Size

29.7 kB

Total Files

24

Last publish

Collaborators

  • pjchender