@averay/codeformat 0.1.14 → 0.2.0

package/rulesets/eslint/ruleset-typescript.ts

@@ -0,0 +1,226 @@
+/* eslint unicorn/no-useless-spread: "off" -- Keep the unprefixed core rules together. */
+/* eslint sort-keys: "error" -- Organise rules */
+
+import js from '@eslint/js';
+import typescriptPlugin from '@typescript-eslint/eslint-plugin';
+import { type TSESLint } from '@typescript-eslint/utils';
+import importPlugin from 'eslint-plugin-import';
+
+export default {
+  ...js.configs.recommended.rules,
+  ...importPlugin.configs.typescript.rules,
+  ...typescriptPlugin.configs['eslint-recommended']?.rules,
+  ...typescriptPlugin.configs['recommended']?.rules,
+  ...typescriptPlugin.configs['recommended-requiring-type-checking']?.rules,
+  ...typescriptPlugin.configs['strict']?.rules,
+
+  ...{
+    'array-callback-return': 'off',
+    'consistent-return': 'off',
+    'default-case': 'off',
+    'default-param-last': 'off',
+    'dot-notation': 'off',
+    'lines-between-class-members': 'off',
+    'no-array-constructor': 'off',
+    'no-dupe-class-members': 'off',
+    'no-duplicate-imports': 'off',
+    'no-empty-function': 'off',
+    'no-implied-eval': 'off',
+    'no-invalid-this': 'off',
+    'no-loop-func': 'off',
+    'no-loss-of-precision': 'off',
+    'no-magic-numbers': 'off',
+    'no-redeclare': 'off',
+    'no-restricted-imports': 'off',
+    'no-return-await': 'off',
+    'no-shadow': 'off',
+    'no-throw-literal': 'off',
+    'no-unused-expressions': 'off',
+    'no-unused-vars': 'off',
+    'no-use-before-define': 'off',
+    'no-useless-constructor': 'off',
+    'padding-line-between-statements': 'off',
+  },
+
+  '@typescript-eslint/adjacent-overload-signatures': 'error',
+  '@typescript-eslint/array-type': 'error',
+  '@typescript-eslint/await-thenable': 'error',
+  '@typescript-eslint/ban-ts-comment': 'error',
+  '@typescript-eslint/class-literal-property-style': 'off', // Breaks subclassed getters
+  '@typescript-eslint/consistent-indexed-object-style': 'error',
+  '@typescript-eslint/consistent-type-assertions': [
+    'error',
+    { assertionStyle: 'as', objectLiteralTypeAssertions: 'allow' },
+  ],
+  '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
+  '@typescript-eslint/consistent-type-exports': ['error', { fixMixedExportsWithInlineTypeSpecifier: true }],
+  '@typescript-eslint/consistent-type-imports': 'error',
+  '@typescript-eslint/default-param-last': 'error',
+  '@typescript-eslint/dot-notation': 'error',
+  '@typescript-eslint/explicit-function-return-type': ['error', { allowExpressions: true }],
+  '@typescript-eslint/explicit-member-accessibility': ['error', { overrides: { constructors: 'no-public' } }],
+  '@typescript-eslint/explicit-module-boundary-types': ['error', { allowArgumentsExplicitlyTypedAsAny: true }],
+  '@typescript-eslint/member-ordering': 'off',
+  '@typescript-eslint/method-signature-style': 'off',
+  '@typescript-eslint/naming-convention': [
+    'error',
+    /* eslint-disable sort-keys -- Logically ordered */
+    {
+      selector: 'default',
+      format: ['camelCase'],
+    },
+    {
+      selector: 'variable',
+      modifiers: ['const'],
+      format: ['camelCase', 'PascalCase', 'UPPER_CASE'],
+    },
+    {
+      selector: 'variable',
+      modifiers: ['const'],
+      filter: { regex: /^_(static|\d+)?$/u.source, match: true },
+      format: ['camelCase'],
+      leadingUnderscore: 'allow',
+    },
+    {
+      selector: 'parameter',
+      format: ['camelCase'],
+      leadingUnderscore: 'allow',
+    },
+    {
+      selector: 'property',
+      format: ['camelCase', 'UPPER_CASE'],
+    },
+    {
+      selector: 'classProperty',
+      modifiers: ['static'],
+      format: ['camelCase', 'PascalCase', 'UPPER_CASE'],
+    },
+    {
+      selector: 'enumMember',
+      format: ['camelCase', 'PascalCase', 'UPPER_CASE'],
+    },
+    {
+      selector: 'function',
+      format: ['camelCase', 'PascalCase'],
+    },
+    {
+      selector: 'typeLike',
+      format: ['PascalCase'],
+    },
+    {
+      selector: ['objectLiteralProperty'],
+      format: [],
+    },
+    {
+      selector: ['classProperty', 'objectLiteralMethod'],
+      format: ['camelCase', 'UPPER_CASE'],
+    },
+    {
+      selector: 'typeParameter',
+      format: ['PascalCase'],
+      custom: { regex: /^([A-Z]|T[A-Z][a-zA-Z]+|key)$/u.source, match: true },
+    },
+    /* eslint-enable sort-keys -- Logically ordered */
+  ],
+  '@typescript-eslint/no-array-constructor': 'error',
+  '@typescript-eslint/no-base-to-string': 'error',
+  '@typescript-eslint/no-confusing-non-null-assertion': 'error',
+  '@typescript-eslint/no-confusing-void-expression': 'error',
+  '@typescript-eslint/no-dupe-class-members': 'error',
+  '@typescript-eslint/no-dynamic-delete': 'off',
+  '@typescript-eslint/no-empty-function': 'error',
+  '@typescript-eslint/no-empty-interface': ['error', { allowSingleExtends: true }],
+  '@typescript-eslint/no-explicit-any': 'off',
+  '@typescript-eslint/no-extra-non-null-assertion': 'error',
+  '@typescript-eslint/no-extraneous-class': 'error',
+  '@typescript-eslint/no-floating-promises': 'error',
+  '@typescript-eslint/no-for-in-array': 'error',
+  '@typescript-eslint/no-implied-eval': 'error',
+  '@typescript-eslint/no-inferrable-types': ['error', { ignoreParameters: true }],
+  '@typescript-eslint/no-invalid-this': 'error',
+  '@typescript-eslint/no-invalid-void-type': 'error',
+  '@typescript-eslint/no-loop-func': 'error',
+  '@typescript-eslint/no-loss-of-precision': 'error',
+  '@typescript-eslint/no-magic-numbers': [
+    'error',
+    {
+      detectObjects: true,
+      enforceConst: true,
+      ignore: [-1, 0, 1],
+      ignoreArrayIndexes: true,
+      ignoreClassFieldInitialValues: true,
+      ignoreDefaultValues: true,
+    },
+  ],
+  '@typescript-eslint/no-meaningless-void-operator': 'error',
+  '@typescript-eslint/no-misused-new': 'error',
+  '@typescript-eslint/no-misused-promises': 'error',
+  '@typescript-eslint/no-namespace': 'error',
+  '@typescript-eslint/no-non-null-asserted-nullish-coalescing': 'error',
+  '@typescript-eslint/no-non-null-asserted-optional-chain': 'error',
+  '@typescript-eslint/no-non-null-assertion': 'error',
+  '@typescript-eslint/no-redeclare': 'error',
+  '@typescript-eslint/no-require-imports': 'error',
+  '@typescript-eslint/no-restricted-imports': 'error',
+  '@typescript-eslint/no-shadow': ['error', { hoist: 'all' }],
+  '@typescript-eslint/no-this-alias': 'error',
+  '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
+  '@typescript-eslint/no-unnecessary-condition': ['error', { allowConstantLoopConditions: true }],
+  '@typescript-eslint/no-unnecessary-qualifier': 'error',
+  '@typescript-eslint/no-unnecessary-type-arguments': 'error',
+  '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+  '@typescript-eslint/no-unnecessary-type-constraint': 'error',
+  '@typescript-eslint/no-unused-expressions': 'error',
+  '@typescript-eslint/no-unused-vars': [
+    'error',
+    {
+      argsIgnorePattern: /^_\w*$/u.source,
+      caughtErrorsIgnorePattern: /^_\w*$/u.source,
+      varsIgnorePattern: /^(_\d*|React)$/u.source,
+    },
+  ],
+  '@typescript-eslint/no-use-before-define': 'error',
+  '@typescript-eslint/no-useless-constructor': 'error',
+  '@typescript-eslint/no-useless-empty-export': 'error',
+  '@typescript-eslint/no-var-requires': 'error',
+  '@typescript-eslint/non-nullable-type-assertion-style': 'error',
+  '@typescript-eslint/only-throw-error': 'error',
+  '@typescript-eslint/prefer-as-const': 'error',
+  '@typescript-eslint/prefer-enum-initializers': 'error',
+  '@typescript-eslint/prefer-for-of': 'error',
+  '@typescript-eslint/prefer-function-type': 'error',
+  '@typescript-eslint/prefer-includes': 'error',
+  '@typescript-eslint/prefer-literal-enum-member': 'error',
+  '@typescript-eslint/prefer-namespace-keyword': 'error',
+  '@typescript-eslint/prefer-nullish-coalescing': [
+    'error',
+    { ignoreConditionalTests: false, ignoreMixedLogicalExpressions: false },
+  ],
+  '@typescript-eslint/prefer-optional-chain': 'error',
+  '@typescript-eslint/prefer-readonly': 'error',
+  '@typescript-eslint/prefer-reduce-type-parameter': 'error',
+  '@typescript-eslint/prefer-return-this-type': 'error',
+  '@typescript-eslint/prefer-string-starts-ends-with': 'error',
+  '@typescript-eslint/prefer-ts-expect-error': 'error',
+  '@typescript-eslint/promise-function-async': 'error',
+  '@typescript-eslint/require-array-sort-compare': 'error',
+  '@typescript-eslint/restrict-plus-operands': 'error',
+  '@typescript-eslint/restrict-template-expressions': 'error',
+  '@typescript-eslint/return-await': 'error',
+  '@typescript-eslint/strict-boolean-expressions': [
+    'error',
+    { allowNullableObject: false, allowNullableString: false, allowNumber: false, allowString: false },
+  ],
+  '@typescript-eslint/switch-exhaustiveness-check': 'error',
+  '@typescript-eslint/triple-slash-reference': 'error',
+  '@typescript-eslint/unbound-method': 'off', // Does not support @autobind nor recognise binding in constructors
+  '@typescript-eslint/unified-signatures': 'off',
+
+  'jsdoc/no-types': 'error',
+  'jsdoc/require-param-type': 'off',
+  'jsdoc/require-returns-type': 'off',
+} satisfies TSESLint.FlatConfig.Rules;
+
+export const moduleDeclarations = {
+  'no-duplicate-imports': 'off', // Allow imports within multiple module declarations.
+} satisfies TSESLint.FlatConfig.Rules;

package/rulesets/stylelint/ruleset-css.ts

@@ -0,0 +1,22 @@
+/* eslint sort-keys: "error" -- Organise rules. */
+/* eslint unicorn/no-useless-spread: "off" -- Keep the unprefixed core rules together. */
+
+import propertiesOrder from '@averay/css-properties-sort-order';
+import recommended from 'stylelint-config-recommended';
+import standard from 'stylelint-config-standard';
+
+export default {
+  ...recommended.rules,
+  ...standard.rules,
+
+  ...{
+    'at-rule-empty-line-before': null,
+    'color-named': 'never',
+    'comment-empty-line-before': null,
+    'function-url-no-scheme-relative': true,
+    'rule-empty-line-before': null,
+  },
+
+  'order/order': ['custom-properties', 'declarations'],
+  'order/properties-order': [propertiesOrder, { unspecified: 'bottomAlphabetical' }],
+};

package/rulesets/stylelint/ruleset-scss.ts

@@ -0,0 +1,33 @@
+/* eslint sort-keys: "error" -- Organise rules. */
+/* eslint unicorn/no-useless-spread: "off" -- Keep the unprefixed core rules together. */
+
+import recommended from 'stylelint-config-recommended-scss';
+import standard from 'stylelint-config-standard-scss';
+
+const CUSTOM_KEYWORD_PATTERN = /^_?[a-z][\da-z]*((-|--|__)[\da-z]+)*$/u;
+
+export default {
+  ...recommended.rules,
+  ...standard.rules,
+
+  // Disable Prettier-conflicting legacy rules.
+  ...{
+    'scss/at-else-closing-brace-newline-after': null,
+    'scss/at-else-closing-brace-space-after': null,
+    'scss/at-else-empty-line-before': null,
+    'scss/at-else-if-parentheses-space-before': null,
+    'scss/at-function-parentheses-space-before': null,
+    'scss/at-if-closing-brace-newline-after': null,
+    'scss/at-if-closing-brace-space-after': null,
+    'scss/at-mixin-parentheses-space-before': null,
+    'scss/dollar-variable-colon-newline-after': null,
+    'scss/dollar-variable-colon-space-after': null,
+    'scss/dollar-variable-colon-space-before': null,
+    'scss/operator-no-newline-after': null,
+    'scss/operator-no-newline-before': null,
+    'scss/operator-no-unspaced': null,
+  },
+  'scss/at-function-pattern': CUSTOM_KEYWORD_PATTERN.source,
+  'scss/at-mixin-pattern': CUSTOM_KEYWORD_PATTERN.source,
+  'scss/dollar-variable-pattern': CUSTOM_KEYWORD_PATTERN.source,
+};

package/src/extensions.ts

@@ -0,0 +1,7 @@
+export default {
+  js: ['js', 'jsx', 'cjs', 'cjs', 'mjs', 'mjsx'],
+  ts: ['ts', 'tsx', 'cts', 'cts', 'mts', 'mtsx'],
+
+  css: ['css'],
+  scss: ['scss'],
+} satisfies Record<string, string[]>;

package/src/index.ts

@@ -0,0 +1,4 @@
+export { default as globals } from 'globals';
+export { default as extensions } from './extensions.ts';
+export { default as makeEslintConfig } from './makeEslintConfig.ts';
+export { default as makeStylelintConfig } from './makeStylelintConfig.ts';

package/src/makeEslintConfig.ts

@@ -0,0 +1,98 @@
+/* eslint sort-keys: "error" -- Organise rules */
+
+import stylisticPlugin from '@stylistic/eslint-plugin';
+import typescriptPlugin from '@typescript-eslint/eslint-plugin';
+import typescriptParser from '@typescript-eslint/parser';
+import { type TSESLint } from '@typescript-eslint/utils';
+import prettierConfig from 'eslint-config-prettier';
+import eslintCommentsPlugin from 'eslint-plugin-eslint-comments';
+import importPlugin from 'eslint-plugin-import';
+import jsdocPlugin from 'eslint-plugin-jsdoc';
+import promisePlugin from 'eslint-plugin-promise';
+import regexpPlugin from 'eslint-plugin-regexp';
+import sonarjsPlugin from 'eslint-plugin-sonarjs';
+import unicornPlugin from 'eslint-plugin-unicorn';
+
+import convertWarnsToErrors from '../lib/convertWarnsToErrors.ts';
+import rulesetEslintShared from '../rulesets/eslint/ruleset-shared.ts';
+import rulesetEslintTypescript, {
+  moduleDeclarations as rulesetEslintTypescriptModuleDeclarations,
+} from '../rulesets/eslint/ruleset-typescript.ts';
+
+import extensions from './extensions.ts';
+
+interface Options {
+  /** The ECMA version to use. */
+  ecmaVersion?: TSESLint.FlatConfig.EcmaVersion;
+  /** The relative path to the project's `tsconfig.json` file. */
+  tsconfigPath?: string;
+}
+
+/**
+ * @param options Project-specific customisations.
+ * @returns The complete ESLint config.
+ */
+export default function makeEslintConfig({
+  ecmaVersion = 'latest',
+  tsconfigPath,
+}: Options = {}): TSESLint.FlatConfig.Config[] {
+  return [
+    // JavaScript & TypeScript
+    {
+      files: [`**/*.{${[...extensions.js, ...extensions.ts].join(',')}}`],
+      languageOptions: {
+        parserOptions: {
+          ecmaVersion,
+          sourceType: 'module',
+        },
+      },
+      linterOptions: {
+        reportUnusedDisableDirectives: true,
+      },
+      plugins: {
+        '@stylistic': stylisticPlugin,
+        'eslint-comments': eslintCommentsPlugin,
+        import: importPlugin,
+        jsdoc: jsdocPlugin,
+        promise: promisePlugin,
+        regexp: regexpPlugin,
+        sonarjs: sonarjsPlugin,
+        unicorn: unicornPlugin,
+      },
+      rules: convertWarnsToErrors(rulesetEslintShared),
+      settings: {
+        'import/parsers': {
+          espree: extensions.js.map((extension) => `.${extension}`),
+        },
+      },
+    },
+
+    // TypeScript
+    {
+      files: [`**/*.{${extensions.ts.join(',')}}`],
+      languageOptions: {
+        parser: typescriptParser,
+        parserOptions: tsconfigPath == null ? {} : { project: tsconfigPath },
+      },
+      plugins: {
+        '@typescript-eslint': typescriptPlugin,
+      },
+      rules: convertWarnsToErrors(rulesetEslintTypescript),
+      settings: {
+        ...importPlugin.configs.typescript.settings,
+        'import/parsers': {
+          '@typescript-eslint/parser': extensions.ts.map((extension) => `.${extension}`),
+        },
+        'import/resolver': {
+          'eslint-import-resolver-typescript': tsconfigPath == null ? {} : { project: tsconfigPath },
+        },
+      },
+    },
+    {
+      files: ['**/*.d.ts'],
+      rules: rulesetEslintTypescriptModuleDeclarations,
+    },
+
+    prettierConfig,
+  ];
+}

package/src/makeStylelintConfig.ts

@@ -0,0 +1,37 @@
+/* eslint sort-keys: "error" -- Organise rules */
+
+import postcssScss from 'postcss-scss';
+import { type Config } from 'stylelint';
+import orderPlugin from 'stylelint-order';
+import scssPlugin from 'stylelint-scss';
+
+import rulesetStylelintCss from '../rulesets/stylelint/ruleset-css.ts';
+import rulesetStylelintScss from '../rulesets/stylelint/ruleset-scss.ts';
+
+import extensions from './extensions.ts';
+
+/**
+ * @returns The complete Stylelint config.
+ */
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type,@typescript-eslint/explicit-module-boundary-types -- Preserve specific object shape.
+export default function makeStylelintConfig() {
+  return {
+    defaultSeverity: 'error',
+    ignoreFiles: ['**/*.min.*'],
+    plugins: [orderPlugin],
+    reportDescriptionlessDisables: true,
+    reportInvalidScopeDisables: true,
+    reportNeedlessDisables: true,
+    rules: rulesetStylelintCss,
+
+    // eslint-disable-next-line sort-keys -- Logically positioned.
+    overrides: [
+      {
+        customSyntax: postcssScss,
+        files: extensions.scss.map((ext) => `**/*.${ext}`), // Does not support glob braces
+        plugins: [scssPlugin],
+        rules: rulesetStylelintScss,
+      },
+    ],
+  } satisfies Config;
+}

package/stylelint.config.cjs

@@ -1,6 +1,6 @@
 /* eslint import/no-commonjs: "off" -- Unsupported by Stylelint */
 
-const { makeStylelintConfig } = require('./dist/codeformat.cjs');
+const { makeStylelintConfig } = require('./src/index.ts');
 
 module.exports = {
   ...makeStylelintConfig(),

package/tsconfig.base.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    // Output
+    "noEmit": true,
+    // Module resolution
+    "allowImportingTsExtensions": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "isolatedModules": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    // Type checking
+    "allowJs": true,
+    "allowUnreachableCode": false,
+    "allowUnusedLabels": false,
+    "checkJs": true,
+    "exactOptionalPropertyTypes": false,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "skipLibCheck": true,
+    "strict": true
+  }
+}

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": "./",
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "types": ["bun", "./types.d.ts"]
+  }
+}

package/types.d.ts

@@ -0,0 +1,97 @@
+declare module '@stylistic/eslint-plugin' {
+  import { type TSESLint } from '@typescript-eslint/utils';
+
+  export default {} as TSESLint.FlatConfig.Plugin & {
+    configs: Record<'recommended-flat', TSESLint.FlatConfig.Config>;
+  };
+}
+
+declare module 'eslint-config-prettier' {
+  import { type TSESLint } from '@typescript-eslint/utils';
+
+  export default {} as TSESLint.FlatConfig.Config;
+}
+
+declare module 'eslint-plugin-eslint-comments' {
+  import { type TSESLint } from '@typescript-eslint/utils';
+
+  export default {} as TSESLint.FlatConfig.Plugin & {
+    configs: Record<'recommended', TSESLint.FlatConfig.Config>;
+  };
+}
+
+declare module 'eslint-plugin-import' {
+  import { type TSESLint } from '@typescript-eslint/utils';
+
+  export default {} as TSESLint.FlatConfig.Plugin & {
+    configs: Record<'recommended' | 'react' | 'react-native' | 'electron' | 'typescript', TSESLint.FlatConfig.Config>;
+  };
+}
+
+declare module 'eslint-plugin-jsdoc' {
+  import { type TSESLint } from '@typescript-eslint/utils';
+
+  export default {} as TSESLint.FlatConfig.Plugin & {
+    configs: Record<'recommended', TSESLint.FlatConfig.Config>;
+  };
+}
+
+declare module 'eslint-plugin-promise' {
+  import { type TSESLint } from '@typescript-eslint/utils';
+
+  export default {} as TSESLint.FlatConfig.Plugin & {
+    configs: Record<'recommended', TSESLint.FlatConfig.Config>;
+  };
+}
+
+declare module 'eslint-plugin-sonarjs' {
+  import { type TSESLint } from '@typescript-eslint/utils';
+
+  export default {} as TSESLint.FlatConfig.Plugin & {
+    configs: Record<'recommended', TSESLint.FlatConfig.Config>;
+  };
+}
+
+declare module 'eslint-plugin-unicorn' {
+  import { type TSESLint } from '@typescript-eslint/utils';
+
+  export default {} as TSESLint.FlatConfig.Plugin & {
+    configs: Record<'recommended', TSESLint.FlatConfig.Config>;
+  };
+}
+
+declare module 'stylelint-config-recommended' {
+  import { type Config } from 'stylelint';
+
+  export default {} as Config;
+}
+
+declare module 'stylelint-config-recommended-scss' {
+  import { type Config } from 'stylelint';
+
+  export default {} as Config;
+}
+
+declare module 'stylelint-config-standard' {
+  import { type Config } from 'stylelint';
+
+  export default {} as Config;
+}
+
+declare module 'stylelint-config-standard-scss' {
+  import { type Config } from 'stylelint';
+
+  export default {} as Config;
+}
+
+declare module 'stylelint-order' {
+  import { type Plugin } from 'stylelint';
+
+  export default {} as Plugin;
+}
+
+declare module 'stylelint-scss' {
+  import { type Plugin } from 'stylelint';
+
+  export default {} as Plugin;
+}