@w5s/dev 3.3.0 → 3.3.3

package/src/ESLintConfig.ts

@@ -1,79 +1,130 @@
-import type { ESLint } from 'eslint';
+import type { Linter } from 'eslint';
 
-function toArray<T>(value: T[] | T | undefined): T[] {
-  if (value == null) {
-    return [];
-  }
-  if (Array.isArray(value)) {
-    return value;
+/**
+ * Return a new merged flat configuration
+ *
+ * @param configs
+ */
+function merge<T extends Linter.Config = Linter.Config>(...configs: Array<T>): T {
+  const keys = new Set(configs.flatMap((i) => Object.keys(i)));
+  const merged = configs.reduce((acc, cur) => {
+    return {
+      ...acc,
+      ...cur,
+      files: [
+        ...(acc.files ?? []),
+        ...(cur.files ?? []),
+      ],
+      ignores: [
+        ...(acc.ignores ?? []),
+        ...(cur.ignores ?? []),
+      ],
+      plugins: {
+        ...acc.plugins,
+        ...cur.plugins,
+      },
+      rules: {
+        ...acc.rules,
+        ...cur.rules,
+      },
+      languageOptions: {
+        ...acc.languageOptions,
+        ...cur.languageOptions,
+      },
+      linterOptions: {
+        ...acc.linterOptions,
+        ...cur.linterOptions,
+      },
+    };
+  // eslint-disable-next-line ts/consistent-type-assertions
+  }, {} as T);
+
+  // Remove unused keys
+  for (const key of Object.keys(merged)) {
+    if (!keys.has(key))
+      // eslint-disable-next-line ts/no-dynamic-delete
+      delete (merged as any)[key];
   }
-  return [value];
-}
 
-function concatArray<T>(left: T[] | T | undefined, right: T[] | T | undefined): T[] {
-  return [...toArray(left), ...toArray(right)];
+  return merged as T;
 }
 
-export namespace ESLintConfig {
-  /**
-   *
-   * @param configs
-   */
-  export function concat(...configs: ESLint.ConfigData[]): ESLint.ConfigData {
-    return configs.reduce(
-      (returnValue, config) => ({
-        ...returnValue,
-        ...config,
-        env: { ...returnValue.env, ...config.env },
-        extends: concatArray(returnValue.extends, config.extends),
-        globals: { ...returnValue.globals, ...config.globals },
-        overrides: concatArray(returnValue.overrides, config.overrides),
-        parserOptions: { ...returnValue.parserOptions, ...config.parserOptions },
-        plugins: concatArray(returnValue.plugins, config.plugins),
-        rules: { ...returnValue.rules, ...config.rules },
-        settings: { ...returnValue.settings, ...config.settings },
-      }),
-      {
-        env: {},
-        extends: [],
-        globals: {},
-        overrides: [],
-        parserOptions: {},
-        plugins: [],
-        rules: {},
-        settings: {},
-      },
-    );
-  }
+/**
+ * Concat multiple flat configs into a single flat config array.
+ *
+ * It also resolves promises and flattens the result.
+ *
+ * @example
+ *
+ * ```ts
+ * import eslint from '@eslint/js'
+ *
+ * export default ESLintConfig.concat(
+ *   {
+ *     plugins: {},
+ *     rules: {},
+ *   },
+ *   // It can also takes a array of configs:
+ *   [
+ *     {
+ *       plugins: {},
+ *       rules: {},
+ *     }
+ *    // ...
+ *   ],
+ *   // Or promises:
+ *   Promise.resolve({
+ *     files: ['*.ts'],
+ *     rules: {},
+ *   })
+ * );
+ * ```
+ * @param configs
+ */
+async function concat<T extends Linter.Config = Linter.Config>(
+  ...configs: Array<T | ReadonlyArray<T> | Promise<T> | Promise<ReadonlyArray<T>>>
+): Promise<Array<T>> {
+  const resolved = await Promise.all(configs);
+  return resolved.flat() as Array<T>;
+}
 
-  /**
-   * Always return 'off'. `_status` is the previous rule value.
-   *
-   * @param _status
-   */
-  export function fixme(_status: string | number | [string | number, ...any[]] | undefined) {
-    return 'off' as const;
-  }
+/**
+ * Always return 'off'. `_status` is the previous rule value.
+ *
+ * @param _status
+ */
+function fixme(_status: string | number | [string | number, ...any[]] | undefined) {
+  return 'off' as const;
+}
 
-  /**
-   * Renames rules in the given object according to the given map.
-   *
-   * Given a map `{ 'old-prefix': 'new-prefix' }`, and a rule object
-   * `{ 'old-prefix/rule-name': 'error' }`, this function will return
-   * `{ 'new-prefix/rule-name': 'error' }`.
-   *
-   * @param rules The object containing the rules to rename.
-   * @param map The object containing the rename map.
-   */
-  export function renameRules(rules: Record<string, any>, map: Record<string, string>): Record<string, any> {
-    return Object.fromEntries(
-      Object.entries(rules).map(([key, value]) => {
-        for (const [from, to] of Object.entries(map)) {
-          if (key.startsWith(`${from}/`)) return [to + key.slice(from.length), value];
-          else if (from === '' && !key.includes('/') && to !== '') return [to + key, value];
-        }
-        return [key, value];
-      }),
-    );
-  }
+/**
+ * Renames rules in the given object according to the given map.
+ *
+ * Given a map `{ 'old-prefix': 'new-prefix' }`, and a rule object
+ * `{ 'old-prefix/rule-name': 'error' }`, this function will return
+ * `{ 'new-prefix/rule-name': 'error' }`.
+ *
+ * @param rules The object containing the rules to rename.
+ * @param map The object containing the rename map.
+ */
+function renameRules(rules: Record<string, any>, map: Record<string, string>): Record<string, any> {
+  return Object.fromEntries(
+    Object.entries(rules).map(([key, value]) => {
+      for (const [from, to] of Object.entries(map)) {
+        if (key.startsWith(`${from}/`)) return [to + key.slice(from.length), value];
+        else if (from === '' && !key.includes('/') && to !== '') return [to + key, value];
+      }
+      return [key, value];
+    }),
+  );
 }
+
+/**
+ * @namespace
+ */
+export const ESLintConfig = Object.freeze({
+  merge,
+  concat,
+  fixme,
+  renameRules,
+});

package/src/Project.ts

@@ -1,150 +1,158 @@
 import type { LanguageId } from './LanguageId.js';
 
+/**
+ * A type of a file extension
+ */
+export type Extension = `.${string}`;
+
+/**
+ * Object hash of all well-known file extension category to file extensions mapping
+ */
+export type ExtensionRegistry = { [K in LanguageId]: readonly Extension[] };
+
 function escapeRegExp(value: string) {
   // eslint-disable-next-line unicorn/prefer-string-raw
   return value.replaceAll(/[$()*+.?[\\\]^{|}]/g, '\\$&'); // $& means the whole matched string
 }
 
-export namespace Project {
-  /**
-   * A type of a file extension
-   */
-  export type Extension = `.${string}`;
-
-  /**
-   * Object hash of all well-known file extension category to file extensions mapping
-   */
-  export type ExtensionRegistry = { [K in LanguageId]: readonly Extension[] };
-
-  /**
-   * Supported ECMA version
-   *
-   * @example
-   * ```ts
-   * Project.ecmaVersion() // 2022
-   * ```
-   */
-  export function ecmaVersion() {
-    return 2022 as const;
-  }
+/**
+ * Supported ECMA version
+ *
+ * @example
+ * ```ts
+ * Project.ecmaVersion() // 2022
+ * ```
+ */
+function ecmaVersion() {
+  return 2022 as const;
+}
 
-  const registry: ExtensionRegistry = {
-    css: ['.css'],
-    graphql: ['.gql', '.graphql'],
-    javascript: ['.js', '.cjs', '.mjs'],
-    javascriptreact: ['.jsx'],
-    jpeg: ['.jpg', '.jpeg'],
-    json: ['.json'],
-    jsonc: ['.jsonc'],
-    less: ['.less'],
-    markdown: ['.markdown', '.mdown', '.mkd', '.md'],
-    sass: ['.sass'],
-    scss: ['.scss'],
-    typescript: ['.ts', '.cts', '.mts'],
-    typescriptreact: ['.tsx'],
-    vue: ['.vue'],
-    yaml: ['.yaml', '.yml'],
-  };
+const registry: ExtensionRegistry = {
+  css: ['.css'],
+  graphql: ['.gql', '.graphql'],
+  javascript: ['.js', '.cjs', '.mjs'],
+  javascriptreact: ['.jsx'],
+  jpeg: ['.jpg', '.jpeg'],
+  json: ['.json'],
+  jsonc: ['.jsonc'],
+  less: ['.less'],
+  markdown: ['.markdown', '.mdown', '.mkd', '.md'],
+  sass: ['.sass'],
+  scss: ['.scss'],
+  typescript: ['.ts', '.cts', '.mts'],
+  typescriptreact: ['.tsx'],
+  vue: ['.vue'],
+  yaml: ['.yaml', '.yml'],
+};
 
-  /**
-   * Return a list of extensions
-   *
-   * @example
-   * ```ts
-   * Project.queryExtensions(['javascript']); // ['.js', '.cjs', ...]
-   * Project.queryExtensions(['typescript', 'typescriptreact']); // ['.ts', '.mts', ..., '.tsx']
-   * ```
-   *
-   * @param languages
-   */
-  export function queryExtensions(languages: LanguageId[]): readonly Extension[] {
-    return languages
-      .reduce<Extension[]>((previousValue, currentValue) =>
-        // eslint-disable-next-line unicorn/prefer-spread
-        previousValue.concat(registry[currentValue] ?? ([] as Extension[])), [])
-      // eslint-disable-next-line unicorn/no-array-sort
-      .sort();
-  }
+/**
+ * Return a list of extensions
+ *
+ * @example
+ * ```ts
+ * Project.queryExtensions(['javascript']); // ['.js', '.cjs', ...]
+ * Project.queryExtensions(['typescript', 'typescriptreact']); // ['.ts', '.mts', ..., '.tsx']
+ * ```
+ *
+ * @param languages
+ */
+function queryExtensions(languages: LanguageId[]): readonly Extension[] {
+  return languages
+    .reduce<Extension[]>((previousValue, currentValue) =>
+      // eslint-disable-next-line unicorn/prefer-spread
+      previousValue.concat(registry[currentValue] ?? ([] as Extension[])), [])
+    // eslint-disable-next-line unicorn/no-array-sort
+    .sort();
+}
 
-  /**
-   * Supported file extensions
-   *
-   * @example
-   * ```ts
-   * Project.sourceExtensions() // ['.ts', '.js', ...]
-   * ```
-   */
-  export function sourceExtensions() {
-    return queryExtensions(['javascript', 'javascriptreact', 'typescript', 'typescriptreact']);
-  }
+/**
+ * Supported file extensions
+ *
+ * @example
+ * ```ts
+ * Project.sourceExtensions() // ['.ts', '.js', ...]
+ * ```
+ */
+function sourceExtensions() {
+  return queryExtensions(['javascript', 'javascriptreact', 'typescript', 'typescriptreact']);
+}
 
-  const RESOURCE_EXTENSIONS: readonly Extension[] = Object.freeze([
-    '.gif',
-    '.png',
-    '.svg',
-    ...queryExtensions(['css', 'graphql', 'jpeg', 'less', 'sass', 'sass', 'yaml']),
-  ]);
+const RESOURCE_EXTENSIONS: readonly Extension[] = Object.freeze([
+  '.gif',
+  '.png',
+  '.svg',
+  ...queryExtensions(['css', 'graphql', 'jpeg', 'less', 'sass', 'sass', 'yaml']),
+]);
 
-  /**
-   * Resource file extensions
-   *
-   * @example
-   * ```ts
-   * Project.resourceExtensions() // ['.css', '.sass', ...]
-   * ```
-   */
-  export function resourceExtensions() {
-    return RESOURCE_EXTENSIONS;
-  }
+/**
+ * Resource file extensions
+ *
+ * @example
+ * ```ts
+ * Project.resourceExtensions() // ['.css', '.sass', ...]
+ * ```
+ */
+function resourceExtensions() {
+  return RESOURCE_EXTENSIONS;
+}
 
-  const IGNORED = Object.freeze([
-    'node_modules/',
-    'build/',
-    'cjs/',
-    'coverage/',
-    'dist/',
-    'dts/',
-    'esm/',
-    'lib/',
-    'mjs/',
-    'umd/',
-  ]);
+const IGNORED = Object.freeze([
+  'node_modules/',
+  'build/',
+  'cjs/',
+  'coverage/',
+  'dist/',
+  'dts/',
+  'esm/',
+  'lib/',
+  'mjs/',
+  'umd/',
+]);
 
-  /**
-   * Files and folders to always ignore
-   *
-   * @example
-   * ```ts
-   * IGNORED // ['node_modules/', 'build/', ...]
-   * ```
-   */
-  export function ignored() {
-    return IGNORED;
-  }
+/**
+ * Files and folders to always ignore
+ *
+ * @example
+ * ```ts
+ * IGNORED // ['node_modules/', 'build/', ...]
+ * ```
+ */
+function ignored() {
+  return IGNORED;
+}
 
-  /**
-   * Return a RegExp that will match any list of extensions
-   *
-   * @param extensions
-   * @example
-   * ```ts
-   * Project.extensionsToMatcher(['.js', '.ts']) // RegExp = /(\.js|\.ts)$/
-   * ```
-   */
-  export function extensionsToMatcher(extensions: readonly Extension[]): RegExp {
-    return new RegExp(`(${extensions.map(escapeRegExp).join('|')})$`);
-  }
+/**
+ * Return a RegExp that will match any list of extensions
+ *
+ * @param extensions
+ * @example
+ * ```ts
+ * Project.extensionsToMatcher(['.js', '.ts']) // RegExp = /(\.js|\.ts)$/
+ * ```
+ */
+function extensionsToMatcher(extensions: readonly Extension[]): RegExp {
+  return new RegExp(`(${extensions.map(escapeRegExp).join('|')})$`);
+}
 
-  /**
-   * Return a glob matcher that will match any list of extensions
-   *
-   * @param extensions
-   * @example
-   * ```ts
-   * Project.extensionsToGlob(['.js', '.ts']) // '*.+(js|ts)'
-   * ```
-   */
-  export function extensionsToGlob(extensions: readonly Extension[]): string {
-    return `*.+(${extensions.map((_) => _.replace(/^\./, '')).join('|')})`;
-  }
+/**
+ * Return a glob matcher that will match any list of extensions
+ *
+ * @param extensions
+ * @example
+ * ```ts
+ * Project.extensionsToGlob(['.js', '.ts']) // '*.+(js|ts)'
+ * ```
+ */
+function extensionsToGlob(extensions: readonly Extension[]): string {
+  return `*.+(${extensions.map((_) => _.replace(/^\./, '')).join('|')})`;
 }
+
+export const Project = Object.freeze({
+  ecmaVersion,
+  extensionsToGlob,
+  extensionsToMatcher,
+  ignored,
+  queryExtensions,
+  resourceExtensions,
+  sourceExtensions,
+});

package/src/ProjectScript.ts

@@ -16,6 +16,7 @@ export const ProjectScript = {
   Rescue: 'rescue',
   Spellcheck: 'spellcheck',
   Test: 'test',
+  Typecheck: 'typecheck',
   Validate: 'validate',
 } as const;
 export type ProjectScript = (typeof ProjectScript)[keyof typeof ProjectScript];

package/dist/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/ESLintConfig.ts","../src/interopDefault.ts","../src/LanguageId.ts","../src/meta.ts","../src/Project.ts","../src/ProjectScript.ts"],"mappings":";;;kBAgBiB,YAAA;;AAAjB;;;WAKkB,MAAA,CAAA,GAAU,OAAA,EAAS,MAAA,CAAO,UAAA,KAAe,MAAA,CAAO,UAAA;EAAP;;;;;EAAA,SAgCzC,KAAA,CAAM,OAAA;EAhCN;;;;;;;;;;EAAA,SA8CA,WAAA,CAAY,KAAA,EAAO,MAAA,eAAqB,GAAA,EAAK,MAAA,mBAAyB,MAAA;AAAA;;;;;;AAnDxF;;;;;;;;;;;;;;;;;iBCMgB,cAAA,GAAA,CAAkB,CAAA,EAAG,WAAA,CAAY,CAAA,IAAK,OAAA,CAAQ,CAAA;EAAY,OAAA;AAAA,IAAqB,CAAA,GAAI,CAAA;AAAA,iBACnF,cAAA,GAAA,CAAkB,CAAA,EAAG,CAAA,GAAI,CAAA;EAAY,OAAA;AAAA,IAAqB,CAAA,GAAI,CAAA;;;UCvB7D,aAAA;EACf,GAAA;EACA,OAAA;EACA,UAAA;EACA,eAAA;EACA,IAAA;EACA,IAAA;EACA,KAAA;EACA,IAAA;EACA,QAAA;EACA,IAAA;EACA,IAAA;EACA,UAAA;EACA,eAAA;EACA,GAAA;EACA,IAAA;AAAA;;;;KAMU,UAAA,SAAmB,aAAA;;;cCrBlB,IAAA,EAAI,QAAA;;;;;;;kBCOA,OAAA;;AJSjB;;OILc,SAAA;EJUuB;;;EAAA,KILvB,iBAAA,WAA4B,UAAA,YAAsB,SAAA;EJmD8B;;;;;;;;EAAA,SIzC5E,WAAA,CAAA;EJyCA;;;;;;;;;;;EAAA,SIRA,eAAA,CAAgB,SAAA,EAAW,UAAA,cAAwB,SAAA;EHrCvC;;;;;;;;EAAA,SGsDZ,gBAAA,CAAA;EHtDa;;;;;;;;EAAA,SGyEb,kBAAA,CAAA;EHzEiF;;;AACnG;;;;;EADmG,SGkGjF,OAAA,CAAA;EHjG6D;;;;;;;;;EAAA,SG8G7D,mBAAA,CAAoB,UAAA,WAAqB,SAAA,KAAc,MAAA;EH9GM;;;;;ACvB/E;;;;EDuB+E,SG2H7D,gBAAA,CAAiB,UAAA,WAAqB,SAAA;AAAA;;;;;;cC/I3C,aAAA;EAAA;;;;;;;;;;;;;;;;KAiBD,aAAA,WAAwB,aAAA,eAA4B,aAAA"}