kopia lustrzana https://github.com/wagtail/wagtail
215 wiersze
7.5 KiB
JavaScript
215 wiersze
7.5 KiB
JavaScript
module.exports = {
|
||
extends: [
|
||
'@wagtail/eslint-config-wagtail',
|
||
'plugin:@typescript-eslint/recommended',
|
||
],
|
||
parser: '@typescript-eslint/parser',
|
||
plugins: ['@typescript-eslint'],
|
||
env: {
|
||
jest: true,
|
||
browser: true,
|
||
},
|
||
rules: {
|
||
'@typescript-eslint/explicit-function-return-type': 'off',
|
||
'@typescript-eslint/explicit-member-accessibility': 'off',
|
||
'@typescript-eslint/explicit-module-boundary-types': 'off',
|
||
'@typescript-eslint/no-explicit-any': 'off',
|
||
'@typescript-eslint/no-use-before-define': ['error'],
|
||
// it is often helpful to pull out logic to class methods that may not use `this`
|
||
'class-methods-use-this': 'off',
|
||
'import/extensions': [
|
||
'error',
|
||
'always',
|
||
{
|
||
ignorePackages: true,
|
||
pattern: {
|
||
js: 'never',
|
||
jsx: 'never',
|
||
ts: 'never',
|
||
tsx: 'never',
|
||
},
|
||
},
|
||
],
|
||
// does not align with the majority of legacy and newer code, some use named others use default exports
|
||
'import/prefer-default-export': 'off',
|
||
// allow no lines between single line members (e.g. static declarations)
|
||
'lines-between-class-members': [
|
||
'error',
|
||
'always',
|
||
{ exceptAfterSingleLine: true },
|
||
],
|
||
'max-classes-per-file': 'off',
|
||
// note you must disable the base rule as it can report incorrect errors
|
||
'no-use-before-define': 'off',
|
||
'react/jsx-filename-extension': ['error', { extensions: ['.js', '.tsx'] }],
|
||
'no-underscore-dangle': [
|
||
'error',
|
||
{ allow: ['__REDUX_DEVTOOLS_EXTENSION__'] },
|
||
],
|
||
// this rule can be confusing as it forces some non-intuitive code for variable assignment
|
||
'prefer-destructuring': 'off',
|
||
},
|
||
settings: {
|
||
'import/core-modules': ['jquery'],
|
||
'import/resolver': { node: { extensions: ['.js', '.ts', '.tsx'] } },
|
||
},
|
||
overrides: [
|
||
// Rules that we are ignoring currently due to legacy code in React components only
|
||
{
|
||
files: ['client/src/components/**'],
|
||
rules: {
|
||
'jsx-a11y/click-events-have-key-events': 'off',
|
||
'jsx-a11y/interactive-supports-focus': 'off',
|
||
'jsx-a11y/no-noninteractive-element-interactions': 'off',
|
||
'jsx-a11y/role-supports-aria-props': 'off',
|
||
'no-restricted-syntax': 'off',
|
||
'react-hooks/exhaustive-deps': 'off',
|
||
'react-hooks/rules-of-hooks': 'off',
|
||
'react/button-has-type': 'off',
|
||
'react/destructuring-assignment': 'off',
|
||
'react/forbid-prop-types': 'off',
|
||
'react/function-component-definition': 'off',
|
||
'react/jsx-props-no-spreading': 'off',
|
||
'react/no-danger': 'off',
|
||
'react/no-deprecated': 'off',
|
||
'react/require-default-props': 'off',
|
||
},
|
||
},
|
||
// Rules we want to enforce or change for Stimulus Controllers
|
||
{
|
||
files: ['*Controller.ts'],
|
||
rules: {
|
||
'@typescript-eslint/member-ordering': [
|
||
'error',
|
||
{
|
||
classes: {
|
||
memberTypes: ['signature', 'field', 'method'],
|
||
},
|
||
},
|
||
],
|
||
'@typescript-eslint/naming-convention': [
|
||
'error',
|
||
{
|
||
selector: 'method',
|
||
format: ['camelCase'],
|
||
custom: {
|
||
// Use connect or initialize instead of constructor, avoid generic 'render' or 'update' methods and instead be more specific.
|
||
regex: '^(constructor|render|update)$',
|
||
match: false,
|
||
},
|
||
},
|
||
{
|
||
selector: 'classProperty',
|
||
format: ['camelCase'],
|
||
custom: {
|
||
// Use Stimulus values where possible for internal state, avoid a generic state object as these are not reactive.
|
||
regex: '^(state)$',
|
||
match: false,
|
||
},
|
||
},
|
||
],
|
||
'no-restricted-properties': [
|
||
'error',
|
||
{
|
||
object: 'window',
|
||
property: 'Stimulus',
|
||
message:
|
||
"Please import the base Controller or only access the Stimulus instance via the controller's `this.application` attribute.",
|
||
},
|
||
],
|
||
},
|
||
},
|
||
// Rules we don’t want to enforce for test and tooling code.
|
||
{
|
||
files: [
|
||
'client/extract-translatable-strings.js',
|
||
'client/tests/**',
|
||
'webpack.config.js',
|
||
'tailwind.config.js',
|
||
'storybook/**/*',
|
||
'*.test.ts',
|
||
'*.test.tsx',
|
||
'*.test.js',
|
||
'*.stories.js',
|
||
'*.stories.tsx',
|
||
],
|
||
rules: {
|
||
'@typescript-eslint/no-empty-function': 'off',
|
||
'@typescript-eslint/no-this-alias': 'off',
|
||
'@typescript-eslint/no-unused-vars': 'off',
|
||
'@typescript-eslint/no-var-requires': 'off',
|
||
'global-require': 'off',
|
||
'import/first': 'off',
|
||
'import/no-extraneous-dependencies': 'off',
|
||
'jsx-a11y/control-has-associated-label': 'off',
|
||
'no-new': 'off',
|
||
'no-unused-expressions': 'off',
|
||
'react/function-component-definition': 'off',
|
||
'react/jsx-props-no-spreading': 'off',
|
||
},
|
||
},
|
||
// Files that use jquery via a global
|
||
{
|
||
files: [
|
||
'docs/_static/**',
|
||
'wagtail/contrib/modeladmin/static_src/wagtailmodeladmin/js/prepopulate.js',
|
||
'wagtail/contrib/search_promotions/static_src/wagtailsearchpromotions/js/query-chooser-modal.js',
|
||
'wagtail/contrib/search_promotions/templates/wagtailsearchpromotions/includes/searchpromotions_formset.js',
|
||
'wagtail/contrib/search_promotions/templates/wagtailsearchpromotions/queries/chooser_field.js',
|
||
'wagtail/documents/static_src/wagtaildocs/js/add-multiple.js',
|
||
'wagtail/embeds/static_src/wagtailembeds/js/embed-chooser-modal.js',
|
||
'wagtail/images/static_src/wagtailimages/js/add-multiple.js',
|
||
'wagtail/images/static_src/wagtailimages/js/focal-point-chooser.js',
|
||
'wagtail/images/static_src/wagtailimages/js/image-url-generator.js',
|
||
'wagtail/snippets/static_src/wagtailsnippets/js/snippet-multiple-select.js',
|
||
'wagtail/users/static_src/wagtailusers/js/group-form.js',
|
||
],
|
||
globals: { $: 'readonly', jQuery: 'readonly' },
|
||
},
|
||
// Files that use other globals or legacy/vendor code that is unable to be easily linted
|
||
{
|
||
files: ['wagtail/**/**'],
|
||
globals: {
|
||
buildExpandingFormset: 'readonly',
|
||
escapeHtml: 'readonly',
|
||
jsonData: 'readonly',
|
||
ModalWorkflow: 'readonly',
|
||
DOCUMENT_CHOOSER_MODAL_ONLOAD_HANDLERS: 'writable',
|
||
EMBED_CHOOSER_MODAL_ONLOAD_HANDLERS: 'writable',
|
||
IMAGE_CHOOSER_MODAL_ONLOAD_HANDLERS: 'writable',
|
||
QUERY_CHOOSER_MODAL_ONLOAD_HANDLERS: 'writable',
|
||
SNIPPET_CHOOSER_MODAL_ONLOAD_HANDLERS: 'writable',
|
||
},
|
||
rules: {
|
||
'@typescript-eslint/no-unused-vars': 'off',
|
||
'@typescript-eslint/no-use-before-define': 'off',
|
||
'camelcase': [
|
||
'error',
|
||
{
|
||
allow: [
|
||
'__unused_webpack_module',
|
||
'__webpack_modules__',
|
||
'__webpack_require__',
|
||
],
|
||
properties: 'never',
|
||
},
|
||
],
|
||
'consistent-return': 'off',
|
||
'func-names': 'off',
|
||
'id-length': 'off',
|
||
'indent': 'off',
|
||
'key-spacing': 'off',
|
||
'new-cap': 'off',
|
||
'newline-per-chained-call': 'off',
|
||
'no-param-reassign': 'off',
|
||
'no-underscore-dangle': 'off',
|
||
'object-shorthand': 'off',
|
||
'prefer-arrow-callback': 'off',
|
||
'quote-props': 'off',
|
||
'space-before-function-paren': 'off',
|
||
'vars-on-top': 'off',
|
||
},
|
||
},
|
||
],
|
||
};
|