@markuplint/ml-config 3.3.0 → 3.4.0

package/lib/types.d.ts

@@ -2,92 +2,96 @@ 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'>>;
+	$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 PluginConfig = {
-    name: string;
-    settings: Record<string, any>;
+	name: string;
+	settings: Record<string, any>;
 };
 export interface ParserConfig {
-    [extensionPattern: string]: string;
+	[extensionPattern: string]: string;
 }
 export type SpecConfig = {
-    [extensionPattern: string]: string;
+	[extensionPattern: string]: string;
 };
 export type Pretender = {
-    /**
-     * Target node selectors
-     */
-    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
-     * because attributes are just inherited.
-     *
-     * If it is an Object, It creates the element by that.
-     */
-    as: string | OriginalNode;
+	/**
+	 * Target node selectors
+	 */
+	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
+	 * because attributes are just inherited.
+	 *
+	 * If it is an Object, It creates the element by that.
+	 */
+	as: string | OriginalNode;
 };
 export type OriginalNode = {
-    /**
-     * Element name
-     */
-    element: string;
-    /**
-     * Namespace
-     *
-     * Supports `"svg"` and `undefined` only.
-     * If it is `undefined`, the namespace is HTML.
-     */
-    namespace?: 'svg';
-    /**
-     * Attributes
-     */
-    attrs?: {
-        /**
-         * Attribute name
-         */
-        name: string;
-        /**
-         * If it omits this property, the attribute is resolved as a boolean.
-         */
-        value?: string | {
-            fromAttr: string;
-        };
-    }[];
-    /**
-     * To have attributes the defined element has.
-     */
-    inheritAttrs?: boolean;
-    /**
-     * ARIA properties
-     */
-    aria?: PretenderARIA;
+	/**
+	 * Element name
+	 */
+	element: string;
+	/**
+	 * Namespace
+	 *
+	 * Supports `"svg"` and `undefined` only.
+	 * If it is `undefined`, the namespace is HTML.
+	 */
+	namespace?: 'svg';
+	/**
+	 * Attributes
+	 */
+	attrs?: {
+		/**
+		 * Attribute name
+		 */
+		name: string;
+		/**
+		 * If it omits this property, the attribute is resolved as a boolean.
+		 */
+		value?:
+			| string
+			| {
+					fromAttr: string;
+			  };
+	}[];
+	/**
+	 * To have attributes the defined element has.
+	 */
+	inheritAttrs?: boolean;
+	/**
+	 * ARIA properties
+	 */
+	aria?: PretenderARIA;
 };
 /**
  * Pretender Node ARIA properties
  */
 export type PretenderARIA = {
-    /**
-     * Accessible name
-     *
-     * - 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;
-    };
+	/**
+	 * Accessible name
+	 *
+	 * - 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;
+		  };
 };
 export type Rule<T extends RuleConfigValue, O = void> = RuleConfig<T, O> | T | boolean;
 /**
@@ -100,80 +104,80 @@ export type AnyRule = Rule<RuleConfigValue, unknown>;
  */
 export type AnyRuleV2 = RuleV2<RuleConfigValue, unknown>;
 export interface Rules {
-    [ruleName: string]: AnyRule;
+	[ruleName: string]: AnyRule;
 }
 export type RuleConfig<T extends RuleConfigValue, O = void> = {
-    severity?: Severity;
-    value?: T;
-    options?: O;
-    reason?: string;
+	severity?: Severity;
+	value?: T;
+	options?: O;
+	reason?: string;
 };
 /**
  * @deprecated
  */
 export type RuleConfigV2<T extends RuleConfigValue, O = void> = {
-    severity?: Severity;
-    value?: T;
-    reason?: string;
-    /**
-     * Old property
-     *
-     * @deprecated
-     * @see {this.options}
-     */
-    option?: O;
+	severity?: Severity;
+	value?: T;
+	reason?: string;
+	/**
+	 * Old property
+	 *
+	 * @deprecated
+	 * @see {this.options}
+	 */
+	option?: 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;
+	selector?: string;
+	regexSelector?: RegexSelector;
+	categories?: string[];
+	roles?: string[];
+	obsolete?: boolean;
+	rules?: Rules;
 }
 export interface ChildNodeRule {
-    selector?: string;
-    regexSelector?: RegexSelector;
-    inheritance?: boolean;
-    rules?: Rules;
+	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>;
+	message: string;
+	scope: Scope<T, O>;
 };
 export type Report2 = {
-    message: string;
-    line: number;
-    col: number;
-    raw: string;
+	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;
+	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;
+	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;
+	disabled: boolean;
+	severity: Severity;
+	value: T;
+	options: O;
+	reason?: string;
 }
 export type GlobalRuleInfo<T extends RuleConfigValue, O = null> = RuleInfo<T, O> & {
-    nodeRules: RuleInfo<T, O>[];
-    childNodeRules: RuleInfo<T, O>[];
+	nodeRules: RuleInfo<T, O>[];
+	childNodeRules: RuleInfo<T, O>[];
 };
 export type Nullable<T> = T | null | undefined;

package/lib/utils.d.ts

@@ -7,8 +7,13 @@ import type { AnyRule, AnyRuleV2, RuleConfig, RuleConfigV2, RuleConfigValue } fr
  * @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 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 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;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-config",
-	"version": "3.3.0",
+	"version": "3.4.0",
 	"description": "JSON Schema and TypeScript types of markuplint configure JSON",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -23,10 +23,10 @@
 		"@types/mustache": "^4.2.2"
 	},
 	"dependencies": {
-		"@markuplint/selector": "3.3.0",
+		"@markuplint/selector": "3.4.0",
 		"deepmerge": "^4.2.2",
 		"is-plain-object": "^5.0.0",
 		"mustache": "^4.2.0"
 	},
-	"gitHead": "791fb22a4df7acb985ced3808923fba0cd95c28a"
+	"gitHead": "a83e0f5f214a9bbcc0286b9e269074ddca6189e7"
 }