mirror of
https://github.com/signalapp/libsignal.git
synced 2024-09-20 12:02:18 +02:00
e5450118a8
- Update eslint-plugin-jsdoc - Change jsdoc warnings to errors - Enable 'check-param-names' lint now that we can permit missing params
119 lines
3.4 KiB
JavaScript
119 lines
3.4 KiB
JavaScript
// For reference: https://github.com/airbnb/javascript
|
|
|
|
module.exports = {
|
|
root: true,
|
|
|
|
parserOptions: {
|
|
project: './tsconfig.json',
|
|
ecmaVersion: 2020,
|
|
sourceType: 'module',
|
|
},
|
|
|
|
settings: {
|
|
'import/core-modules': ['electron'],
|
|
},
|
|
|
|
plugins: ['header', 'import', 'jsdoc', 'mocha', 'more', '@typescript-eslint'],
|
|
|
|
extends: [
|
|
'eslint:recommended',
|
|
'plugin:@typescript-eslint/recommended',
|
|
'plugin:@typescript-eslint/recommended-requiring-type-checking',
|
|
'plugin:import/errors',
|
|
'plugin:import/warnings',
|
|
'plugin:import/typescript',
|
|
],
|
|
|
|
rules: {
|
|
'header/header': [
|
|
2,
|
|
'line',
|
|
[
|
|
'',
|
|
{ pattern: ' Copyright \\d{4}(-\\d{4})? Signal Messenger, LLC.' },
|
|
' SPDX-License-Identifier: AGPL-3.0-only',
|
|
'',
|
|
],
|
|
],
|
|
|
|
'comma-dangle': [
|
|
'error',
|
|
{
|
|
arrays: 'always-multiline',
|
|
objects: 'always-multiline',
|
|
imports: 'always-multiline',
|
|
exports: 'always-multiline',
|
|
functions: 'never',
|
|
},
|
|
],
|
|
|
|
// prevents us from accidentally checking in exclusive tests (`.only`):
|
|
'mocha/no-exclusive-tests': 'error',
|
|
|
|
// encourage consistent use of `async` / `await` instead of `then`
|
|
'more/no-then': 'error',
|
|
|
|
// it helps readability to put public API at top,
|
|
'no-use-before-define': 'off',
|
|
|
|
// useful for unused or internal fields
|
|
'no-underscore-dangle': 'off',
|
|
|
|
// useful for unused parameters
|
|
'@typescript-eslint/no-unused-vars': [
|
|
'error',
|
|
{ argsIgnorePattern: '^_', varsIgnorePattern: '^_' },
|
|
],
|
|
|
|
// Overrides recommended by typescript-eslint
|
|
// https://github.com/typescript-eslint/typescript-eslint/releases/tag/v4.0.0
|
|
'@typescript-eslint/no-redeclare': 'error',
|
|
'@typescript-eslint/no-shadow': ['error', { ignoreOnInitialization: true }],
|
|
'@typescript-eslint/no-useless-constructor': ['error'],
|
|
'no-shadow': 'off',
|
|
'no-useless-constructor': 'off',
|
|
|
|
// though we have a logger, we still remap console to log to disk
|
|
'no-console': 'error',
|
|
|
|
// consistently place operators at end of line except ternaries
|
|
'operator-linebreak': 'error',
|
|
|
|
quotes: [
|
|
'error',
|
|
'single',
|
|
{ avoidEscape: true, allowTemplateLiterals: false },
|
|
],
|
|
|
|
// We prefer named exports
|
|
'import/prefer-default-export': 'off',
|
|
|
|
'prefer-template': 'error',
|
|
|
|
'@typescript-eslint/no-require-imports': 'error',
|
|
'@typescript-eslint/consistent-type-assertions': 'error',
|
|
'@typescript-eslint/explicit-module-boundary-types': 'error',
|
|
|
|
// Errors are valid in templates, but this rule doesn't know that.
|
|
'@typescript-eslint/restrict-template-expressions': 'off',
|
|
|
|
// JSDoc checking, but no complaints for missing docs yet
|
|
'jsdoc/check-access': 'error',
|
|
'jsdoc/check-alignment': 'error',
|
|
'jsdoc/check-line-alignment': 'error',
|
|
'jsdoc/check-param-names': ['error', { disableMissingParamChecks: true }],
|
|
'jsdoc/check-property-names': 'error',
|
|
'jsdoc/check-syntax': 'error',
|
|
'jsdoc/check-tag-names': 'error',
|
|
'jsdoc/check-types': 'error',
|
|
'jsdoc/check-values': 'error',
|
|
'jsdoc/empty-tags': 'error',
|
|
'jsdoc/implements-on-classes': 'error',
|
|
'jsdoc/multiline-blocks': 'error',
|
|
'jsdoc/no-bad-blocks': 'error',
|
|
'jsdoc/no-blank-blocks': 'error',
|
|
'jsdoc/no-undefined-types': 'error',
|
|
'jsdoc/valid-types': 'error',
|
|
},
|
|
};
|