@1stg/eslint-config 12.0.0 → 12.0.2

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## 12.0.2
+
+### Patch Changes
+
+- [#451](https://github.com/1stG/configs/pull/451) [`a70ca8c`](https://github.com/1stG/configs/commit/a70ca8c676dc39add61c4d7bd744d09624b342db) Thanks [@JounQin](https://github.com/JounQin)! - Annotate the default config type explicitly so TypeScript 6 can emit a portable
+  declaration, keeping `vue-tsc` happy.
+
+## 12.0.1
+
+### Patch Changes
+
+- [#436](https://github.com/1stG/configs/pull/436) [`ac965ca`](https://github.com/1stG/configs/commit/ac965ca37c90f140ed42aa6d93ceb4154886e167) Thanks [@JounQin](https://github.com/JounQin)! - Import `eslint-plugin-oxlint` statically and always apply its disable list.
+  The `oxlint: false` option is removed because omitting Oxlint would silently
+  skip those checks; Oxlint itself remains required through the plugin peer.
+
 ## 12.0.0
 
 ### Major Changes

package/README.md

@@ -25,7 +25,7 @@ export default defineConfig()
 
 `eslint-plugin-mdx`, `eslint-plugin-jsonc` and `eslint-plugin-oxlint` are
 installed by default, so Markdown/JSON(C) linting and the Oxlint rule-disable
-list are on. `eslint-plugin-yml` and `eslint-plugin-toml` are optional peers,
+list are on. `eslint-plugin-oxlint` in turn requires `oxlint`. `eslint-plugin-yml` and `eslint-plugin-toml` are optional peers,
 enabled only when installed (`import.meta.resolve`). ESLint awaits the returned promise. Use
 `export default await defineConfig()` if your tool does not await it.
 
@@ -59,7 +59,6 @@ Use `defineConfig` only when you need options.
 | `yaml`     | installed                     | Lint YAML when installed.                                           |
 | `toml`     | installed                     | Lint TOML when installed.                                           |
 | `code`     | installed `typescript-eslint` | Lint JS/TS/JSX with rules Oxlint does not cover.                    |
-| `oxlint`   | `true`                        | Disable rules Oxlint already owns.                                  |
 | `markup`   | auto                          | Lint HTML with `eslint-plugin-markup` on Node >= 24 when installed. |
 | `ignores`  | `[]`                          | Extra ignore patterns.                                              |
 

package/lib/index.d.ts

@@ -1,15 +1,29 @@
 import type { Linter } from 'eslint';
 export interface EslintConfigOptions {
+    /** Lint Markdown/MDX. @default true */
     markdown?: boolean;
+    /** Lint JSON/JSONC/JSON5. @default true */
     jsonc?: boolean;
+    /** Lint YAML. @default true */
     yaml?: boolean;
+    /** Lint TOML. @default true */
     toml?: boolean;
+    /** Lint HTML with `eslint-plugin-markup` on Node >= 24. @default auto */
     markup?: boolean;
+    /**
+     * Lint JS/TS/JSX as well, with only rules Oxlint does not cover. @default installed
+     * `typescript-eslint`
+     */
     code?: boolean;
-    oxlint?: boolean;
+    /** Extra ignore patterns. */
     ignores?: string[];
 }
-export declare const defineConfig: ({ markdown, jsonc: jsoncEnabled, yaml, toml: tomlEnabled, oxlint: oxlintEnabled, code, markup, ignores, }?: EslintConfigOptions) => Promise<Linter.Config[]>;
-declare const _default: Promise<Linter.Config<import("@eslint/core").RulesConfig>[]>;
-export default _default;
-//# sourceMappingURL=index.d.ts.map
+/**
+ * Build the flat ESLint config for the file types Oxlint does not parse.
+ *
+ * Every plugin is imported dynamically (and only when its option is enabled), so the config works
+ * with ESM-only plugins. ESLint awaits the returned promise before linting.
+ */
+export declare const defineConfig: ({ markdown, jsonc: jsoncEnabled, yaml, toml: tomlEnabled, code, markup, ignores, }?: EslintConfigOptions) => Promise<Linter.Config[]>;
+declare const config: Promise<Linter.Config[]>;
+export default config;

package/lib/index.js

@@ -15,7 +15,9 @@ var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExte
     }
     return path;
 };
+import oxlint from 'eslint-plugin-oxlint';
 const NODE_MAJOR = Number(process.versions.node.split('.')[0]);
+const supportsMarkup = NODE_MAJOR >= 24;
 const CODE_IGNORES = '**/*.{cjs,cts,js,jsx,mjs,mts,ts,tsx}';
 const DEFAULT_IGNORES = [
     '**/.dsh/**',
@@ -36,11 +38,13 @@ const DEFAULT_IGNORES = [
     '**/*.log',
     '**/*.patch',
     '**/*.min.*',
+    // Oxlint owns code; stylelint owns styles; markuplint owns HTML.
     CODE_IGNORES,
     '**/*.vue',
     '**/*.{css,less,sass,scss,styl,stylus}',
     '**/*.html',
 ];
+/** Check whether an optional peer plugin is installed. */
 const toConfigs = (config) => Array.isArray(config) ? config : [config];
 const withCodeFiles = (config) => { var _a; return (Object.assign(Object.assign({}, config), { files: (_a = config.files) !== null && _a !== void 0 ? _a : [CODE_IGNORES] })); };
 const isInstalled = (name) => {
@@ -51,16 +55,23 @@ const isInstalled = (name) => {
         return false;
     }
 };
+/** Dynamic import that also unwraps a CommonJS default export. */
 const load = (name) => __awaiter(void 0, void 0, void 0, function* () {
     var _a;
     const mod = (yield import(__rewriteRelativeImportExtension(name, true)));
     return ((_a = mod.default) !== null && _a !== void 0 ? _a : mod);
 });
-export const defineConfig = (...args_1) => __awaiter(void 0, [...args_1], void 0, function* ({ markdown = true, jsonc: jsoncEnabled = true, yaml = isInstalled('eslint-plugin-yml'), toml: tomlEnabled = isInstalled('eslint-plugin-toml'), oxlint: oxlintEnabled = true, code = isInstalled('typescript-eslint'), markup = NODE_MAJOR >= 24 && isInstalled('eslint-plugin-markup'), ignores = [], } = {}) {
+/**
+ * Build the flat ESLint config for the file types Oxlint does not parse.
+ *
+ * Every plugin is imported dynamically (and only when its option is enabled), so the config works
+ * with ESM-only plugins. ESLint awaits the returned promise before linting.
+ */
+export const defineConfig = (...args_1) => __awaiter(void 0, [...args_1], void 0, function* ({ markdown = true, jsonc: jsoncEnabled = true, yaml = isInstalled('eslint-plugin-yml'), toml: tomlEnabled = isInstalled('eslint-plugin-toml'), code = isInstalled('typescript-eslint'), markup = supportsMarkup && isInstalled('eslint-plugin-markup'), ignores = [], } = {}) {
     const defaultIgnores = DEFAULT_IGNORES.filter(pattern => (!markup || pattern !== '**/*.html') && (!code || pattern !== CODE_IGNORES));
     const configs = [{ ignores: [...defaultIgnores, ...ignores] }];
     if (markup) {
-        if (NODE_MAJOR < 24) {
+        if (!supportsMarkup) {
             throw new Error('@1stg/eslint-config: `markup` requires Node.js >= 24 (eslint-plugin-markup@2)');
         }
         const markupPlugin = yield load('eslint-plugin-markup');
@@ -68,6 +79,7 @@ export const defineConfig = (...args_1) => __awaiter(void 0, [...args_1], void 0
     }
     if (code) {
         if (!isInstalled('typescript-eslint')) {
+            /* istanbul ignore next -- defensive guard for explicit code: true */
             throw new Error('@1stg/eslint-config: `code` requires the `typescript-eslint` package');
         }
         const tseslint = yield load('typescript-eslint');
@@ -81,10 +93,7 @@ export const defineConfig = (...args_1) => __awaiter(void 0, [...args_1], void 0
             configs.push(...toConfigs(regexp.configs['flat/recommended']).map(withCodeFiles));
         }
     }
-    if (oxlintEnabled) {
-        const oxlint = yield load('eslint-plugin-oxlint');
-        configs.push(...toConfigs(oxlint.configs['flat/all']));
-    }
+    configs.push(...toConfigs(oxlint.configs['flat/all']));
     if (markdown) {
         const mdx = yield load('eslint-plugin-mdx');
         configs.push(Object.assign(Object.assign({}, mdx.flat), { processor: mdx.createRemarkProcessor({ lintCodeBlocks: false }) }));
@@ -103,5 +112,5 @@ export const defineConfig = (...args_1) => __awaiter(void 0, [...args_1], void 0
     }
     return configs;
 });
-export default defineConfig();
-//# sourceMappingURL=index.js.map
+const config = defineConfig();
+export default config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1stg/eslint-config",
-  "version": "12.0.0",
+  "version": "12.0.2",
   "type": "module",
   "description": "Personal but Shareable ESLint Configuration for the files Oxlint cannot lint",
   "repository": "git+https://github.com/1stG/configs.git",

package/lib/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAEpC,MAAM,WAAW,mBAAmB;IAElC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB,KAAK,CAAC,EAAE,OAAO,CAAA;IAEf,IAAI,CAAC,EAAE,OAAO,CAAA;IAEd,IAAI,CAAC,EAAE,OAAO,CAAA;IAEd,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB,IAAI,CAAC,EAAE,OAAO,CAAA;IAEd,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB;AA6ED,eAAO,MAAM,YAAY,+GAStB,mBAAmB,KAAQ,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CA6EpD,CAAA"}

package/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AA8BA,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAE9D,MAAM,YAAY,GAAG,sCAAsC,CAAA;AAE3D,MAAM,eAAe,GAAG;IACtB,YAAY;IACZ,gBAAgB;IAChB,sBAAsB;IACtB,eAAe;IACf,aAAa;IACb,WAAW;IACX,gBAAgB;IAChB,YAAY;IACZ,WAAW;IACX,oBAAoB;IACpB,iBAAiB;IACjB,cAAc;IACd,sBAAsB;IACtB,mBAAmB;IACnB,sBAAsB;IACtB,UAAU;IACV,YAAY;IACZ,YAAY;IAEZ,YAAY;IACZ,UAAU;IACV,uCAAuC;IACvC,WAAW;CACZ,CAAA;AAKD,MAAM,SAAS,GAAG,CAAC,MAAuC,EAAmB,EAAE,CAC7E,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;AAE3C,MAAM,aAAa,GAAG,CAAC,MAAqB,EAAiB,EAAE,kBAAC,iCAC3D,MAAM,KACT,KAAK,QAAE,MAAM,CAAC,KAAK,mCAAI,CAAC,YAAY,CAAC,IACrC,GAAA,CAAA;AAEF,MAAM,WAAW,GAAG,CAAC,IAAY,EAAW,EAAE;IAC5C,IAAI,CAAC;QACH,OAAO,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;IAC3C,CAAC;eAAO,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC,CAAA;AAKD,MAAM,IAAI,GAAG,CAAU,IAAY,EAAc,EAAE;;IACjD,MAAM,GAAG,GAAG,CAAC,MAAM,MAAM,kCAAC,IAAI,QAAC,CAAwB,CAAA;IACvD,OAAO,OAAC,GAAG,CAAC,OAAO,mCAAI,GAAG,CAAM,CAAA;AAClC,CAAC,CAAA,CAAA;AAWD,MAAM,CAAC,MAAM,YAAY,GAAG,YAS2B,EAAE,mDATtB,EACjC,QAAQ,GAAG,IAAI,EACf,KAAK,EAAE,YAAY,GAAG,IAAI,EAC1B,IAAI,GAAG,WAAW,CAAC,mBAAmB,CAAC,EACvC,IAAI,EAAE,WAAW,GAAG,WAAW,CAAC,oBAAoB,CAAC,EACrD,MAAM,EAAE,aAAa,GAAG,IAAI,EAC5B,IAAI,GAAG,WAAW,CAAC,mBAAmB,CAAC,EACvC,MAAM,GAAG,UAAU,IAAI,EAAE,IAAI,WAAW,CAAC,sBAAsB,CAAC,EAChE,OAAO,GAAG,EAAE,GACb,GAAwB,EAAE;IACzB,MAAM,cAAc,GAAG,eAAe,CAAC,MAAM,CAC3C,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,OAAO,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,OAAO,KAAK,YAAY,CAAC,CACvF,CAAA;IAED,MAAM,OAAO,GAAoB,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,cAAc,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,CAAA;IAE/E,IAAI,MAAM,EAAE,CAAC;QACX,IAAI,UAAU,GAAG,EAAE,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CACb,+EAA+E,CAChF,CAAA;QACH,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAE5B,sBAAsB,CAAC,CAAA;QAC1B,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;IACpD,CAAC;IAED,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,EAAE,CAAC;YAEtC,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAA;QACzF,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAExB,mBAAmB,CAAC,CAAA;QACvB,OAAO,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAA;QAEhE,IAAI,WAAW,CAAC,uBAAuB,CAAC,EAAE,CAAC;YACzC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAgB,uBAAuB,CAAC,CAAA;YAClE,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAA;QAC5E,CAAC;QAED,IAAI,WAAW,CAAC,sBAAsB,CAAC,EAAE,CAAC;YACxC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAgB,sBAAsB,CAAC,CAAA;YAChE,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAA;QACnF,CAAC;IACH,CAAC;IAED,IAAI,aAAa,EAAE,CAAC;QAClB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAgB,sBAAsB,CAAC,CAAA;QAChE,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;IACxD,CAAC;IAED,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,GAAG,GAAG,MAAM,IAAI,CAAiB,mBAAmB,CAAC,CAAA;QAC3D,OAAO,CAAC,IAAI,iCACP,GAAG,CAAC,IAAI,KACX,SAAS,EAAE,GAAG,CAAC,qBAAqB,CAAC,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,IAC/D,CAAA;IACJ,CAAC;IAED,IAAI,YAAY,EAAE,CAAC;QACjB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAgB,qBAAqB,CAAC,CAAA;QAC9D,OAAO,CAAC,IAAI,CACV,GAAG,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC,EAC1D,GAAG,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAC7C,CAAA;IACH,CAAC;IAED,IAAI,IAAI,EAAE,CAAC;QACT,MAAM,GAAG,GAAG,MAAM,IAAI,CAAgB,mBAAmB,CAAC,CAAA;QAC1D,OAAO,CAAC,IAAI,CACV,GAAG,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,EAC7C,GAAG,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAC3C,CAAA;IACH,CAAC;IAED,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAgB,oBAAoB,CAAC,CAAA;QAC5D,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAA;IAC9D,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA,CAAA;AAED,eAAe,YAAY,EAAE,CAAA"}