@markuplint/ml-config 3.3.0 → 3.5.0

package/lib/merge-config.js

@@ -49,7 +49,7 @@ function mergeRule(a, b) {
             }
             return oB;
         }
-        const value = Array.isArray(oA.value) && Array.isArray(b) ? [...oA.value, oB] : oB;
+        const value = Array.isArray(oA.value) && Array.isArray(oB) ? [...oA.value, ...oB] : oB;
         const res = (0, utils_1.cleanOptions)({ ...oA, value });
         (0, utils_1.deleteUndefProp)(res);
         return res;
@@ -145,7 +145,7 @@ function mergeRules(a, b) {
         }
     }
     (0, utils_1.deleteUndefProp)(res);
-    return res;
+    return Object.freeze(res);
 }
 function optimizeRules(rules) {
     const res = {};

package/lib/types.d.ts

@@ -1,35 +1,43 @@
 import type { ParserOptions } from '@markuplint/ml-ast';
 import type { RegexSelector } from '@markuplint/selector';
 export type { RegexSelector } from '@markuplint/selector';
-export interface Config {
-    $schema?: string;
-    extends?: string | string[];
-    plugins?: (PluginConfig | string)[];
-    parser?: ParserConfig;
-    parserOptions?: ParserOptions;
-    specs?: SpecConfig;
-    excludeFiles?: string[];
-    pretenders?: Pretender[];
-    rules?: Rules;
-    nodeRules?: NodeRule[];
-    childNodeRules?: ChildNodeRule[];
-    overrides?: Record<string, Omit<Config, '$schema' | 'extends' | 'overrides'>>;
-}
+export type Config = {
+    readonly $schema?: string;
+    readonly extends?: string | readonly string[];
+    readonly plugins?: readonly (PluginConfig | string)[];
+    readonly parser?: ParserConfig;
+    readonly parserOptions?: ParserOptions;
+    readonly specs?: SpecConfig;
+    readonly excludeFiles?: readonly string[];
+    readonly pretenders?: readonly Pretender[];
+    readonly rules?: Rules;
+    readonly nodeRules?: readonly NodeRule[];
+    readonly childNodeRules?: readonly ChildNodeRule[];
+    readonly overrides?: Readonly<Record<string, OverrideConfig>>;
+};
+export type PrimitiveScalar = string | number | boolean;
+export type PlainData = Nullable<PrimitiveScalar> | readonly PlainData[] | {
+    readonly [key: string]: PlainData | any;
+};
+export type NonNullablePlainData = PrimitiveScalar | readonly NonNullablePlainData[] | {
+    readonly [key: string]: NonNullablePlainData;
+};
+export type OverrideConfig = Omit<Config, '$schema' | 'extends' | 'overrides'>;
 export type PluginConfig = {
-    name: string;
-    settings: Record<string, any>;
+    readonly name: string;
+    readonly settings: Readonly<Record<string, NonNullablePlainData>>;
+};
+export type ParserConfig = {
+    readonly [extensionPattern: string]: string;
 };
-export interface ParserConfig {
-    [extensionPattern: string]: string;
-}
 export type SpecConfig = {
-    [extensionPattern: string]: string;
+    readonly [extensionPattern: string]: string;
 };
 export type Pretender = {
     /**
      * Target node selectors
      */
-    selector: string;
+    readonly selector: string;
     /**
      * If it is a string, it is resolved as an element name.
      * An element has the same attributes as the pretended custom element
@@ -37,43 +45,43 @@ export type Pretender = {
      *
      * If it is an Object, It creates the element by that.
      */
-    as: string | OriginalNode;
+    readonly as: string | OriginalNode;
 };
 export type OriginalNode = {
     /**
      * Element name
      */
-    element: string;
+    readonly element: string;
     /**
      * Namespace
      *
      * Supports `"svg"` and `undefined` only.
      * If it is `undefined`, the namespace is HTML.
      */
-    namespace?: 'svg';
+    readonly namespace?: 'svg';
     /**
      * Attributes
      */
-    attrs?: {
+    readonly attrs?: readonly {
         /**
          * Attribute name
          */
-        name: string;
+        readonly name: string;
         /**
          * If it omits this property, the attribute is resolved as a boolean.
          */
-        value?: string | {
-            fromAttr: string;
+        readonly value?: string | {
+            readonly fromAttr: string;
         };
     }[];
     /**
      * To have attributes the defined element has.
      */
-    inheritAttrs?: boolean;
+    readonly inheritAttrs?: boolean;
     /**
      * ARIA properties
      */
-    aria?: PretenderARIA;
+    readonly aria?: PretenderARIA;
 };
 /**
  * Pretender Node ARIA properties
@@ -85,94 +93,94 @@ export type PretenderARIA = {
      * - If it is `true`, it assumes the element has any text on its accessible name.
      * - If it specifies `fromAttr` property, it assumes the accessible name refers to the value of the attribute.
      */
-    name?: boolean | {
-        fromAttr: string;
+    readonly name?: boolean | {
+        readonly fromAttr: string;
     };
 };
-export type Rule<T extends RuleConfigValue, O = void> = RuleConfig<T, O> | T | boolean;
+export type Rule<T extends RuleConfigValue, O extends PlainData = undefined> = RuleConfig<T, O> | Readonly<T> | boolean;
 /**
  * @deprecated
  */
-export type RuleV2<T extends RuleConfigValue, O = void> = RuleConfigV2<T, O> | T | boolean;
-export type AnyRule = Rule<RuleConfigValue, unknown>;
+export type RuleV2<T extends RuleConfigValue, O extends PlainData = undefined> = RuleConfigV2<T, O> | Readonly<T> | boolean;
+export type AnyRule = Rule<RuleConfigValue, PlainData>;
 /**
  * @deprecated
  */
-export type AnyRuleV2 = RuleV2<RuleConfigValue, unknown>;
-export interface Rules {
-    [ruleName: string]: AnyRule;
-}
-export type RuleConfig<T extends RuleConfigValue, O = void> = {
-    severity?: Severity;
-    value?: T;
-    options?: O;
-    reason?: string;
+export type AnyRuleV2 = RuleV2<RuleConfigValue, PlainData>;
+export type Rules = {
+    readonly [ruleName: string]: AnyRule;
+};
+export type RuleConfig<T extends RuleConfigValue, O extends PlainData = undefined> = {
+    readonly severity?: Severity;
+    readonly value?: Readonly<T>;
+    readonly options?: Readonly<O>;
+    readonly reason?: string;
 };
 /**
  * @deprecated
  */
-export type RuleConfigV2<T extends RuleConfigValue, O = void> = {
-    severity?: Severity;
-    value?: T;
-    reason?: string;
+export type RuleConfigV2<T extends RuleConfigValue, O extends PlainData = undefined> = {
+    readonly severity?: Severity;
+    readonly value?: Readonly<T>;
+    readonly reason?: string;
     /**
      * Old property
      *
      * @deprecated
      * @see {this.options}
      */
-    option?: O;
+    readonly option?: Readonly<O>;
 };
 export type Severity = 'error' | 'warning' | 'info';
-export type RuleConfigValue = string | number | boolean | any[] | null;
-export interface NodeRule {
-    selector?: string;
-    regexSelector?: RegexSelector;
-    categories?: string[];
-    roles?: string[];
-    obsolete?: boolean;
-    rules?: Rules;
-}
-export interface ChildNodeRule {
-    selector?: string;
-    regexSelector?: RegexSelector;
-    inheritance?: boolean;
-    rules?: Rules;
-}
-export type Report<T extends RuleConfigValue, O = null> = Report1<T, O> | Report2 | (Report1<T, O> & Report2);
-export type Report1<T extends RuleConfigValue, O = null> = {
-    message: string;
-    scope: Scope<T, O>;
+export type RuleConfigValue = PrimitiveScalar | readonly (PrimitiveScalar | Readonly<Record<string, any>>)[] | null;
+export type NodeRule = {
+    readonly selector?: string;
+    readonly regexSelector?: RegexSelector;
+    readonly categories?: readonly string[];
+    readonly roles?: readonly string[];
+    readonly obsolete?: boolean;
+    readonly rules?: Rules;
+};
+export type ChildNodeRule = {
+    readonly selector?: string;
+    readonly regexSelector?: RegexSelector;
+    readonly inheritance?: boolean;
+    readonly rules?: Rules;
+};
+export type Report<T extends RuleConfigValue, O extends PlainData = undefined> = Report1<T, O> | Report2 | (Report1<T, O> & Report2);
+export type Report1<T extends RuleConfigValue, O extends PlainData = undefined> = {
+    readonly message: string;
+    readonly scope: Scope<T, O>;
 };
 export type Report2 = {
-    message: string;
-    line: number;
-    col: number;
-    raw: string;
-};
-export type Scope<T extends RuleConfigValue, O = null> = {
-    rule: RuleInfo<T, O>;
-    startLine: number;
-    startCol: number;
-    raw: string;
-};
-export interface Violation {
-    ruleId: string;
-    severity: Severity;
-    message: string;
-    reason?: string;
-    line: number;
-    col: number;
-    raw: string;
-}
-export interface RuleInfo<T extends RuleConfigValue, O = null> {
-    disabled: boolean;
-    severity: Severity;
-    value: T;
-    options: O;
-    reason?: string;
-}
-export type GlobalRuleInfo<T extends RuleConfigValue, O = null> = RuleInfo<T, O> & {
+    readonly message: string;
+    readonly line: number;
+    readonly col: number;
+    readonly raw: string;
+};
+export type Scope<T extends RuleConfigValue, O extends PlainData = undefined> = {
+    readonly rule: RuleInfo<T, O>;
+    readonly startLine: number;
+    readonly startCol: number;
+    readonly raw: string;
+};
+export type Violation = {
+    readonly ruleId: string;
+    readonly severity: Severity;
+    readonly message: string;
+    readonly reason?: string;
+    readonly line: number;
+    readonly col: number;
+    readonly raw: string;
+};
+export type RuleInfo<T extends RuleConfigValue, O extends PlainData = undefined> = {
+    readonly disabled: boolean;
+    readonly severity: Severity;
+    readonly value: Readonly<T>;
+    readonly options: Readonly<O>;
+    readonly reason?: string;
+};
+export type GlobalRuleInfo<T extends RuleConfigValue, O extends PlainData = undefined> = RuleInfo<T, O> & {
     nodeRules: RuleInfo<T, O>[];
     childNodeRules: RuleInfo<T, O>[];
 };

package/lib/utils.d.ts

@@ -1,4 +1,4 @@
-import type { AnyRule, AnyRuleV2, RuleConfig, RuleConfigV2, RuleConfigValue } from './types';
+import type { AnyRule, AnyRuleV2, PlainData, RuleConfig, RuleConfigV2, RuleConfigValue } from './types';
 /**
  * Return undefined if the template doesn't include the variable that is set as a property in data.
  * But return template string without changes if it doesn't have a variable.
@@ -6,9 +6,9 @@ import type { AnyRule, AnyRuleV2, RuleConfig, RuleConfigV2, RuleConfigValue } fr
  * @param template Mustache template string
  * @param data Captured string for replacement
  */
-export declare function provideValue(template: string, data: Record<string, string>): string | undefined;
-export declare function exchangeValueOnRule(rule: AnyRule | AnyRuleV2, data: Record<string, string>): AnyRule | undefined;
-export declare function cleanOptions(rule: RuleConfig<RuleConfigValue, unknown> | RuleConfigV2<RuleConfigValue, unknown>): RuleConfig<RuleConfigValue, unknown>;
+export declare function provideValue(template: string, data: Readonly<Record<string, string>>): string | undefined;
+export declare function exchangeValueOnRule(rule: AnyRule | AnyRuleV2, data: Readonly<Record<string, string>>): AnyRule | undefined;
+export declare function cleanOptions(rule: RuleConfig<RuleConfigValue, PlainData> | RuleConfigV2<RuleConfigValue, PlainData>): RuleConfig<RuleConfigValue, PlainData>;
 export declare function isRuleConfigValue(v: any): v is RuleConfigValue;
 /**
  *

package/lib/utils.js

@@ -12,8 +12,9 @@ const mustache_1 = tslib_1.__importDefault(require("mustache"));
  * @param data Captured string for replacement
  */
 function provideValue(template, data) {
+    var _a;
     const ast = mustache_1.default.parse(template);
-    if (ast.length === 1 && ast[0][0] === 'text') {
+    if (ast.length === 1 && ((_a = ast[0]) === null || _a === void 0 ? void 0 : _a[0]) === 'text') {
         // It doesn't have a variable
         return template;
     }
@@ -39,9 +40,14 @@ function exchangeValueOnRule(rule, data) {
     }
     const options = extractOptions(result);
     if (options) {
+        const newOptions = exchangeOption(options, data);
         result = {
             ...result,
-            options: exchangeOption(options, data),
+            ...(newOptions == null
+                ? undefined
+                : {
+                    options: newOptions,
+                }),
         };
     }
     if (result.reason != null) {
@@ -125,7 +131,7 @@ function exchangeValue(rule, data) {
             }
             return val;
         })
-            .filter(item => item !== undefined);
+            .filter((item) => item !== undefined);
         return ruleArray.length ? ruleArray : undefined;
     }
     return rule;
@@ -140,7 +146,7 @@ function exchangeOption(optionValue, data) {
     if (typeof optionValue === 'string') {
         return provideValue(optionValue, data);
     }
-    if (Array.isArray(optionValue)) {
+    if (isArray(optionValue)) {
         return optionValue.map(v => exchangeOption(v, data));
     }
     const result = {};
@@ -149,3 +155,16 @@ function exchangeOption(optionValue, data) {
     });
     return result;
 }
+/**
+ * Array.isArray for ReadonlyArray
+ *
+ * > Array.isArray type narrows to any[] for ReadonlyArray<T>
+ *
+ * @see https://github.com/microsoft/TypeScript/issues/17002
+ *
+ * @param value
+ * @returns
+ */
+function isArray(value) {
+    return Array.isArray(value);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-config",
-	"version": "3.3.0",
+	"version": "3.5.0",
 	"description": "JSON Schema and TypeScript types of markuplint configure JSON",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -19,14 +19,15 @@
 		"clean": "tsc --build --clean"
 	},
 	"devDependencies": {
-		"@markuplint/ml-ast": "3.0.0",
+		"@markuplint/ml-ast": "3.1.0",
 		"@types/mustache": "^4.2.2"
 	},
 	"dependencies": {
-		"@markuplint/selector": "3.3.0",
+		"@markuplint/selector": "3.5.0",
 		"deepmerge": "^4.2.2",
 		"is-plain-object": "^5.0.0",
-		"mustache": "^4.2.0"
+		"mustache": "^4.2.0",
+		"type-fest": "^3.6.1"
 	},
-	"gitHead": "791fb22a4df7acb985ced3808923fba0cd95c28a"
+	"gitHead": "0c47b2c2722f6823a17f36edbab98486275f8ab4"
 }