First rule types

Author: Shinigami92

.eslintrc.js

@@ -0,0 +1,109 @@
+// @ts-check
+const { defineConfig } = require('eslint-define-config');
+
+module.exports = defineConfig({
+  env: {
+    es6: true,
+    node: true
+  },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+    'plugin:jsdoc/recommended',
+    'plugin:prettier/recommended'
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: ['./tsconfig.lint.json'],
+    warnOnUnsupportedTypeScriptVersion: false
+  },
+  plugins: ['@typescript-eslint', 'prettier', 'jsdoc', 'spellcheck', 'inclusive-language'],
+  rules: {
+    curly: ['error'],
+    'linebreak-style': ['error', 'unix'],
+    'no-case-declarations': 'warn',
+    quotes: ['error', 'single', { avoidEscape: true }],
+    semi: ['error', 'always'],
+
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/explicit-function-return-type': ['error', { allowExpressions: true }],
+    '@typescript-eslint/indent': ['error', 2, { SwitchCase: 1, ignoredNodes: ['MemberExpression'] }],
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/member-ordering': 'warn',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-inferrable-types': 'off',
+    '@typescript-eslint/no-parameter-properties': 'off',
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-unused-vars': 'off',
+    '@typescript-eslint/prefer-nullish-coalescing': 'warn',
+    '@typescript-eslint/prefer-optional-chain': 'warn',
+    '@typescript-eslint/prefer-readonly': ['warn'],
+    '@typescript-eslint/restrict-template-expressions': 'off',
+    '@typescript-eslint/typedef': ['warn', { memberVariableDeclaration: true, variableDeclaration: true }],
+
+    'jsdoc/match-description': [
+      'warn',
+      {
+        mainDescription: '/^[A-Z`].+?(\\.|:)(\\n\\n.*((\\n{1,2}- .+)|(_.+_)|`.+`|\\n\\n---))?$/us',
+        matchDescription: '^[A-Z`].+(\\.|`.+`)$',
+        contexts: ['any'],
+        tags: {
+          param: true,
+          returns: true
+        }
+      }
+    ],
+    'jsdoc/no-types': 'error',
+    'jsdoc/require-jsdoc': [
+      'warn',
+      {
+        contexts: [
+          'ClassDeclaration',
+          "ClassProperty:not([accessibility='private'])",
+          'ExportNamedDeclaration:has(VariableDeclaration)',
+          'FunctionExpression',
+          "MethodDefinition:not([accessibility='private']) > FunctionExpression",
+          'TSEnumDeclaration',
+          'TSInterfaceDeclaration',
+          'TSMethodSignature',
+          // 'TSPropertySignature',
+          'TSTypeAliasDeclaration'
+        ]
+      }
+    ],
+    'jsdoc/require-param-type': 'off',
+    'jsdoc/require-returns-type': 'off',
+
+    'spellcheck/spell-checker': [
+      'warn',
+      {
+        minLength: 3,
+        skipWords: ['backtick', 'backticks', 'ecma']
+      }
+    ],
+
+    'inclusive-language/use-inclusive-words': [
+      'warn',
+      {
+        allowedTerms: [
+          {
+            term: '/master',
+            allowPartialMatches: true
+          }
+        ],
+        words: [
+          {
+            word: 'guys',
+            suggestions: ['folks']
+          }
+        ]
+      }
+    ]
+  },
+  settings: {
+    jsdoc: {
+      mode: 'typescript'
+    }
+  }
+});

.eslintrc.json

@@ -1,5 +1,5 @@
 {
-  "cSpell.words": ["Quadflieg", "readonly", "typeof"],
+  "cSpell.words": ["Quadflieg", "backticks", "readonly", "typeof"],
   "eslint.validate": ["javascript", "typescript"],
   "typescript.tsdk": "node_modules/typescript/lib"
 }

.vscode/settings.json

@@ -38,6 +38,7 @@
     "@typescript-eslint/parser": "~4.19.0",
     "eslint": "~7.22.0",
     "eslint-config-prettier": "~8.1.0",
+    "eslint-define-config": "~1.0.0-alpha.1",
     "eslint-plugin-inclusive-language": "~2.1.1",
     "eslint-plugin-jsdoc": "~32.3.0",
     "eslint-plugin-prettier": "~3.3.1",

package.json

@@ -1,11 +1,74 @@
+import { EslintRules } from './rules/eslint';
+import { RuleConfig } from './rules/rule-config';
+
+/**
+ *
+ */
+export interface Env {
+  es6?: boolean;
+  node?: boolean;
+}
+
+/**
+ *
+ */
+export interface ParserOptions {
+  sourceType?: 'module' | '...';
+  ecmaVersion?: 2020;
+  project?: any;
+  warnOnUnsupportedTypeScriptVersion?: boolean;
+}
+
+/**
+ *
+ */
+export type Rules = Partial<EslintRules> & Partial<Record<string, RuleConfig>>;
+
+/**
+ *
+ */
+export interface Override {
+  files: string[];
+  rules: Rules;
+}
+
+/**
+ *
+ */
+export type Overrides = Array<Override>;
+
+/**
+ *
+ */
+export interface Settings {
+  jsdoc?: {
+    mode: string;
+  };
+}
+
+/**
+ *
+ */
+export interface EslintConfig {
+  root?: boolean;
+  env?: Env;
+  extends?: string[];
+  parser?: string;
+  parserOptions?: ParserOptions;
+  plugins?: string[];
+  rules?: Rules;
+  overrides?: Overrides;
+  settings?: Settings;
+}
+
 /**
  * Define an eslint config.
  *
  * @param config Eslint config.
  * @returns Eslint config.
  */
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/explicit-function-return-type
-export function defineConfig(config: any) {
+export function defineConfig(config: EslintConfig) {
   // eslint-disable-next-line @typescript-eslint/no-unsafe-return
   return config;
 }

src/index.ts

@@ -0,0 +1,8 @@
+import { NoDebuggerRule } from './no-debugger';
+import { QuotesRule } from './quotes';
+import { SemiRule } from './semi';
+
+/**
+ *
+ */
+export type EslintRules = NoDebuggerRule & QuotesRule & SemiRule;

src/rules/eslint/index.ts

@@ -0,0 +1,18 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ *
+ */
+export type NoDebuggerRuleConfig = RuleConfig<[]>;
+
+/**
+ *
+ */
+export interface NoDebuggerRule {
+  /**
+   * Disallow the use of debugger.
+   *
+   * @see [no-debugger](https://eslint.org/docs/rules/no-debugger)
+   */
+  'no-debugger': NoDebuggerRuleConfig;
+}

src/rules/eslint/no-debugger.ts

@@ -0,0 +1,37 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ *
+ */
+export type QuotesOption = 'double' | 'single' | 'backtick';
+
+/**
+ *
+ */
+export interface QuotesConfig {
+  /**
+   * Allows strings to use single-quotes or double-quotes so long as the string contains a quote that would have to be escaped otherwise.
+   */
+  avoidEscape?: boolean;
+  /**
+   * Allows strings to use backticks.
+   */
+  allowTemplateLiterals?: boolean;
+}
+
+/**
+ *
+ */
+export type QuotesRuleConfig = RuleConfig<[QuotesOption, QuotesConfig]>;
+
+/**
+ *
+ */
+export interface QuotesRule {
+  /**
+   * Enforce the consistent use of either backticks, double, or single quotes.
+   *
+   * @see [quotes](https://eslint.org/docs/rules/quotes)
+   */
+  quotes: QuotesRuleConfig;
+}

src/rules/eslint/quotes.ts

@@ -0,0 +1,18 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ *
+ */
+export type SemiRuleConfig = RuleConfig<['always' | 'never' /* ... */]>;
+
+/**
+ *
+ */
+export interface SemiRule {
+  /**
+   * Require or disallow semicolons instead of ASI.
+   *
+   * @see [semi](https://eslint.org/docs/rules/semi)
+   */
+  semi: SemiRuleConfig;
+}

src/rules/eslint/semi.ts

@@ -0,0 +1,6 @@
+import type { RuleSeverity } from './rule-severity';
+
+/**
+ *
+ */
+export type RuleConfig<Options extends unknown[] = unknown[]> = RuleSeverity | [RuleSeverity, ...Options];