@markuplint/ml-config 2.0.0 → 2.0.1-dev.20220307.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/types.d.ts CHANGED
@@ -1,27 +1,27 @@
1
1
  export interface Config {
2
- $schema?: string;
3
- extends?: string | string[];
4
- plugins?: (PluginConfig | string)[];
5
- parser?: ParserConfig;
6
- parserOptions?: ParserOptions;
7
- specs?: SpecConfig | SpecConfig_v1;
8
- excludeFiles?: string[];
9
- rules?: Rules;
10
- nodeRules?: NodeRule[];
11
- childNodeRules?: ChildNodeRule[];
2
+ $schema?: string;
3
+ extends?: string | string[];
4
+ plugins?: (PluginConfig | string)[];
5
+ parser?: ParserConfig;
6
+ parserOptions?: ParserOptions;
7
+ specs?: SpecConfig | SpecConfig_v1;
8
+ excludeFiles?: string[];
9
+ rules?: Rules;
10
+ nodeRules?: NodeRule[];
11
+ childNodeRules?: ChildNodeRule[];
12
12
  }
13
13
  export declare type PluginConfig = {
14
- name: string;
15
- settings: Record<string, any>;
14
+ name: string;
15
+ settings: Record<string, any>;
16
16
  };
17
17
  export interface ParserConfig {
18
- [extensionPattern: string]: string;
18
+ [extensionPattern: string]: string;
19
19
  }
20
20
  export declare type ParserOptions = {
21
- ignoreFrontMatter?: boolean;
21
+ ignoreFrontMatter?: boolean;
22
22
  };
23
23
  export declare type SpecConfig = {
24
- [extensionPattern: string]: string;
24
+ [extensionPattern: string]: string;
25
25
  };
26
26
  /**
27
27
  * @deprecated
@@ -30,84 +30,84 @@ export declare type SpecConfig_v1 = string | string[];
30
30
  export declare type Rule<T extends RuleConfigValue, O = void> = RuleConfig<T, O> | T | boolean;
31
31
  export declare type AnyRule = Rule<RuleConfigValue, unknown>;
32
32
  export interface Rules {
33
- [ruleName: string]: AnyRule;
33
+ [ruleName: string]: AnyRule;
34
34
  }
35
35
  export declare type RuleConfig<T extends RuleConfigValue, O = void> = {
36
- severity?: Severity;
37
- value?: T;
38
- option?: O;
39
- reason?: string;
36
+ severity?: Severity;
37
+ value?: T;
38
+ option?: O;
39
+ reason?: string;
40
40
  };
41
41
  export declare type Severity = 'error' | 'warning' | 'info';
42
42
  export declare type RuleConfigValue = string | number | boolean | any[] | null;
43
43
  export interface NodeRule {
44
- /**
45
- * @deprecated
46
- */
47
- tagName?: string;
48
- selector?: string;
49
- regexSelector?: RegexSelector;
50
- categories?: string[];
51
- roles?: string[];
52
- obsolete?: boolean;
53
- rules?: Rules;
44
+ /**
45
+ * @deprecated
46
+ */
47
+ tagName?: string;
48
+ selector?: string;
49
+ regexSelector?: RegexSelector;
50
+ categories?: string[];
51
+ roles?: string[];
52
+ obsolete?: boolean;
53
+ rules?: Rules;
54
54
  }
55
55
  export interface ChildNodeRule {
56
- /**
57
- * @deprecated
58
- */
59
- tagName?: string;
60
- selector?: string;
61
- regexSelector?: RegexSelector;
62
- inheritance?: boolean;
63
- rules?: Rules;
56
+ /**
57
+ * @deprecated
58
+ */
59
+ tagName?: string;
60
+ selector?: string;
61
+ regexSelector?: RegexSelector;
62
+ inheritance?: boolean;
63
+ rules?: Rules;
64
64
  }
65
65
  export declare type RegexSelector = RegexSelectorWithoutCompination & {
66
- combination?: {
67
- combinator: RegexSelectorCombinator;
68
- } & RegexSelector;
66
+ combination?: {
67
+ combinator: RegexSelectorCombinator;
68
+ } & RegexSelector;
69
69
  };
70
70
  export declare type RegexSelectorCombinator = ' ' | '>' | '+' | '~' | ':has(+)' | ':has(~)';
71
71
  export declare type RegexSelectorWithoutCompination = {
72
- nodeName?: string;
73
- attrName?: string;
74
- attrValue?: string;
72
+ nodeName?: string;
73
+ attrName?: string;
74
+ attrValue?: string;
75
75
  };
76
76
  export declare type Report<T extends RuleConfigValue, O = null> = Report1<T, O> | Report2 | (Report1<T, O> & Report2);
77
77
  export declare type Report1<T extends RuleConfigValue, O = null> = {
78
- message: string;
79
- scope: Scope<T, O>;
78
+ message: string;
79
+ scope: Scope<T, O>;
80
80
  };
81
81
  export declare type Report2 = {
82
- message: string;
83
- line: number;
84
- col: number;
85
- raw: string;
82
+ message: string;
83
+ line: number;
84
+ col: number;
85
+ raw: string;
86
86
  };
87
87
  export declare type Scope<T extends RuleConfigValue, O = null> = {
88
- rule: RuleInfo<T, O>;
89
- startLine: number;
90
- startCol: number;
91
- raw: string;
88
+ rule: RuleInfo<T, O>;
89
+ startLine: number;
90
+ startCol: number;
91
+ raw: string;
92
92
  };
93
93
  export interface Violation {
94
- ruleId: string;
95
- severity: Severity;
96
- message: string;
97
- reason?: string;
98
- line: number;
99
- col: number;
100
- raw: string;
94
+ ruleId: string;
95
+ severity: Severity;
96
+ message: string;
97
+ reason?: string;
98
+ line: number;
99
+ col: number;
100
+ raw: string;
101
101
  }
102
102
  export interface RuleInfo<T extends RuleConfigValue, O = null> {
103
- disabled: boolean;
104
- severity: Severity;
105
- value: T;
106
- option: O;
107
- reason?: string;
103
+ disabled: boolean;
104
+ severity: Severity;
105
+ value: T;
106
+ option: O;
107
+ reason?: string;
108
108
  }
109
109
  export declare type GlobalRuleInfo<T extends RuleConfigValue, O = null> = RuleInfo<T, O> & {
110
- nodeRules: RuleInfo<T, O>[];
111
- childNodeRules: RuleInfo<T, O>[];
110
+ nodeRules: RuleInfo<T, O>[];
111
+ childNodeRules: RuleInfo<T, O>[];
112
112
  };
113
113
  export declare type Nullable<T> = T | null | undefined;
package/lib/utils.d.ts CHANGED
@@ -1,10 +1,7 @@
1
1
  import type { AnyRule } from './types';
2
2
  export declare function toRegxp(pattern: string): string | RegExp;
3
- export declare function regexSelectorMatches(
4
- reg: string,
5
- raw: string,
6
- ): {
7
- [x: string]: string;
3
+ export declare function regexSelectorMatches(reg: string, raw: string): {
4
+ [x: string]: string;
8
5
  } | null;
9
6
  /**
10
7
  * Return undefined if the template doesn't include the variable that is set as a property in data.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@markuplint/ml-config",
3
- "version": "2.0.0",
3
+ "version": "2.0.1-dev.20220307.0",
4
4
  "description": "JSON Schema and TypeScript types of markuplint configure JSON",
5
5
  "repository": "git@github.com:markuplint/markuplint.git",
6
6
  "author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -23,5 +23,5 @@
23
23
  "is-plain-object": "^5.0.0",
24
24
  "mustache": "^4.2.0"
25
25
  },
26
- "gitHead": "de81fc514acdf472f87184e3499e9364258f9b66"
26
+ "gitHead": "c0a9d36c32ae278bd2fdb9ec9434fd4af46918c3"
27
27
  }