@averay/codeformat 0.1.14 → 0.2.1

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,45 @@
+/* eslint sort-keys: "error" -- Organise rules */
+
+import postcssScss from 'postcss-scss';
+import { type Config, type CustomSyntax } 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';
+
+type ConfigRules = Config['rules'];
+
+/**
+ * @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(cssRules: ConfigRules = {}, scssRules: ConfigRules = {}) {
+  return {
+    defaultSeverity: 'error',
+    ignoreFiles: ['**/*.min.*'],
+    plugins: [orderPlugin],
+    reportDescriptionlessDisables: true,
+    reportInvalidScopeDisables: true,
+    reportNeedlessDisables: true,
+    rules: {
+      ...rulesetStylelintCss,
+      ...cssRules,
+    },
+
+    // eslint-disable-next-line sort-keys -- Logically positioned.
+    overrides: [
+      {
+        customSyntax: postcssScss as unknown as CustomSyntax,
+        files: extensions.scss.map((ext) => `**/*.${ext}`), // Does not support glob braces
+        plugins: [scssPlugin],
+        rules: {
+          ...rulesetStylelintScss,
+          ...scssRules,
+        },
+      },
+    ],
+  } satisfies Config;
+}

package/{stylelint.config.cjs → stylelint.config.js}

@@ -1,7 +1,7 @@
 /* eslint import/no-commonjs: "off" -- Unsupported by Stylelint */
 
-const { makeStylelintConfig } = require('./dist/codeformat.cjs');
+import { makeStylelintConfig } from './src/index.ts';
 
-module.exports = {
+export default {
   ...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;
+}

package/bin-codeformat.sh

@@ -1,31 +0,0 @@
-#!/bin/sh
-
-set -e
-
-# Parse arguments
-ACTION="$1"
-DIR="$2"
-if [ "$DIR" = '' ]; then
-  DIR='.'
-fi
-
-CONFIG_PATH_TYPESCRIPT="$DIR/tsconfig.json"
-
-if [ "$ACTION" = 'check' ]; then
-  npx prettier --check "$DIR"
-  npx eslint "$DIR"
-  if [ -f "$CONFIG_PATH_TYPESCRIPT" ]; then
-    npx tsc --noEmit --project "$DIR/tsconfig.json"
-  fi
-  npx stylelint --allow-empty-input "$DIR/**/*.{css,sass,scss}"
-elif [ "$ACTION" = 'fix' ]; then
-  npx prettier --write "$DIR"
-  npx eslint --fix "$DIR"
-  npx stylelint --fix --allow-empty-input "$DIR/**/*.{css,sass,scss}"
-else
-  # Invalid/unset arguments
-  echo "Usage:
-  $0 check [root-path]
-  $0 fix [root-path]" >&2
-  exit 1
-fi