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-config-pjchender

v0.5.0

Published

ESLint and Prettier Config from pjchender

Downloads

13

Readme

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