github-desktop/.eslintrc.yml

223 lines
6.4 KiB
YAML
Raw Normal View History

root: true
2019-01-21 14:05:36 +00:00
parser: '@typescript-eslint/parser'
plugins:
2019-01-23 14:30:55 +00:00
- '@typescript-eslint'
- react
- json
- jsdoc
settings:
react:
version: '16.3'
extends:
- prettier
- prettier/react
- plugin:@typescript-eslint/recommended
- prettier/@typescript-eslint
- plugin:github/react
rules:
##########
# CUSTOM #
##########
insecure-random: error
2021-07-04 16:50:01 +00:00
react-no-unbound-dispatcher-props: error
react-readonly-props-and-state: error
react-proper-lifecycle-methods: error
no-loosely-typed-webcontents-ipc: error
###########
# PLUGINS #
###########
# TYPESCRIPT
'@typescript-eslint/naming-convention':
- error
- selector: interface
format:
- PascalCase
custom:
regex: '^I[A-Z]'
match: true
2020-07-02 11:25:13 +00:00
- selector: class
format:
- PascalCase
- selector: variableLike
format: null
custom:
# Based on https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Lexical_grammar we
# should probably be using the following expression here (newlines added for readability)
#
# ^(break|case|catch|class|const|continue|debugger|default|delete|do|else|export|
# extends|finally|for|function|if|import|in|instanceof|new|return|super|switch|this|
# throw|try|typeof|var|void|while|with|yield|enum|implements|interface|let|package|
# private|protected|public|static|await|abstract|boolean|byte|char|double|final|float|
# goto|int|long|native|short|synchronized|throws|transient|volatile|null|true|false)$
#
# But that'll cause a bunch of errors, for now we'll stick with replicating what the
# variable-name ban-keywords rule did for us in tslint
# see https://palantir.github.io/tslint/rules/variable-name/
regex: '^(any|Number|number|String|string|Boolean|boolean|Undefined|undefined)$'
match: false
'@typescript-eslint/consistent-type-assertions':
- error
- assertionStyle: 'as'
'@typescript-eslint/no-unused-expressions': error
2019-01-23 14:30:55 +00:00
'@typescript-eslint/explicit-member-accessibility': error
'@typescript-eslint/no-unused-vars':
- error
- args: 'none'
'@typescript-eslint/no-use-before-define':
- error
- functions: false
variables: false
typedefs: false
'@typescript-eslint/member-ordering':
- error
- default:
- static-field
- static-method
- field
- abstract-method
- constructor
- method
'@typescript-eslint/no-extraneous-class': error
2020-07-02 16:01:53 +00:00
'@typescript-eslint/no-empty-interface': error
# Would love to be able to turn this on eventually
'@typescript-eslint/no-non-null-assertion': off
# This rule does a lot of good but right now it catches way
# too many cases, we're gonna want to pay down this debt
# incrementally if we want to enable it.
'@typescript-eslint/ban-types': off
# It'd be nice to be able to turn this on eventually
'@typescript-eslint/no-var-requires': off
# Don't particularly care about these
'@typescript-eslint/triple-slash-reference': off
'@typescript-eslint/explicit-module-boundary-types': off
'@typescript-eslint/no-explicit-any': off
'@typescript-eslint/no-inferrable-types': off
'@typescript-eslint/no-empty-function': off
2022-02-01 14:02:06 +00:00
'@typescript-eslint/no-redeclare': error
2019-01-23 14:30:55 +00:00
# React
react/jsx-boolean-value:
- error
- always
react/jsx-key: error
react/jsx-no-bind: error
react/no-string-refs: error
2019-01-23 14:30:55 +00:00
react/jsx-uses-vars: error
react/jsx-uses-react: error
2020-07-02 13:15:37 +00:00
react/no-unused-state: error
2022-02-01 16:40:13 +00:00
react/no-unused-prop-types: error
2022-02-01 17:03:03 +00:00
react/prop-types:
- error
- ignore: ['children']
# JSDoc
jsdoc/check-alignment: error
jsdoc/check-tag-names: error
jsdoc/check-types: error
jsdoc/implements-on-classes: error
2023-05-31 12:29:19 +00:00
jsdoc/tag-lines:
- error
- any
- startLines: 1
jsdoc/no-undefined-types: error
jsdoc/valid-types: error
2020-07-02 12:01:46 +00:00
# Would love to enable these at some point but
# they cause way to many issues now.
#jsdoc/check-param-names: error
#jsdoc/require-jsdoc:
# - error
# - publicOnly: true
###########
# BUILTIN #
###########
curly: error
no-new-wrappers: error
2022-02-01 14:02:06 +00:00
# We'll use no-redeclare from @typescript/eslint-plugin instead as that
# supports overloads
no-redeclare: off
no-eval: error
no-sync: error
no-var: error
prefer-const: error
eqeqeq:
- error
- smart
2018-01-06 11:32:44 +00:00
strict:
- error
- global
no-buffer-constructor: error
no-restricted-imports:
- error
- paths:
- name: electron
importNames: ['ipcRenderer']
message:
"Please use 'import * as ipcRenderer' from 'ipc-renderer' instead to
get strongly typed IPC methods."
- name: electron/renderer
importNames: ['ipcRenderer']
message:
"Please use 'import * as ipcRenderer' from 'ipc-renderer' instead to
get strongly typed IPC methods."
- name: electron
importNames: ['ipcMain']
message:
"Please use 'import * as ipcMain' from 'ipc-main' instead to get
strongly typed IPC methods."
- name: electron/main
importNames: ['ipcMain']
message:
"Please use 'import * as ipcMain' from 'ipc-main' instead to get
strongly typed IPC methods."
###########
# SPECIAL #
###########
no-restricted-syntax:
- error
# no-default-export
- selector: ExportDefaultDeclaration
message: Use of default exports is forbidden
2023-07-07 19:01:44 +00:00
###########
# jsx-a11y #
###########
# autofocus is fine when it is being used to set focus to something in a way
# that doesn't skip any context or inputs. For example, in a named dialog, if you had
# a close button, a heading reflecting the name, and a labelled text input,
# focusing the text input wouldn't disadvantage a user because they're not
# missing anything of importance before it. The problem is when it is used on
# larger web pages, e.g. to focus a form field in the main content, entirely
# skipping the header and often much else besides.
jsx-a11y/no-autofocus:
- off
2018-01-06 11:32:44 +00:00
overrides:
- files: '*.d.ts'
rules:
strict:
- error
- never
- files: 'app/test/**/*'
rules:
'@typescript-eslint/no-non-null-assertion': off
- files: 'script/**/*'
rules:
'@typescript-eslint/no-non-null-assertion': off
2018-01-06 11:32:44 +00:00
parserOptions:
sourceType: module
ecmaFeatures:
jsx: true