Skip to content

Commit

Permalink
Added ESLinter
Browse files Browse the repository at this point in the history
  • Loading branch information
@miksrv
miksrv committed Sep 28, 2024
1 parent 68facb0 commit 9478cfe
Show file tree
Hide file tree
Showing 2 changed files with 370 additions and 0 deletions.
5 changes: 5 additions & 0 deletions eslint.config.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// @ts-check

/** @type {import('@typescript-eslint/utils/ts-eslint').FlatConfig.ConfigPromise} */
const config = (async () => (await import('./eslint.config.mjs')).default)()
module.exports = config
365 changes: 365 additions & 0 deletions eslint.config.mjs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,365 @@
import globals from 'globals'
import pluginJs from '@eslint/js'
import tseslint from 'typescript-eslint'
import importPlugin from 'eslint-plugin-import'
// import nextPlugin from '@next/eslint-plugin-next'
// import nextCoreWebVitals from '@next/core-web-vitals';
import jestPlugin from 'eslint-plugin-jest'
import { fixupConfigRules } from '@eslint/compat'
import eslintCommentsPlugin from 'eslint-plugin-eslint-comments'
import pluginReactConfig from 'eslint-plugin-react/configs/recommended.js'
import simpleImportSortPlugin from 'eslint-plugin-simple-import-sort'

export default [
// register all the plugins up-front
{
// note - intentionally uses computed syntax to make it easy to sort the keys
plugins: {
['@typescript-eslint']: tseslint.plugin,
['eslint-comments']: eslintCommentsPlugin,
['import']: importPlugin,
['jest']: jestPlugin,
// ['next']: nextPlugin,
// ['jsx-a11y']: jsxA11yPlugin,
// ['react-hooks']: reactHooksPlugin,
// ['react']: reactPlugin,
['simple-import-sort']: simpleImportSortPlugin
// ['unicorn']: unicornPlugin,
}
},

{
// config with just ignores is the replacement for `.eslintignore`
ignores: [
'**/.yarn/**',
'**/eslint.config.mjs',
'**/eslint.config.js',
'**/jest.config.ts',
'**/node_modules/**',
'**/dist/**',
'**/fixtures/**',
'**/coverage/**',
'**/__snapshots__/**',
'**/.docusaurus/**',
'**/build/**',
// WebPack
'**/webpack.config.js',
// PM2 Server
// '**/ecosystem.config.js',
// NextJS
// '**/next-i18next.config.js',
// '**/next.config.js',
// '**/.next/**',
// '**/next-env.d.ts',
// '**/middleware.ts'
]
},

// extends ...
pluginJs.configs.recommended,
...tseslint.configs.recommended,
...fixupConfigRules(pluginReactConfig),
// ...tseslint.configs.strictTypeChecked,
// ...tseslint.configs.stylisticTypeChecked,

// base config
{
languageOptions: {
globals: {
...globals.es2022,
...globals.node
},
parserOptions: {
allowAutomaticSingleRunInference: true,
cacheLifetime: {
// we pretty well never create/change tsconfig structure - so no need to ever evict the cache
// in the rare case that we do - just need to manually restart their IDE.
glob: 'Infinity'
},
project: ['tsconfig.json'],
warnOnUnsupportedTypeScriptVersion: false
}
},

settings: {
react: {
version: 'detect',
}
},

rules: {
//
// eslint-base
//
curly: ['error', 'all'],
semi: ['error', 'never'],
eqeqeq: [
'error',
'always',
{
null: 'never'
}
],
'no-duplicate-imports': 'warn',
'logical-assignment-operators': 'error',
'no-else-return': 'error',
// 'no-mixed-operators': 'warn',
'no-console': [
'error',
{
allow: ['warn', 'error']
}
],
'no-process-exit': 'error',
'no-fallthrough': [
'error',
{ commentPattern: '.*intentional fallthrough.*' }
],
'comma-dangle': ['warn', 'never'],
quotes: ['warn', 'single'],
'jsx-quotes': ['warn', 'prefer-single'],
'max-len': [
'warn',
{
code: 120,
ignoreTemplateLiterals: true,
ignoreStrings: true,
ignoreComments: true
}
],
'one-var': ['error', 'never'],

//
// typescript-eslint
//
// '@typescript-eslint/consistent-type-imports': [
// 'error',
// { prefer: 'type-imports', disallowTypeAnnotations: true },
// ],
// '@typescript-eslint/explicit-function-return-type': [
// 'error',
// { allowIIFEs: true },
// ],
// TODO
'@typescript-eslint/no-explicit-any': 'off',
'no-constant-condition': 'off',
'@typescript-eslint/no-unnecessary-condition': 'off',
// '@typescript-eslint/no-unnecessary-condition': [
// 'error',
// { allowConstantLoopConditions: true },
// ],
'@typescript-eslint/no-var-requires': 'off',
'@typescript-eslint/prefer-literal-enum-member': [
'error',
{
allowBitwiseExpressions: true
}
],
'@typescript-eslint/prefer-string-starts-ends-with': [
'error',
{
allowSingleElementEquality: 'always'
}
],
'@typescript-eslint/unbound-method': 'off',
// '@typescript-eslint/restrict-template-expressions': [
// 'error',
// {
// allowNumber: true,
// allowBoolean: true,
// allowAny: true,
// allowNullish: true,
// allowRegExp: true,
// },
// ],
'@typescript-eslint/no-unused-vars': [
'error',
{
caughtErrors: 'all',
varsIgnorePattern: '^_',
argsIgnorePattern: '^_'
}
],
// '@typescript-eslint/prefer-nullish-coalescing': [
// 'error',
// {
// ignoreConditionalTests: true,
// ignorePrimitives: true,
// },
// ],

//
// eslint-plugin-eslint-comment
//
// require a eslint-enable comment for every eslint-disable comment
'eslint-comments/disable-enable-pair': [
'error',
{
allowWholeFile: true
}
],
// disallow a eslint-enable comment for multiple eslint-disable comments
'eslint-comments/no-aggregating-enable': 'error',
// disallow duplicate eslint-disable comments
'eslint-comments/no-duplicate-disable': 'error',
// disallow eslint-disable comments without rule names
'eslint-comments/no-unlimited-disable': 'error',
// disallow unused eslint-disable comments
'eslint-comments/no-unused-disable': 'error',
// disallow unused eslint-enable comments
'eslint-comments/no-unused-enable': 'error',
// disallow ESLint directive-comments
'eslint-comments/no-use': [
'error',
{
allow: [
'eslint-disable',
'eslint-disable-line',
'eslint-disable-next-line',
'eslint-enable',
'global'
]
}
],

//
// react
//
'react/prop-types': 'off',
'react/jsx-max-props-per-line': [1, { 'when': 'always' }],

//
// next
//
// 'next/google-font-display': 'warn',
// 'next/google-font-preconnect': 'warn',
// 'next/next-script-for-ga': 'warn',
// 'next/no-async-client-component': 'warn',
// 'next/no-before-interactive-script-outside-document': 'warn',
// 'next/no-css-tags': 'warn',
// 'next/no-head-element': 'warn',
// 'next/no-html-link-for-pages': 'warn',
// 'next/no-img-element': 'warn',
// 'next/no-styled-jsx-in-document': 'warn',
// 'next/no-sync-scripts': 'warn',
// 'next/no-title-in-document-head': 'warn',
// 'next/no-typos': 'warn',
// 'next/no-unwanted-polyfillio': 'warn',
// 'next/inline-script-id': 'error',
// 'next/no-assign-module-variable': 'error',
// 'next/no-document-import-in-page': 'error',
// 'next/no-head-import-in-document': 'error',
// 'next/no-script-component-in-head': 'error',

//
// eslint-plugin-import
//
// enforces consistent type specifier style for named imports
'import/consistent-type-specifier-style': 'error',
// disallow non-import statements appearing before import statements
'import/first': 'error',
// Forbid import of modules using absolute paths
'import/no-absolute-path': 'error',
// forbid default exports - we want to standardize on named exports so that imported names are consistent
'import/no-default-export': 'error',
// disallow imports from duplicate paths
'import/no-duplicates': 'error',
// Forbid the use of extraneous packages
// 'import/no-extraneous-dependencies': [
// 'error',
// {
// devDependencies: true,
// peerDependencies: true,
// optionalDependencies: false,
// },
// ],
// Prevent importing the default as if it were named
'import/no-named-default': 'error',
// Prohibit named exports
'import/no-named-export': 'off', // we want everything to be a named export
// Forbid a module from importing itself
'import/no-self-import': 'error',
// Require modules with a single export to use a default export
'import/prefer-default-export': 'off', // we want everything to be named
}
},

{
files: ['**/*.{ts,tsx}'],
rules: {
'simple-import-sort/imports': [
'error',
{
groups: [
// Packages `react` related packages come first.
['^react', '^\\w', '^@hookform', '^@radix-ui'],
// npm packages
// Anything that starts with a letter (or digit or underscore), or `@` followed by a letter.
['^\\w'],
// Internal packages.
['^@store(/.*|$)'],
['^@api(/.*|$)'],
['^@components(/.*|$)'],
['^@ui(/.*|$)'],
['^@lib(/.*|$)'],
['^@pages(/.*|$)'],
['^@utils(/.*|$)'],
['^@hooks(/.*|$)'],
['^@services(/.*|$)'],
// Side effect imports.
['^\\u0000'],
// Parent imports. Put `..` last.
['^\\.\\.(?!/?$)', '^\\.\\./?$'],
// Other relative imports. Put same-folder imports and `.` last.
['^\\./(?=.*/)(?!/?$)', '^\\.(?!/?$)', '^\\./?$'],
// Style imports.
['^.+\\.?(css,sass)$'],
// SASS modules
],
},
],
},
},

//
// test file linting
// define the jest globals for all test files
//
{
files: ['**/*.{ts,tsx,cts,mts}'],
languageOptions: {
globals: {
...jestPlugin.environments.globals.globals
}
}
},
// test file specific configuration
{
files: ['**/*.spec.{ts,tsx,cts,mts}', '*.test.{ts,tsx,cts,mts}'],
rules: {
'@typescript-eslint/no-empty-function': [
'error',
{ allow: ['arrowFunctions'] }
],
'@typescript-eslint/no-non-null-assertion': 'off',
'@typescript-eslint/no-unsafe-assignment': 'off',
'@typescript-eslint/no-unsafe-call': 'off',
'@typescript-eslint/no-unsafe-member-access': 'off',
'@typescript-eslint/no-unsafe-return': 'off',
'jest/no-disabled-tests': 'error',
'jest/no-focused-tests': 'error',
'jest/no-alias-methods': 'error',
'jest/no-identical-title': 'error',
'jest/no-jasmine-globals': 'error',
'jest/no-test-prefixes': 'error',
'jest/no-done-callback': 'error',
'jest/no-test-return-statement': 'error',
'jest/prefer-to-be': 'error',
'jest/prefer-to-contain': 'error',
'jest/prefer-to-have-length': 'error',
'jest/prefer-spy-on': 'error',
'jest/valid-expect': 'error',
'jest/no-deprecated-functions': 'error'
}
}
]

0 comments on commit 9478cfe

Please sign in to comment.