@wtf/project-oxlint 1.0.0 → 1.1.1

package/README.md

@@ -5,9 +5,10 @@ suspicious and perf rules as warnings, and `import/no-cycle`, `eqeqeq` and
 `typescript/no-explicit-any` as errors. It leaves the build and a generated reference in
 `packages/docs/api` alone. oxlint is a peer dependency.
 
-| Subpath    | What you get                      |
-| ---------- | --------------------------------- |
-| `./config` | The config, as the default export |
+| Subpath    | What you get                                                                                            |
+| ---------- | ------------------------------------------------------------------------------------------------------- |
+| `./config` | The config, as the default export; `oxlintConfig(options)`, the config with options of your own over it |
+| `./schema` | `oxlintSchema`: the Standard Schema of the options of `oxlintConfig()`, which gives their JSON Schema   |
 
 ```ts
 // oxlint.config.ts
@@ -17,5 +18,37 @@ import { defineConfig } from 'oxlint'
 export default defineConfig({ extends: [preset] })
 ```
 
+`oxlintConfig(options)` gives the config with your options over it: `categories`, `rules` and
+`env` key by key over the preset's, and any other option, as `plugins` or `ignorePatterns`, in
+place of the preset's.
+
 Run it as `oxlint --deny-warnings`, so a warning fails the lint just as an error does. See the
-[presets guide](../docs/guides/presets.md).
+[presets guide](../project-docs/guides/presets.md).
+
+## From the wtf configuration
+
+The config reads no file of its own. Keep its options in the `oxlint` section of the repo's `wtf`
+configuration, load it with [`@wtf/project-config`](../project-config/README.md), and spread the
+section in, checked by `oxlintSchema`. oxlint imports `oxlint.config.ts`, so the config may await
+the load, and a `wtf.config.ts` is read too:
+
+```ts
+// oxlint.config.ts
+import { loadConfig } from '@wtf/project-config/node'
+import { sectionOf } from '@wtf/project-config/section'
+import { oxlintConfig } from '@wtf/project-oxlint/config'
+import { oxlintSchema } from '@wtf/project-oxlint/schema'
+import { defineConfig } from 'oxlint'
+
+const config = await loadConfig()
+export default defineConfig({
+  extends: [oxlintConfig({ ...(await sectionOf(config, 'oxlint', oxlintSchema)) })]
+})
+```
+
+```json
+{ "oxlint": { "rules": { "no-console": "error" }, "ignorePatterns": ["**/dist/**", "site/**"] } }
+```
+
+A key that starts with `//` is a comment, as `"//": "why"`: `oxlintSchema` takes it, at the top of
+the section, and leaves it out of the options it gives.

package/dist/config.d.ts

@@ -1,4 +1,22 @@
-declare const _default: {
+/**
+ * oxlint's shared config, which a repo's oxlint.config.ts extends: the typescript, unicorn and
+ * import plugins, correctness as errors, suspicious and perf as warnings, and `import/no-cycle`,
+ * `eqeqeq` and `typescript/no-explicit-any` as errors. Run it with `--deny-warnings`.
+ *
+ * The default export is the preset; {@link oxlintConfig} gives it with options of a repo's own
+ * over it, as a section of its configuration spread in (`oxlintSchema` of ./schema).
+ *
+ * @packageDocumentation
+ */
+import { type OxlintConfig } from 'oxlint';
+/**
+ * What {@link oxlintConfig} takes: any option of oxlint's config. `categories`, `rules` and `env`
+ * are laid over the preset's, key by key; each other option, as `plugins` or `ignorePatterns`,
+ * replaces the preset's.
+ */
+export type OxlintOptions = OxlintConfig;
+/** The preset's own options, which {@link oxlintConfig} lays a repo's over. */
+export declare const OXLINT_DEFAULTS: {
     plugins: ("unicorn" | "typescript" | "import")[];
     categories: {
         correctness: "error";
@@ -22,4 +40,19 @@ declare const _default: {
     };
     ignorePatterns: string[];
 };
+/**
+ * The preset with `options` over it: `categories`, `rules` and `env` key by key over the preset's,
+ * so a rule given is set and every other kept; and each other option in place of the preset's.
+ *
+ * ```ts
+ * // oxlint.config.ts
+ * import { oxlintConfig } from '@wtf/project-oxlint/config'
+ * import { defineConfig } from 'oxlint'
+ *
+ * export default defineConfig({ extends: [oxlintConfig({ rules: { 'no-console': 'error' } })] })
+ * ```
+ */
+export declare function oxlintConfig(options?: OxlintOptions): OxlintConfig;
+/** The preset, with no options of a repo's own: {@link oxlintConfig} of none. */
+declare const _default: OxlintConfig;
 export default _default;

package/dist/config.js

@@ -3,10 +3,14 @@
  * import plugins, correctness as errors, suspicious and perf as warnings, and `import/no-cycle`,
  * `eqeqeq` and `typescript/no-explicit-any` as errors. Run it with `--deny-warnings`.
  *
+ * The default export is the preset; {@link oxlintConfig} gives it with options of a repo's own
+ * over it, as a section of its configuration spread in (`oxlintSchema` of ./schema).
+ *
  * @packageDocumentation
  */
 import { defineConfig } from 'oxlint';
-export default defineConfig({
+/** The preset's own options, which {@link oxlintConfig} lays a repo's over. */
+export const OXLINT_DEFAULTS = {
     plugins: ['typescript', 'unicorn', 'import'],
     categories: {
         correctness: 'error',
@@ -23,5 +27,29 @@ export default defineConfig({
     },
     env: { es2025: true, node: true },
     ignorePatterns: ['**/dist/**', 'packages/docs/api/**']
-});
+};
+/**
+ * The preset with `options` over it: `categories`, `rules` and `env` key by key over the preset's,
+ * so a rule given is set and every other kept; and each other option in place of the preset's.
+ *
+ * ```ts
+ * // oxlint.config.ts
+ * import { oxlintConfig } from '@wtf/project-oxlint/config'
+ * import { defineConfig } from 'oxlint'
+ *
+ * export default defineConfig({ extends: [oxlintConfig({ rules: { 'no-console': 'error' } })] })
+ * ```
+ */
+export function oxlintConfig(options = {}) {
+    const { categories, rules, env, ...rest } = options;
+    return defineConfig({
+        ...OXLINT_DEFAULTS,
+        ...rest,
+        categories: { ...OXLINT_DEFAULTS.categories, ...categories },
+        rules: { ...OXLINT_DEFAULTS.rules, ...rules },
+        env: { ...OXLINT_DEFAULTS.env, ...env }
+    });
+}
+/** The preset, with no options of a repo's own: {@link oxlintConfig} of none. */
+export default oxlintConfig();
 //# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AAErC,eAAe,YAAY,CAAC;IAC1B,OAAO,EAAE,CAAC,YAAY,EAAE,SAAS,EAAE,QAAQ,CAAC;IAC5C,UAAU,EAAE;QACV,WAAW,EAAE,OAAO;QACpB,UAAU,EAAE,MAAM;QAClB,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,KAAK;KACb;IACD,KAAK,EAAE;QACL,iBAAiB,EAAE,OAAO;QAC1B,MAAM,EAAE,OAAO;QACf,4BAA4B,EAAE,OAAO;QACrC,2BAA2B,EAAE,CAAC,OAAO,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;KAC7F;IACD,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE;IACjC,cAAc,EAAE,CAAC,YAAY,EAAE,sBAAsB,CAAC;CACvD,CAAC,CAAA","sourcesContent":["/**\n * oxlint's shared config, which a repo's oxlint.config.ts extends: the typescript, unicorn and\n * import plugins, correctness as errors, suspicious and perf as warnings, and `import/no-cycle`,\n * `eqeqeq` and `typescript/no-explicit-any` as errors. Run it with `--deny-warnings`.\n *\n * @packageDocumentation\n */\nimport { defineConfig } from 'oxlint'\n\nexport default defineConfig({\n  plugins: ['typescript', 'unicorn', 'import'],\n  categories: {\n    correctness: 'error',\n    suspicious: 'warn',\n    pedantic: 'off',\n    perf: 'warn',\n    style: 'off'\n  },\n  rules: {\n    'import/no-cycle': 'error',\n    eqeqeq: 'error',\n    'typescript/no-explicit-any': 'error',\n    'typescript/no-unused-vars': ['error', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }]\n  },\n  env: { es2025: true, node: true },\n  ignorePatterns: ['**/dist/**', 'packages/docs/api/**']\n})\n"]}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,YAAY,EAAqB,MAAM,QAAQ,CAAA;AASxD,+EAA+E;AAC/E,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,OAAO,EAAE,CAAC,YAAY,EAAE,SAAS,EAAE,QAAQ,CAAC;IAC5C,UAAU,EAAE;QACV,WAAW,EAAE,OAAO;QACpB,UAAU,EAAE,MAAM;QAClB,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,KAAK;KACb;IACD,KAAK,EAAE;QACL,iBAAiB,EAAE,OAAO;QAC1B,MAAM,EAAE,OAAO;QACf,4BAA4B,EAAE,OAAO;QACrC,2BAA2B,EAAE,CAAC,OAAO,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;KAC7F;IACD,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE;IACjC,cAAc,EAAE,CAAC,YAAY,EAAE,sBAAsB,CAAC;CAChC,CAAA;AAExB;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAAC,UAAyB,EAAE;IACtD,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAA;IACnD,OAAO,YAAY,CAAC;QAClB,GAAG,eAAe;QAClB,GAAG,IAAI;QACP,UAAU,EAAE,EAAE,GAAG,eAAe,CAAC,UAAU,EAAE,GAAG,UAAU,EAAE;QAC5D,KAAK,EAAE,EAAE,GAAG,eAAe,CAAC,KAAK,EAAE,GAAG,KAAK,EAAE;QAC7C,GAAG,EAAE,EAAE,GAAG,eAAe,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE;KACxC,CAAC,CAAA;AACJ,CAAC;AAED,iFAAiF;AACjF,eAAe,YAAY,EAAE,CAAA","sourcesContent":["/**\n * oxlint's shared config, which a repo's oxlint.config.ts extends: the typescript, unicorn and\n * import plugins, correctness as errors, suspicious and perf as warnings, and `import/no-cycle`,\n * `eqeqeq` and `typescript/no-explicit-any` as errors. Run it with `--deny-warnings`.\n *\n * The default export is the preset; {@link oxlintConfig} gives it with options of a repo's own\n * over it, as a section of its configuration spread in (`oxlintSchema` of ./schema).\n *\n * @packageDocumentation\n */\nimport { defineConfig, type OxlintConfig } from 'oxlint'\n\n/**\n * What {@link oxlintConfig} takes: any option of oxlint's config. `categories`, `rules` and `env`\n * are laid over the preset's, key by key; each other option, as `plugins` or `ignorePatterns`,\n * replaces the preset's.\n */\nexport type OxlintOptions = OxlintConfig\n\n/** The preset's own options, which {@link oxlintConfig} lays a repo's over. */\nexport const OXLINT_DEFAULTS = {\n  plugins: ['typescript', 'unicorn', 'import'],\n  categories: {\n    correctness: 'error',\n    suspicious: 'warn',\n    pedantic: 'off',\n    perf: 'warn',\n    style: 'off'\n  },\n  rules: {\n    'import/no-cycle': 'error',\n    eqeqeq: 'error',\n    'typescript/no-explicit-any': 'error',\n    'typescript/no-unused-vars': ['error', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }]\n  },\n  env: { es2025: true, node: true },\n  ignorePatterns: ['**/dist/**', 'packages/docs/api/**']\n} satisfies OxlintConfig\n\n/**\n * The preset with `options` over it: `categories`, `rules` and `env` key by key over the preset's,\n * so a rule given is set and every other kept; and each other option in place of the preset's.\n *\n * ```ts\n * // oxlint.config.ts\n * import { oxlintConfig } from '@wtf/project-oxlint/config'\n * import { defineConfig } from 'oxlint'\n *\n * export default defineConfig({ extends: [oxlintConfig({ rules: { 'no-console': 'error' } })] })\n * ```\n */\nexport function oxlintConfig(options: OxlintOptions = {}): OxlintConfig {\n  const { categories, rules, env, ...rest } = options\n  return defineConfig({\n    ...OXLINT_DEFAULTS,\n    ...rest,\n    categories: { ...OXLINT_DEFAULTS.categories, ...categories },\n    rules: { ...OXLINT_DEFAULTS.rules, ...rules },\n    env: { ...OXLINT_DEFAULTS.env, ...env }\n  })\n}\n\n/** The preset, with no options of a repo's own: {@link oxlintConfig} of none. */\nexport default oxlintConfig()\n"]}

package/dist/schema.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The schema of the options of `oxlintConfig()` of ./config: {@link oxlintSchema}, a Standard
+ * Schema that checks them and gives their JSON Schema, so a repo can keep them in its
+ * configuration, as the `oxlint` section of `wtf.config.json`, check them, and spread them into
+ * `oxlintConfig()`. oxlint imports an oxlint.config.ts, so the config can await the load, of a code
+ * config too.
+ *
+ * ```ts
+ * // oxlint.config.ts
+ * import { loadConfig } from '@wtf/project-config/node'
+ * import { sectionOf } from '@wtf/project-config/section'
+ * import { oxlintConfig } from '@wtf/project-oxlint/config'
+ * import { oxlintSchema } from '@wtf/project-oxlint/schema'
+ * import { defineConfig } from 'oxlint'
+ *
+ * const config = await loadConfig()
+ * export default defineConfig({
+ *   extends: [oxlintConfig({ ...(await sectionOf(config, 'oxlint', oxlintSchema)) })]
+ * })
+ * ```
+ *
+ * @packageDocumentation
+ */
+import type { StandardJSONSchemaV1, StandardSchemaV1 } from '@standard-schema/spec';
+import type { OxlintOptions } from './config.ts';
+/**
+ * The schema of the options of `oxlintConfig()` of ./config: oxlint's config, of its `plugins`,
+ * `categories`, `rules`, `env` and `ignorePatterns` checked, and any other option of oxlint.
+ */
+export declare const oxlintSchema: StandardSchemaV1<OxlintOptions> & StandardJSONSchemaV1<OxlintOptions>;

package/dist/schema.js

@@ -0,0 +1,45 @@
+import { optionsSchema } from "./standard.js";
+/** A rule's or a category's severity, as oxlint takes it. */
+const severity = {
+    description: 'a severity: off, warn, error, allow or deny, or 0, 1 or 2',
+    anyOf: [{ enum: ['off', 'warn', 'error', 'allow', 'deny'] }, { enum: [0, 1, 2] }]
+};
+/** The JSON Schema of the options of {@link oxlintSchema}: the preset's, and oxlint's own. */
+const json = {
+    type: 'object',
+    properties: {
+        plugins: {
+            description: 'The plugins, in place of the preset’s.',
+            type: 'array',
+            items: { type: 'string' }
+        },
+        categories: {
+            description: 'The severity of each category, over the preset’s.',
+            type: 'object',
+            additionalProperties: severity
+        },
+        rules: {
+            description: 'Each rule, by its severity or a list of it and its options, over the preset’s.',
+            type: 'object',
+            additionalProperties: { anyOf: [severity, { type: 'array' }] }
+        },
+        env: {
+            description: 'The environments, each on or off, over the preset’s.',
+            type: 'object',
+            additionalProperties: { type: 'boolean' }
+        },
+        ignorePatterns: {
+            description: 'The paths left alone, in place of the preset’s.',
+            type: 'array',
+            items: { type: 'string' }
+        }
+    },
+    // Each other option is oxlint's, which oxlint checks itself.
+    additionalProperties: true
+};
+/**
+ * The schema of the options of `oxlintConfig()` of ./config: oxlint's config, of its `plugins`,
+ * `categories`, `rules`, `env` and `ignorePatterns` checked, and any other option of oxlint.
+ */
+export const oxlintSchema = optionsSchema('@wtf/project-oxlint', json);
+//# sourceMappingURL=schema.js.map

package/dist/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAmB,aAAa,EAAE,MAAM,eAAe,CAAA;AAE9D,6DAA6D;AAC7D,MAAM,QAAQ,GAAe;IAC3B,WAAW,EAAE,2DAA2D;IACxE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;CAClF,CAAA;AAED,8FAA8F;AAC9F,MAAM,IAAI,GAAe;IACvB,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,OAAO,EAAE;YACP,WAAW,EAAE,wCAAwC;YACrD,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC1B;QACD,UAAU,EAAE;YACV,WAAW,EAAE,mDAAmD;YAChE,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,QAAQ;SAC/B;QACD,KAAK,EAAE;YACL,WAAW,EAAE,gFAAgF;YAC7F,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,EAAE,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE;SAC/D;QACD,GAAG,EAAE;YACH,WAAW,EAAE,sDAAsD;YACnE,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;SAC1C;QACD,cAAc,EAAE;YACd,WAAW,EAAE,iDAAiD;YAC9D,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC1B;KACF;IACD,6DAA6D;IAC7D,oBAAoB,EAAE,IAAI;CAC3B,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GACvB,aAAa,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAA","sourcesContent":["/**\n * The schema of the options of `oxlintConfig()` of ./config: {@link oxlintSchema}, a Standard\n * Schema that checks them and gives their JSON Schema, so a repo can keep them in its\n * configuration, as the `oxlint` section of `wtf.config.json`, check them, and spread them into\n * `oxlintConfig()`. oxlint imports an oxlint.config.ts, so the config can await the load, of a code\n * config too.\n *\n * ```ts\n * // oxlint.config.ts\n * import { loadConfig } from '@wtf/project-config/node'\n * import { sectionOf } from '@wtf/project-config/section'\n * import { oxlintConfig } from '@wtf/project-oxlint/config'\n * import { oxlintSchema } from '@wtf/project-oxlint/schema'\n * import { defineConfig } from 'oxlint'\n *\n * const config = await loadConfig()\n * export default defineConfig({\n *   extends: [oxlintConfig({ ...(await sectionOf(config, 'oxlint', oxlintSchema)) })]\n * })\n * ```\n *\n * @packageDocumentation\n */\nimport type { StandardJSONSchemaV1, StandardSchemaV1 } from '@standard-schema/spec'\nimport type { OxlintOptions } from './config.ts'\nimport { type JsonSchema, optionsSchema } from './standard.ts'\n\n/** A rule's or a category's severity, as oxlint takes it. */\nconst severity: JsonSchema = {\n  description: 'a severity: off, warn, error, allow or deny, or 0, 1 or 2',\n  anyOf: [{ enum: ['off', 'warn', 'error', 'allow', 'deny'] }, { enum: [0, 1, 2] }]\n}\n\n/** The JSON Schema of the options of {@link oxlintSchema}: the preset's, and oxlint's own. */\nconst json: JsonSchema = {\n  type: 'object',\n  properties: {\n    plugins: {\n      description: 'The plugins, in place of the preset’s.',\n      type: 'array',\n      items: { type: 'string' }\n    },\n    categories: {\n      description: 'The severity of each category, over the preset’s.',\n      type: 'object',\n      additionalProperties: severity\n    },\n    rules: {\n      description: 'Each rule, by its severity or a list of it and its options, over the preset’s.',\n      type: 'object',\n      additionalProperties: { anyOf: [severity, { type: 'array' }] }\n    },\n    env: {\n      description: 'The environments, each on or off, over the preset’s.',\n      type: 'object',\n      additionalProperties: { type: 'boolean' }\n    },\n    ignorePatterns: {\n      description: 'The paths left alone, in place of the preset’s.',\n      type: 'array',\n      items: { type: 'string' }\n    }\n  },\n  // Each other option is oxlint's, which oxlint checks itself.\n  additionalProperties: true\n}\n\n/**\n * The schema of the options of `oxlintConfig()` of ./config: oxlint's config, of its `plugins`,\n * `categories`, `rules`, `env` and `ignorePatterns` checked, and any other option of oxlint.\n */\nexport const oxlintSchema: StandardSchemaV1<OxlintOptions> & StandardJSONSchemaV1<OxlintOptions> =\n  optionsSchema('@wtf/project-oxlint', json)\n"]}

package/dist/standard.d.ts

@@ -0,0 +1,31 @@
+import type { StandardJSONSchemaV1, StandardSchemaV1 } from '@standard-schema/spec';
+/**
+ * A JSON Schema of the keywords the check knows: the `type` of a value, its `const` or `enum`, a
+ * number's `minimum`, a string's `pattern`, a list's `items`, an object's `properties`,
+ * `patternProperties` and `additionalProperties`, and `anyOf`; a `description` says what a value
+ * is. A schema of no keyword takes any value, as a function a code config gives.
+ */
+export type JsonSchema = {
+    readonly type?: string | readonly string[];
+    readonly const?: unknown;
+    readonly enum?: readonly unknown[];
+    readonly minimum?: number;
+    readonly pattern?: string;
+    readonly items?: JsonSchema;
+    readonly properties?: Readonly<Record<string, JsonSchema>>;
+    readonly patternProperties?: Readonly<Record<string, JsonSchema>>;
+    readonly additionalProperties?: boolean | JsonSchema;
+    readonly anyOf?: readonly JsonSchema[];
+    readonly description?: string;
+};
+/** The schema of the options `T`: a Standard Schema that checks them, and gives their JSON Schema. */
+export type OptionsSchema<T> = StandardSchemaV1<T> & StandardJSONSchemaV1<T>;
+/**
+ * The schema of the options `T` of a preset, `vendor`, of their JSON Schema `json`: it checks a
+ * value by the keywords of `json`, as {@link JsonSchema} has them, and gives `json`, of draft
+ * 2020-12, as the JSON Schema of its input and of its output alike. A key that starts with `//` is
+ * a comment, of the options and of each object in them that takes no key but its `properties`, and
+ * the JSON Schema takes it by `patternProperties`: the check takes it, and leaves it out of the
+ * value it gives, as it leaves each value else as it is.
+ */
+export declare function optionsSchema<T>(vendor: string, json: JsonSchema): OptionsSchema<T>;

package/dist/standard.js

@@ -0,0 +1,142 @@
+/** The draft of the JSON Schema an options schema gives. */
+const DRAFT = 'https://json-schema.org/draft/2020-12/schema';
+const isObject = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+/** The pattern of the key of a comment, of `patternProperties`: a key that starts with `//`. */
+const COMMENT = '^//';
+/** Whether `key` is the key of a comment. */
+const isComment = (key) => key.startsWith('//');
+/** Whether `schema` is of an object, of the keys it names or of any. */
+const isObjectSchema = (schema) => schema.properties !== undefined ||
+    schema.patternProperties !== undefined ||
+    schema.additionalProperties !== undefined;
+/**
+ * The schema of the value of `key` of an object of `schema`: of its `properties`, else of the
+ * first of its `patternProperties` that `key` matches, else its `additionalProperties`, else any.
+ */
+const propertyOf = (schema, key) => schema.properties?.[key] ??
+    Object.entries(schema.patternProperties ?? {}).find(([pattern]) => new RegExp(pattern, 'u').test(key))?.[1] ??
+    schema.additionalProperties ??
+    true;
+/** The type of `value`, as a JSON Schema names it, and `function` of a function. */
+const typeOf = (value) => value === null
+    ? 'null'
+    : Array.isArray(value)
+        ? 'array'
+        : Number.isInteger(value)
+            ? 'integer'
+            : typeof value;
+/** Whether `value` is of one of the `types`: an integer is a number. */
+const isOfType = (value, types) => {
+    const type = typeOf(value);
+    return [types].flat().some((each) => each === type || (each === 'number' && type === 'integer'));
+};
+/** What is wrong with `value` of `schema`, at `path`. */
+function issuesOf(value, schema, path) {
+    const issue = (message) => [{ message, path }];
+    if (schema.anyOf !== undefined && !schema.anyOf.some((each) => check(value, each).length === 0))
+        return issue(schema.description === undefined ? 'is none of its forms' : `is no ${schema.description}`);
+    if ('const' in schema && value !== schema.const)
+        return issue(`is not ${JSON.stringify(schema.const)}`);
+    if (schema.enum !== undefined && !schema.enum.includes(value))
+        return issue(`is none of ${schema.enum.map((each) => JSON.stringify(each)).join(', ')}`);
+    if (schema.type !== undefined && !isOfType(value, schema.type))
+        return issue(`is no ${[schema.type].flat().join(' or ')}`);
+    if (typeof value === 'number' && schema.minimum !== undefined && value < schema.minimum)
+        return issue(`is less than ${schema.minimum}`);
+    if (typeof value === 'string' &&
+        schema.pattern !== undefined &&
+        !new RegExp(schema.pattern, 'u').test(value))
+        return issue(`does not match ${schema.pattern}`);
+    if (Array.isArray(value) && schema.items !== undefined) {
+        const items = schema.items;
+        return value.flatMap((item, index) => issuesOf(item, items, [...path, index]));
+    }
+    if (isObject(value) && isObjectSchema(schema))
+        return Object.entries(value).flatMap(([key, item]) => {
+            const property = propertyOf(schema, key);
+            if (property === true)
+                return [];
+            if (property === false)
+                return [{ message: 'is no option it takes', path: [...path, key] }];
+            return issuesOf(item, property, [...path, key]);
+        });
+    return [];
+}
+/** What is wrong with `value` of `schema`, none when it is valid. */
+const check = (value, schema) => issuesOf(value, schema, []);
+/**
+ * `schema` with a comment taken by each object of options in it, by `patternProperties` of
+ * {@link COMMENT}: the options themselves, at the `top`, whatever keys they take, and each object
+ * in them that takes no key but its `properties`. A map, of a schema of `additionalProperties`,
+ * takes each key as one of its own.
+ */
+function withComments(schema, top) {
+    const { properties, items, additionalProperties, anyOf } = schema;
+    const takes = top ? isObjectSchema(schema) : additionalProperties === false;
+    return {
+        ...schema,
+        ...(properties !== undefined && {
+            properties: Object.fromEntries(Object.entries(properties).map(([key, each]) => [key, withComments(each, false)]))
+        }),
+        ...(items !== undefined && { items: withComments(items, false) }),
+        ...(typeof additionalProperties === 'object' && {
+            additionalProperties: withComments(additionalProperties, false)
+        }),
+        ...(anyOf !== undefined && { anyOf: anyOf.map((each) => withComments(each, top)) }),
+        ...(takes && {
+            patternProperties: {
+                ...schema.patternProperties,
+                [COMMENT]: { description: 'A comment, which the options leave out.' }
+            }
+        })
+    };
+}
+/**
+ * `value`, valid of `schema`, without its comments: each key of a comment of an object whose schema
+ * takes them by {@link COMMENT}, and its `properties` do not name. A value of none is itself.
+ */
+function withoutComments(value, schema) {
+    const form = schema.anyOf?.find((each) => check(value, each).length === 0);
+    const read = form === undefined ? value : withoutComments(value, form);
+    const { items } = schema;
+    if (Array.isArray(read) && items !== undefined) {
+        const each = read.map((item) => withoutComments(item, items));
+        return each.every((item, index) => item === read[index]) ? read : each;
+    }
+    if (!isObject(read) || !isObjectSchema(schema))
+        return read;
+    const takes = schema.patternProperties?.[COMMENT] !== undefined;
+    const entries = Object.entries(read).flatMap(([key, item]) => {
+        if (takes && isComment(key) && schema.properties?.[key] === undefined)
+            return [];
+        const property = propertyOf(schema, key);
+        return [[key, typeof property === 'object' ? withoutComments(item, property) : item]];
+    });
+    const same = entries.length === Object.keys(read).length &&
+        entries.every(([key, item]) => item === read[key]);
+    return same ? read : Object.fromEntries(entries);
+}
+/**
+ * The schema of the options `T` of a preset, `vendor`, of their JSON Schema `json`: it checks a
+ * value by the keywords of `json`, as {@link JsonSchema} has them, and gives `json`, of draft
+ * 2020-12, as the JSON Schema of its input and of its output alike. A key that starts with `//` is
+ * a comment, of the options and of each object in them that takes no key but its `properties`, and
+ * the JSON Schema takes it by `patternProperties`: the check takes it, and leaves it out of the
+ * value it gives, as it leaves each value else as it is.
+ */
+export function optionsSchema(vendor, json) {
+    const schema = withComments(json, true);
+    const jsonSchema = () => ({ $schema: DRAFT, ...schema });
+    return {
+        '~standard': {
+            version: 1,
+            vendor,
+            validate: (value) => {
+                const issues = check(value, schema);
+                return issues.length === 0 ? { value: withoutComments(value, schema) } : { issues };
+            },
+            jsonSchema: { input: jsonSchema, output: jsonSchema }
+        }
+    };
+}
+//# sourceMappingURL=standard.js.map

package/dist/standard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"standard.js","sourceRoot":"","sources":["../src/standard.ts"],"names":[],"mappings":"AAiCA,4DAA4D;AAC5D,MAAM,KAAK,GAAG,8CAA8C,CAAA;AAK5D,MAAM,QAAQ,GAAG,CAAC,KAAc,EAA8C,EAAE,CAC9E,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAEtE,gGAAgG;AAChG,MAAM,OAAO,GAAG,KAAK,CAAA;AAErB,6CAA6C;AAC7C,MAAM,SAAS,GAAG,CAAC,GAAW,EAAW,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;AAEhE,wEAAwE;AACxE,MAAM,cAAc,GAAG,CAAC,MAAkB,EAAW,EAAE,CACrD,MAAM,CAAC,UAAU,KAAK,SAAS;IAC/B,MAAM,CAAC,iBAAiB,KAAK,SAAS;IACtC,MAAM,CAAC,oBAAoB,KAAK,SAAS,CAAA;AAE3C;;;GAGG;AACH,MAAM,UAAU,GAAG,CAAC,MAAkB,EAAE,GAAW,EAAwB,EAAE,CAC3E,MAAM,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC;IACxB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,CAChE,IAAI,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CACnC,EAAE,CAAC,CAAC,CAAC;IACN,MAAM,CAAC,oBAAoB;IAC3B,IAAI,CAAA;AAEN,oFAAoF;AACpF,MAAM,MAAM,GAAG,CAAC,KAAc,EAAU,EAAE,CACxC,KAAK,KAAK,IAAI;IACZ,CAAC,CAAC,MAAM;IACR,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACpB,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC;YACvB,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,OAAO,KAAK,CAAA;AAEtB,wEAAwE;AACxE,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAE,KAAiC,EAAW,EAAE;IAC9E,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;IAC1B,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,SAAS,CAAC,CAAC,CAAA;AAClG,CAAC,CAAA;AAED,yDAAyD;AACzD,SAAS,QAAQ,CAAC,KAAc,EAAE,MAAkB,EAAE,IAAU;IAC9D,MAAM,KAAK,GAAG,CAAC,OAAe,EAAW,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;IAC/D,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;QAC7F,OAAO,KAAK,CACV,MAAM,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,WAAW,EAAE,CAC1F,CAAA;IACH,IAAI,OAAO,IAAI,MAAM,IAAI,KAAK,KAAK,MAAM,CAAC,KAAK;QAC7C,OAAO,KAAK,CAAC,UAAU,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IACxD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC3D,OAAO,KAAK,CAAC,cAAc,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC1F,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC;QAC5D,OAAO,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IAC5D,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,GAAG,MAAM,CAAC,OAAO;QACrF,OAAO,KAAK,CAAC,gBAAgB,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;IAChD,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,MAAM,CAAC,OAAO,KAAK,SAAS;QAC5B,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;QAE5C,OAAO,KAAK,CAAC,kBAAkB,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;IAClD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACvD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;QAC1B,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,IAAa,EAAE,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;IACzF,CAAC;IACD,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,cAAc,CAAC,MAAM,CAAC;QAC3C,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE;YACnD,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;YACxC,IAAI,QAAQ,KAAK,IAAI;gBAAE,OAAO,EAAE,CAAA;YAChC,IAAI,QAAQ,KAAK,KAAK;gBAAE,OAAO,CAAC,EAAE,OAAO,EAAE,uBAAuB,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,CAAA;YAC3F,OAAO,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC,CAAA;QACjD,CAAC,CAAC,CAAA;IACJ,OAAO,EAAE,CAAA;AACX,CAAC;AAED,qEAAqE;AACrE,MAAM,KAAK,GAAG,CAAC,KAAc,EAAE,MAAkB,EAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,CAAA;AAE1F;;;;;GAKG;AACH,SAAS,YAAY,CAAC,MAAkB,EAAE,GAAY;IACpD,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,oBAAoB,EAAE,KAAK,EAAE,GAAG,MAAM,CAAA;IACjE,MAAM,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,oBAAoB,KAAK,KAAK,CAAA;IAC3E,OAAO;QACL,GAAG,MAAM;QACT,GAAG,CAAC,UAAU,KAAK,SAAS,IAAI;YAC9B,UAAU,EAAE,MAAM,CAAC,WAAW,CAC5B,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAClF;SACF,CAAC;QACF,GAAG,CAAC,KAAK,KAAK,SAAS,IAAI,EAAE,KAAK,EAAE,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;QACjE,GAAG,CAAC,OAAO,oBAAoB,KAAK,QAAQ,IAAI;YAC9C,oBAAoB,EAAE,YAAY,CAAC,oBAAoB,EAAE,KAAK,CAAC;SAChE,CAAC;QACF,GAAG,CAAC,KAAK,KAAK,SAAS,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;QACnF,GAAG,CAAC,KAAK,IAAI;YACX,iBAAiB,EAAE;gBACjB,GAAG,MAAM,CAAC,iBAAiB;gBAC3B,CAAC,OAAO,CAAC,EAAE,EAAE,WAAW,EAAE,yCAAyC,EAAE;aACtE;SACF,CAAC;KACH,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe,CAAC,KAAc,EAAE,MAAkB;IACzD,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAA;IAC1E,MAAM,IAAI,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IACtE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAA;IACxB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC/C,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,IAAa,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAA;QACtE,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAA;IACxE,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;QAAE,OAAO,IAAI,CAAA;IAC3D,MAAM,KAAK,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC,KAAK,SAAS,CAAA;IAC/D,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,EAAuB,EAAE;QAChF,IAAI,KAAK,IAAI,SAAS,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,KAAK,SAAS;YAAE,OAAO,EAAE,CAAA;QAChF,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QACxC,OAAO,CAAC,CAAC,GAAG,EAAE,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;IACvF,CAAC,CAAC,CAAA;IACF,MAAM,IAAI,GACR,OAAO,CAAC,MAAM,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM;QAC3C,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;IACpD,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;AAClD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAI,MAAc,EAAE,IAAgB;IAC/D,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IACvC,MAAM,UAAU,GAAG,GAA4B,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,EAAE,CAAC,CAAA;IACjF,OAAO;QACL,WAAW,EAAE;YACX,OAAO,EAAE,CAAC;YACV,MAAM;YACN,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;gBAClB,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;gBACnC,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,KAAK,EAAE,MAAM,CAAM,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAA;YAC1F,CAAC;YACD,UAAU,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE;SACtD;KACF,CAAA;AACH,CAAC","sourcesContent":["// The Standard Schema of a preset's options, of their JSON Schema: `optionsSchema` gives an object\n// of the Standard Schema and Standard JSON Schema interfaces of `@standard-schema/spec`, which checks\n// a value by the keywords of the JSON Schema it is written in, and gives that JSON Schema, so a\n// config of the options can be checked, and an editor completes it. The same file is in each\n// preset, which depends on no package of a schema (test/workspace.test.ts holds the copies alike).\n// A key that starts with `//`, of the options or of an object of options in them, is a comment: the\n// check takes it, and leaves it out of the value it gives.\n// Internal: no export map entry names it.\nimport type { StandardJSONSchemaV1, StandardSchemaV1 } from '@standard-schema/spec'\n\n/**\n * A JSON Schema of the keywords the check knows: the `type` of a value, its `const` or `enum`, a\n * number's `minimum`, a string's `pattern`, a list's `items`, an object's `properties`,\n * `patternProperties` and `additionalProperties`, and `anyOf`; a `description` says what a value\n * is. A schema of no keyword takes any value, as a function a code config gives.\n */\nexport type JsonSchema = {\n  readonly type?: string | readonly string[]\n  readonly const?: unknown\n  readonly enum?: readonly unknown[]\n  readonly minimum?: number\n  readonly pattern?: string\n  readonly items?: JsonSchema\n  readonly properties?: Readonly<Record<string, JsonSchema>>\n  readonly patternProperties?: Readonly<Record<string, JsonSchema>>\n  readonly additionalProperties?: boolean | JsonSchema\n  readonly anyOf?: readonly JsonSchema[]\n  readonly description?: string\n}\n\n/** The schema of the options `T`: a Standard Schema that checks them, and gives their JSON Schema. */\nexport type OptionsSchema<T> = StandardSchemaV1<T> & StandardJSONSchemaV1<T>\n\n/** The draft of the JSON Schema an options schema gives. */\nconst DRAFT = 'https://json-schema.org/draft/2020-12/schema'\n\ntype Issue = StandardSchemaV1.Issue\ntype Path = readonly PropertyKey[]\n\nconst isObject = (value: unknown): value is Readonly<Record<string, unknown>> =>\n  typeof value === 'object' && value !== null && !Array.isArray(value)\n\n/** The pattern of the key of a comment, of `patternProperties`: a key that starts with `//`. */\nconst COMMENT = '^//'\n\n/** Whether `key` is the key of a comment. */\nconst isComment = (key: string): boolean => key.startsWith('//')\n\n/** Whether `schema` is of an object, of the keys it names or of any. */\nconst isObjectSchema = (schema: JsonSchema): boolean =>\n  schema.properties !== undefined ||\n  schema.patternProperties !== undefined ||\n  schema.additionalProperties !== undefined\n\n/**\n * The schema of the value of `key` of an object of `schema`: of its `properties`, else of the\n * first of its `patternProperties` that `key` matches, else its `additionalProperties`, else any.\n */\nconst propertyOf = (schema: JsonSchema, key: string): JsonSchema | boolean =>\n  schema.properties?.[key] ??\n  Object.entries(schema.patternProperties ?? {}).find(([pattern]) =>\n    new RegExp(pattern, 'u').test(key)\n  )?.[1] ??\n  schema.additionalProperties ??\n  true\n\n/** The type of `value`, as a JSON Schema names it, and `function` of a function. */\nconst typeOf = (value: unknown): string =>\n  value === null\n    ? 'null'\n    : Array.isArray(value)\n      ? 'array'\n      : Number.isInteger(value)\n        ? 'integer'\n        : typeof value\n\n/** Whether `value` is of one of the `types`: an integer is a number. */\nconst isOfType = (value: unknown, types: string | readonly string[]): boolean => {\n  const type = typeOf(value)\n  return [types].flat().some((each) => each === type || (each === 'number' && type === 'integer'))\n}\n\n/** What is wrong with `value` of `schema`, at `path`. */\nfunction issuesOf(value: unknown, schema: JsonSchema, path: Path): Issue[] {\n  const issue = (message: string): Issue[] => [{ message, path }]\n  if (schema.anyOf !== undefined && !schema.anyOf.some((each) => check(value, each).length === 0))\n    return issue(\n      schema.description === undefined ? 'is none of its forms' : `is no ${schema.description}`\n    )\n  if ('const' in schema && value !== schema.const)\n    return issue(`is not ${JSON.stringify(schema.const)}`)\n  if (schema.enum !== undefined && !schema.enum.includes(value))\n    return issue(`is none of ${schema.enum.map((each) => JSON.stringify(each)).join(', ')}`)\n  if (schema.type !== undefined && !isOfType(value, schema.type))\n    return issue(`is no ${[schema.type].flat().join(' or ')}`)\n  if (typeof value === 'number' && schema.minimum !== undefined && value < schema.minimum)\n    return issue(`is less than ${schema.minimum}`)\n  if (\n    typeof value === 'string' &&\n    schema.pattern !== undefined &&\n    !new RegExp(schema.pattern, 'u').test(value)\n  )\n    return issue(`does not match ${schema.pattern}`)\n  if (Array.isArray(value) && schema.items !== undefined) {\n    const items = schema.items\n    return value.flatMap((item: unknown, index) => issuesOf(item, items, [...path, index]))\n  }\n  if (isObject(value) && isObjectSchema(schema))\n    return Object.entries(value).flatMap(([key, item]) => {\n      const property = propertyOf(schema, key)\n      if (property === true) return []\n      if (property === false) return [{ message: 'is no option it takes', path: [...path, key] }]\n      return issuesOf(item, property, [...path, key])\n    })\n  return []\n}\n\n/** What is wrong with `value` of `schema`, none when it is valid. */\nconst check = (value: unknown, schema: JsonSchema): Issue[] => issuesOf(value, schema, [])\n\n/**\n * `schema` with a comment taken by each object of options in it, by `patternProperties` of\n * {@link COMMENT}: the options themselves, at the `top`, whatever keys they take, and each object\n * in them that takes no key but its `properties`. A map, of a schema of `additionalProperties`,\n * takes each key as one of its own.\n */\nfunction withComments(schema: JsonSchema, top: boolean): JsonSchema {\n  const { properties, items, additionalProperties, anyOf } = schema\n  const takes = top ? isObjectSchema(schema) : additionalProperties === false\n  return {\n    ...schema,\n    ...(properties !== undefined && {\n      properties: Object.fromEntries(\n        Object.entries(properties).map(([key, each]) => [key, withComments(each, false)])\n      )\n    }),\n    ...(items !== undefined && { items: withComments(items, false) }),\n    ...(typeof additionalProperties === 'object' && {\n      additionalProperties: withComments(additionalProperties, false)\n    }),\n    ...(anyOf !== undefined && { anyOf: anyOf.map((each) => withComments(each, top)) }),\n    ...(takes && {\n      patternProperties: {\n        ...schema.patternProperties,\n        [COMMENT]: { description: 'A comment, which the options leave out.' }\n      }\n    })\n  }\n}\n\n/**\n * `value`, valid of `schema`, without its comments: each key of a comment of an object whose schema\n * takes them by {@link COMMENT}, and its `properties` do not name. A value of none is itself.\n */\nfunction withoutComments(value: unknown, schema: JsonSchema): unknown {\n  const form = schema.anyOf?.find((each) => check(value, each).length === 0)\n  const read = form === undefined ? value : withoutComments(value, form)\n  const { items } = schema\n  if (Array.isArray(read) && items !== undefined) {\n    const each = read.map((item: unknown) => withoutComments(item, items))\n    return each.every((item, index) => item === read[index]) ? read : each\n  }\n  if (!isObject(read) || !isObjectSchema(schema)) return read\n  const takes = schema.patternProperties?.[COMMENT] !== undefined\n  const entries = Object.entries(read).flatMap(([key, item]): [string, unknown][] => {\n    if (takes && isComment(key) && schema.properties?.[key] === undefined) return []\n    const property = propertyOf(schema, key)\n    return [[key, typeof property === 'object' ? withoutComments(item, property) : item]]\n  })\n  const same =\n    entries.length === Object.keys(read).length &&\n    entries.every(([key, item]) => item === read[key])\n  return same ? read : Object.fromEntries(entries)\n}\n\n/**\n * The schema of the options `T` of a preset, `vendor`, of their JSON Schema `json`: it checks a\n * value by the keywords of `json`, as {@link JsonSchema} has them, and gives `json`, of draft\n * 2020-12, as the JSON Schema of its input and of its output alike. A key that starts with `//` is\n * a comment, of the options and of each object in them that takes no key but its `properties`, and\n * the JSON Schema takes it by `patternProperties`: the check takes it, and leaves it out of the\n * value it gives, as it leaves each value else as it is.\n */\nexport function optionsSchema<T>(vendor: string, json: JsonSchema): OptionsSchema<T> {\n  const schema = withComments(json, true)\n  const jsonSchema = (): Record<string, unknown> => ({ $schema: DRAFT, ...schema })\n  return {\n    '~standard': {\n      version: 1,\n      vendor,\n      validate: (value) => {\n        const issues = check(value, schema)\n        return issues.length === 0 ? { value: withoutComments(value, schema) as T } : { issues }\n      },\n      jsonSchema: { input: jsonSchema, output: jsonSchema }\n    }\n  }\n}\n"]}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@wtf/project-oxlint",
-  "version": "1.0.0",
-  "description": "The shared oxlint config (./config): the typescript, unicorn and import plugins, correctness rules as errors, suspicious and perf rules as warnings, and import cycles, loose equality and explicit any as errors.",
-  "homepage": "https://gitlab.com/wetryfun/project/project/-/tree/main/packages/oxlint",
+  "version": "1.1.1",
+  "description": "The shared oxlint config (./config): the typescript, unicorn and import plugins, correctness rules as errors, suspicious and perf rules as warnings, and import cycles, loose equality and explicit any as errors. oxlintConfig(options) gives it with a repo's options over it; the schema of those (./schema), oxlintSchema, a Standard Schema that gives their JSON Schema, checks the oxlint section of a repo's configuration before it spreads it in.",
+  "homepage": "https://gitlab.com/wetryfun/project/project/-/tree/main/packages/project-oxlint",
   "bugs": {
     "url": "https://gitlab.com/wetryfun/project/project/-/issues"
   },
@@ -11,7 +11,7 @@
   "repository": {
     "type": "git",
     "url": "git+https://gitlab.com/wetryfun/project/project.git",
-    "directory": "packages/oxlint"
+    "directory": "packages/project-oxlint"
   },
   "files": [
     "dist"
@@ -21,6 +21,10 @@
     "./config": {
       "types": "./dist/config.d.ts",
       "default": "./dist/config.js"
+    },
+    "./schema": {
+      "types": "./dist/schema.d.ts",
+      "default": "./dist/schema.js"
     }
   },
   "publishConfig": {
@@ -29,6 +33,9 @@
   "scripts": {
     "build": "tsc -b"
   },
+  "dependencies": {
+    "@standard-schema/spec": "^1.1.0"
+  },
   "peerDependencies": {
     "oxlint": "^1.0.0"
   },