@markuplint/ml-config 4.6.2 → 4.7.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.7.0](https://github.com/markuplint/markuplint/compare/@markuplint/ml-config@4.6.2...@markuplint/ml-config@4.7.0) (2024-05-28)
+
+### Features
+
+- **ml-config:** `pretenders` field accepts new structure ([3f9f5e8](https://github.com/markuplint/markuplint/commit/3f9f5e8ffdb7fa2526e842559b871ec6414de190))
+- **ml-config:** add test for merging `pretenders` structure ([fac00d7](https://github.com/markuplint/markuplint/commit/fac00d7ce4c709757097b8ce8c2e40813af0461c))
+- **ml-config:** improve merging for new `pretenders` structure ([fa7d990](https://github.com/markuplint/markuplint/commit/fa7d990c91e7843f6928fd48dc1ff41b7b446402))
+
 ## [4.6.2](https://github.com/markuplint/markuplint/compare/@markuplint/ml-config@4.6.1...@markuplint/ml-config@4.6.2) (2024-05-12)
 
 **Note:** Version bump only for package @markuplint/ml-config

package/lib/merge-config.d.ts

@@ -1,4 +1,4 @@
-import type { Config, AnyRule, AnyRuleV2 } from './types.js';
+import type { Config, AnyRule, AnyRuleV2, OptimizedConfig } from './types.js';
 import type { Nullable } from '@markuplint/shared';
-export declare function mergeConfig(a: Config, b: Config): Config;
+export declare function mergeConfig(a: Config, b?: Config): OptimizedConfig;
 export declare function mergeRule(a: Nullable<AnyRule | AnyRuleV2>, b: AnyRule | AnyRuleV2): AnyRule;

package/lib/merge-config.js

@@ -1,24 +1,37 @@
 import deepmerge from 'deepmerge';
 import { deleteUndefProp, cleanOptions, isRuleConfigValue } from './utils.js';
 export function mergeConfig(a, b) {
+    const deleteExtendsProp = !!b;
+    b = b ?? {};
     const config = {
         ...a,
         ...b,
-        plugins: concatArray(a.plugins, b.plugins, true, 'name'),
+        plugins: concatArray(a.plugins, b.plugins, true, 'name')?.map(plugin => {
+            if (typeof plugin === 'string') {
+                return {
+                    name: plugin,
+                };
+            }
+            return plugin;
+        }),
         parser: mergeObject(a.parser, b.parser),
         parserOptions: mergeObject(a.parserOptions, b.parserOptions),
         specs: mergeObject(a.specs, b.specs),
         excludeFiles: concatArray(a.excludeFiles, b.excludeFiles, true),
+        pretenders: mergePretenders(a.pretenders, b.pretenders),
         rules: mergeRules(
         // TODO: Deep merge
         a.rules, b.rules),
         nodeRules: concatArray(a.nodeRules, b.nodeRules),
         childNodeRules: concatArray(a.childNodeRules, b.childNodeRules),
         overrideMode: b.overrideMode ?? a.overrideMode,
-        overrides: mergeObject(a.overrides, b.overrides),
-        // delete all
-        extends: undefined,
+        overrides: mergeOverrides(a.overrides, b.overrides),
+        extends: concatArray(toReadonlyArray(a.extends), toReadonlyArray(b.extends)),
     };
+    if (deleteExtendsProp) {
+        // @ts-ignore
+        delete config.extends;
+    }
     deleteUndefProp(config);
     return config;
 }
@@ -62,6 +75,47 @@ export function mergeRule(a, b) {
     deleteUndefProp(res);
     return res;
 }
+function mergePretenders(a, b) {
+    if (!a && !b) {
+        return;
+    }
+    const aDetails = a ? convertPretenersToDetails(a) : undefined;
+    const bDetails = b ? convertPretenersToDetails(b) : undefined;
+    const details = mergeObject(aDetails, bDetails) ?? {};
+    deleteUndefProp(details);
+    return details;
+}
+function convertPretenersToDetails(pretenders) {
+    if (isReadonlyArray(pretenders)) {
+        return {
+            data: pretenders,
+        };
+    }
+    return pretenders;
+}
+function mergeOverrides(a = {}, b = {}) {
+    const keys = new Set();
+    for (const key of Object.keys(a))
+        keys.add(key);
+    for (const key of Object.keys(b))
+        keys.add(key);
+    if (keys.size === 0) {
+        return;
+    }
+    const result = {};
+    for (const key of keys) {
+        const config = mergeConfig(a[key] ?? {}, b[key] ?? {});
+        // @ts-ignore
+        delete config.$schema;
+        // @ts-ignore
+        delete config.extends;
+        // @ts-ignore
+        delete config.overrides;
+        deleteUndefProp(config);
+        result[key] = config;
+    }
+    return result;
+}
 function mergeObject(a, b) {
     if (a == null) {
         return b ?? undefined;
@@ -162,3 +216,23 @@ function optimizeRule(rule) {
     }
     return cleanOptions(rule);
 }
+function toReadonlyArray(value) {
+    if (value == null) {
+        return [];
+    }
+    return isReadonlyArray(value) ? value : [value];
+}
+/**
+ * Checks if a value is a readonly array.
+ *
+ * If the array is readonly, it passes the type check.
+ * However, it saves the type because using ESLint warns `@typescript-eslint/prefer-readonly-parameter-types`.
+ *
+ * @param value - The value to check.
+ * @returns `true` if the value is a readonly array, `false` otherwise.
+ * @template T - The type of elements in the array.
+ * @template X - The type of the value if it's not an array.
+ */
+function isReadonlyArray(value) {
+    return Array.isArray(value);
+}

package/lib/types.d.ts

@@ -10,7 +10,7 @@ export type Config = {
     readonly parserOptions?: ParserOptions;
     readonly specs?: SpecConfig;
     readonly excludeFiles?: readonly string[];
-    readonly pretenders?: readonly Pretender[];
+    readonly pretenders?: readonly Pretender[] | PretenderDetails;
     readonly rules?: Rules;
     readonly nodeRules?: readonly NodeRule[];
     readonly childNodeRules?: readonly ChildNodeRule[];
@@ -24,10 +24,18 @@ export type PlainData = Nullable<PrimitiveScalar> | readonly PlainData[] | {
 export type NonNullablePlainData = PrimitiveScalar | readonly NonNullablePlainData[] | {
     readonly [key: string]: NonNullablePlainData;
 };
-export type OverrideConfig = Omit<Config, '$schema' | 'extends' | 'overrideMode' | 'overrides'>;
+type NoInherit = '$schema' | 'extends' | 'overrideMode' | 'overrides';
+export type OverrideConfig = Omit<Config, NoInherit>;
+export type OptimizedConfig = Omit<Config, '$schema' | 'extends' | 'plugins' | 'pretenders' | 'overrides'> & {
+    readonly extends?: readonly string[];
+    readonly plugins?: readonly PluginConfig[];
+    readonly pretenders?: PretenderDetails;
+    readonly overrides?: Readonly<Record<string, OptimizedOverrideConfig>>;
+};
+export type OptimizedOverrideConfig = Omit<OptimizedConfig, NoInherit>;
 export type PluginConfig = {
     readonly name: string;
-    readonly settings: Readonly<Record<string, NonNullablePlainData>>;
+    readonly settings?: Readonly<Record<string, NonNullablePlainData>>;
 };
 export type ParserConfig = {
     readonly [extensionPattern: string]: string;
@@ -35,6 +43,17 @@ export type ParserConfig = {
 export type SpecConfig = {
     readonly [extensionPattern: string]: string;
 };
+export type PretenderDetails = {
+    /**
+     * @experimental
+     */
+    readonly files?: readonly string[];
+    /**
+     * @experimental
+     */
+    readonly imports?: readonly string[];
+    readonly data?: readonly Pretender[];
+};
 export type PretenderFileData = {
     readonly version: string;
     readonly data: readonly Pretender[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-config",
-	"version": "4.6.2",
+	"version": "4.7.0",
 	"description": "JSON Schema and TypeScript types of markuplint configure JSON",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -24,14 +24,14 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@markuplint/ml-ast": "4.3.1",
-		"@markuplint/selector": "4.6.2",
-		"@markuplint/shared": "4.4.0",
+		"@markuplint/ml-ast": "4.4.0",
+		"@markuplint/selector": "4.6.3",
+		"@markuplint/shared": "4.4.1",
 		"@types/mustache": "4.2.5",
 		"deepmerge": "4.3.1",
 		"is-plain-object": "5.0.0",
 		"mustache": "4.2.0",
-		"type-fest": "4.18.2"
+		"type-fest": "4.18.3"
 	},
-	"gitHead": "ca7dc6bf40eac4f2813e492878f889eb77751a70"
+	"gitHead": "bf70c41b1d2497e85b73c9ecd5551eb522e6bdfc"
 }