wagtail/.eslintrc.js

195 wiersze
6.8 KiB
JavaScript
Czysty Wina Historia

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

// Rules which have been enforced in configuration upgrades and flag issues in existing code.
// We need to consider whether to disable those rules permanently, or fix the issues.
const legacyCode = {
'class-methods-use-this': 'off',
'constructor-super': 'off',
'default-param-last': 'off',
'max-classes-per-file': 'off',
'no-await-in-loop': 'off',
'no-continue': 'off',
'no-else-return': 'off',
'no-plusplus': 'off',
'no-prototype-builtins': 'off',
'no-restricted-syntax': 'off',
'no-this-before-super': 'off',
'prefer-destructuring': 'off',
'prefer-promise-reject-errors': 'off',
};
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'],
'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 },
],
// 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__'] },
],
},
settings: {
'import/core-modules': ['jquery'],
'import/resolver': { node: { extensions: ['.js', '.ts', '.tsx'] } },
},
overrides: [
// Legacy Code - remove from `files` when adopting desired rules in new code progressively
{
files: [
'client/src/entrypoints/**',
'client/src/utils/**',
'**/documents/static_src/wagtaildocs/js/add-multiple.js',
'**/images/static_src/wagtailimages/js/add-multiple.js',
'**/images/static_src/wagtailimages/js/focal-point-chooser.js',
'**/snippets/static_src/wagtailsnippets/js/snippet-multiple-select.js',
],
rules: legacyCode,
},
// Rules that we are ignoring currently due to legacy code in React components only
{
files: ['client/src/components/**'],
rules: {
...legacyCode,
'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',
'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 dont 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-unused-vars': 'off',
'@typescript-eslint/no-var-requires': 'off',
'global-require': 'off',
'import/first': 'off',
'import/no-extraneous-dependencies': '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/settings/static_src/wagtailsettings/js/site-switcher.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/search/static_src/wagtailsearch/js/query-chooser-modal.js',
'wagtail/search/templates/wagtailsearch/queries/chooser_field.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: {
addMessage: 'readonly',
buildExpandingFormset: 'readonly',
cancelSpinner: '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',
},
},
],
};