@yomarsanchez/eslint-config-seek v1.2.3

Seek's ESLint + Prettier configuration

Opinionated linting configuration considering modern TypeScript best practices and providing consistency to your import statements. Valid for your JavaScript or TypeScript projects

How to use

1. Install the dependency

   npm install --save-dev @yomarsanchez/eslint-config-seek

2. Add it to your .eslintrc.js file:

   {
     extends: [ "@yomarsanchez/eslint-config-seek" ]
   }

3. If you are using TypeScript, extend the TypeScript configuration instead, and point to your tsconfig.json in parserOptions:

   {
     extends: [ "@yomarsanchez/eslint-config-seek/typescript" ],
     overrides: [
       {
         files: ["*.ts", "*.tsx"],
         parserOptions: {
           project: ["./tsconfig.json"],
         },
       },
     ]
   }

ℹ️ Please note that some of the rules enabled by default require that you have strict: true in your tsconfig.json.

What it does

• Lints JavaScript using eslint:recommended and Prettier
• Additionally, lints TypeScript using @typescript-eslint/recommended and @typescript-eslint/recommended-requiring-type-checking
• Uses the following plugins:
  • import: helps validate proper imports
  • simple-import-sort: sorts imports
  • unused-imports: finds and removes unused ES6 module imports
• Uses the following JavaScript rules and TypeScript rules

Seek Code Quality Standards

Publishing this package we are committing ourselves to the following code quality standards:

• Respect Semantic Versioning: No breaking changes in patch or minor versions
• No surprises in transitive dependencies: Use the bare minimum dependencies needed to meet the purpose
• One specific purpose to meet without having to carry a bunch of unnecessary other utilities
• Tests as documentation and usage examples
• Well documented ReadMe showing how to install and use
• License favoring Open Source and collaboration