@markuplint/ml-core 3.0.0-canary.5 → 3.0.0-dev.176

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.
Files changed (74) hide show
  1. package/README.md +1 -1
  2. package/lib/configs.browser.d.ts +2 -0
  3. package/lib/configs.browser.js +12 -0
  4. package/lib/configs.js +1 -2
  5. package/lib/index.d.ts +11 -1
  6. package/lib/ml-core.d.ts +23 -12
  7. package/lib/ml-core.js +4 -4
  8. package/lib/ml-dom/helper/accname.js +18 -7
  9. package/lib/ml-dom/helper/create-node.d.ts +6 -2
  10. package/lib/ml-dom/helper/create-node.js +3 -1
  11. package/lib/ml-dom/helper/debug.js +9 -4
  12. package/lib/ml-dom/helper/getIndent.d.ts +7 -7
  13. package/lib/ml-dom/helper/getIndent.js +18 -12
  14. package/lib/ml-dom/helper/walkers.d.ts +15 -5
  15. package/lib/ml-dom/helper/walkers.js +22 -16
  16. package/lib/ml-dom/manipulations/child-node-methods.d.ts +20 -7
  17. package/lib/ml-dom/manipulations/child-node-methods.js +24 -6
  18. package/lib/ml-dom/manipulations/get-children.d.ts +4 -2
  19. package/lib/ml-dom/manipulations/get-children.js +3 -1
  20. package/lib/ml-dom/node/attr.d.ts +94 -91
  21. package/lib/ml-dom/node/attr.js +8 -4
  22. package/lib/ml-dom/node/block.d.ts +36 -32
  23. package/lib/ml-dom/node/block.js +14 -4
  24. package/lib/ml-dom/node/character-data.d.ts +60 -53
  25. package/lib/ml-dom/node/character-data.js +9 -3
  26. package/lib/ml-dom/node/child-node.d.ts +10 -3
  27. package/lib/ml-dom/node/child-node.js +3 -1
  28. package/lib/ml-dom/node/comment.d.ts +16 -13
  29. package/lib/ml-dom/node/document-fragment.d.ts +23 -20
  30. package/lib/ml-dom/node/document-type.d.ts +35 -32
  31. package/lib/ml-dom/node/document-type.js +14 -4
  32. package/lib/ml-dom/node/document.d.ts +1607 -1589
  33. package/lib/ml-dom/node/document.js +56 -19
  34. package/lib/ml-dom/node/dom-token-list.d.ts +26 -26
  35. package/lib/ml-dom/node/dom-token-list.js +9 -7
  36. package/lib/ml-dom/node/element.d.ts +1903 -1889
  37. package/lib/ml-dom/node/element.js +76 -27
  38. package/lib/ml-dom/node/named-node-map.d.ts +45 -40
  39. package/lib/ml-dom/node/named-node-map.js +13 -5
  40. package/lib/ml-dom/node/node-list.d.ts +10 -4
  41. package/lib/ml-dom/node/node-list.js +25 -5
  42. package/lib/ml-dom/node/node-store.d.ts +9 -4
  43. package/lib/ml-dom/node/node-store.js +19 -1
  44. package/lib/ml-dom/node/node.d.ts +493 -473
  45. package/lib/ml-dom/node/node.js +52 -19
  46. package/lib/ml-dom/node/parent-node.d.ts +67 -58
  47. package/lib/ml-dom/node/parent-node.js +15 -6
  48. package/lib/ml-dom/node/rule-mapper.d.ts +7 -7
  49. package/lib/ml-dom/node/rule-mapper.js +11 -3
  50. package/lib/ml-dom/node/text.d.ts +50 -47
  51. package/lib/ml-dom/node/types.d.ts +82 -14
  52. package/lib/ml-dom/node/unexpected-call-error.d.ts +1 -2
  53. package/lib/ml-dom/token/token.d.ts +44 -44
  54. package/lib/ml-rule/create-rule.d.ts +4 -2
  55. package/lib/ml-rule/create-test-rule.d.ts +6 -4
  56. package/lib/ml-rule/ml-rule-context.d.ts +58 -50
  57. package/lib/ml-rule/ml-rule-context.js +4 -2
  58. package/lib/ml-rule/ml-rule.d.ts +36 -26
  59. package/lib/ml-rule/ml-rule.js +37 -32
  60. package/lib/ml-rule/types.d.ts +35 -17
  61. package/lib/plugin/plugin.d.ts +3 -1
  62. package/lib/plugin/types.d.ts +7 -7
  63. package/lib/ruleset/index.d.ts +4 -4
  64. package/lib/ruleset/index.js +4 -4
  65. package/lib/test/index.d.ts +20 -8
  66. package/lib/test/index.js +1 -1
  67. package/lib/types.d.ts +9 -8
  68. package/lib/utils/get-location-from-chars.d.ts +9 -4
  69. package/package.json +21 -15
  70. package/test/ml-dom/helper/accname.spec.js +85 -0
  71. package/test/ml-dom/helper/create-node.spec.js +18 -0
  72. package/test/ml-dom/index.spec.js +680 -0
  73. package/tsconfig.test.json +0 -3
  74. package/tsconfig.tsbuildinfo +0 -1
package/README.md CHANGED
@@ -13,7 +13,7 @@
13
13
  <details>
14
14
  <summary>If you are installing purposely, how below:</summary>
15
15
 
16
- ```sh
16
+ ```shell
17
17
  $ npm install @markuplint/ml-core
18
18
 
19
19
  $ yarn add @markuplint/ml-core
@@ -0,0 +1,2 @@
1
+ import type { Config } from '@markuplint/ml-config';
2
+ export declare function getPreset(name: string): Promise<Config>;
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getPreset = void 0;
4
+ async function getPreset(name) {
5
+ const res = await fetch(`@markuplint/config-presets/preset.${name}.json`).catch(() => new Error());
6
+ if (res instanceof Error) {
7
+ throw new ReferenceError(`Preset markuplint:${name} is not found`);
8
+ }
9
+ const json = await res.json();
10
+ return json;
11
+ }
12
+ exports.getPreset = getPreset;
package/lib/configs.js CHANGED
@@ -22,11 +22,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
22
22
  __setModuleDefault(result, mod);
23
23
  return result;
24
24
  };
25
- var _a;
26
25
  Object.defineProperty(exports, "__esModule", { value: true });
27
26
  exports.getPreset = void 0;
28
27
  async function getPreset(name) {
29
- const json = await (_a = `@markuplint/config-presets/preset.${name}.json`, Promise.resolve().then(() => __importStar(require(_a)))).catch(() => new Error());
28
+ const json = await Promise.resolve(`${`@markuplint/config-presets/preset.${name}.json`}`).then(s => __importStar(require(s))).catch(() => new Error());
30
29
  if (json instanceof Error) {
31
30
  throw new ReferenceError(`Preset markuplint:${name} is not found`);
32
31
  }
package/lib/index.d.ts CHANGED
@@ -1,5 +1,15 @@
1
1
  export { RuleInfo, RuleConfig, RuleConfigValue } from '@markuplint/ml-config';
2
- export { ariaSpecs, contentModelCategoryToTagNames, getAttrSpecs, getComputedRole, getImplicitRole, getPermittedRoles, getRoleSpec, getSpec, resolveNamespace, } from '@markuplint/ml-spec';
2
+ export {
3
+ ariaSpecs,
4
+ contentModelCategoryToTagNames,
5
+ getAttrSpecs,
6
+ getComputedRole,
7
+ getImplicitRole,
8
+ getPermittedRoles,
9
+ getRoleSpec,
10
+ getSpec,
11
+ resolveNamespace,
12
+ } from '@markuplint/ml-spec';
3
13
  export { default as Ruleset } from './ruleset';
4
14
  export { enableDebug } from './debug';
5
15
  export { getIndent } from './ml-dom/helper/getIndent';
package/lib/ml-core.d.ts CHANGED
@@ -1,19 +1,30 @@
1
1
  import type { MLFabric } from './types';
2
- import type { RuleConfigValue, Violation } from '@markuplint/ml-config';
2
+ import type { PlainData, RuleConfigValue, Violation } from '@markuplint/ml-config';
3
3
  import { ParserError } from '@markuplint/parser-utils';
4
4
  import { Document } from './ml-dom';
5
5
  export type MLCoreParams = {
6
- sourceCode: string;
7
- filename: string;
8
- debug?: boolean;
6
+ readonly sourceCode: string;
7
+ readonly filename: string;
8
+ readonly debug?: boolean;
9
9
  } & MLFabric;
10
10
  export declare class MLCore {
11
- #private;
12
- constructor({ parser, sourceCode, ruleset, rules, locale, schemas, parserOptions, pretenders, filename, debug, }: MLCoreParams);
13
- get document(): ParserError | Document<RuleConfigValue, unknown>;
14
- setCode(sourceCode: string): void;
15
- update({ parser, ruleset, rules, locale, schemas, parserOptions }: Partial<MLFabric>): void;
16
- verify(fix?: boolean): Promise<Violation[]>;
17
- private _createDocument;
18
- private _parse;
11
+ #private;
12
+ constructor({
13
+ parser,
14
+ sourceCode,
15
+ ruleset,
16
+ rules,
17
+ locale,
18
+ schemas,
19
+ parserOptions,
20
+ pretenders,
21
+ filename,
22
+ debug,
23
+ }: MLCoreParams);
24
+ get document(): ParserError | Document<RuleConfigValue, PlainData>;
25
+ setCode(sourceCode: string): void;
26
+ update({ parser, ruleset, rules, locale, schemas, parserOptions }: Partial<MLFabric>): void;
27
+ verify(fix?: boolean): Promise<Violation[]>;
28
+ private _createDocument;
29
+ private _parse;
19
30
  }
package/lib/ml-core.js CHANGED
@@ -35,8 +35,8 @@ class MLCore {
35
35
  tslib_1.__classPrivateFieldSet(this, _MLCore_locale, locale, "f");
36
36
  tslib_1.__classPrivateFieldSet(this, _MLCore_schemas, schemas, "f");
37
37
  tslib_1.__classPrivateFieldSet(this, _MLCore_filename, filename, "f");
38
- tslib_1.__classPrivateFieldSet(this, _MLCore_rules, rules, "f");
39
- tslib_1.__classPrivateFieldSet(this, _MLCore_pretenders, pretenders, "f");
38
+ tslib_1.__classPrivateFieldSet(this, _MLCore_rules, rules.slice(), "f");
39
+ tslib_1.__classPrivateFieldSet(this, _MLCore_pretenders, pretenders.slice(), "f");
40
40
  this._parse();
41
41
  this._createDocument();
42
42
  }
@@ -49,14 +49,14 @@ class MLCore {
49
49
  this._createDocument();
50
50
  }
51
51
  update({ parser, ruleset, rules, locale, schemas, parserOptions }) {
52
- var _a, _b, _c;
52
+ var _a, _b, _c, _d;
53
53
  tslib_1.__classPrivateFieldSet(this, _MLCore_parser, parser !== null && parser !== void 0 ? parser : tslib_1.__classPrivateFieldGet(this, _MLCore_parser, "f"), "f");
54
54
  tslib_1.__classPrivateFieldSet(this, _MLCore_ruleset, {
55
55
  rules: (_a = ruleset === null || ruleset === void 0 ? void 0 : ruleset.rules) !== null && _a !== void 0 ? _a : tslib_1.__classPrivateFieldGet(this, _MLCore_ruleset, "f").rules,
56
56
  nodeRules: (_b = ruleset === null || ruleset === void 0 ? void 0 : ruleset.nodeRules) !== null && _b !== void 0 ? _b : tslib_1.__classPrivateFieldGet(this, _MLCore_ruleset, "f").nodeRules,
57
57
  childNodeRules: (_c = ruleset === null || ruleset === void 0 ? void 0 : ruleset.childNodeRules) !== null && _c !== void 0 ? _c : tslib_1.__classPrivateFieldGet(this, _MLCore_ruleset, "f").childNodeRules,
58
58
  }, "f");
59
- tslib_1.__classPrivateFieldSet(this, _MLCore_rules, rules !== null && rules !== void 0 ? rules : tslib_1.__classPrivateFieldGet(this, _MLCore_rules, "f"), "f");
59
+ tslib_1.__classPrivateFieldSet(this, _MLCore_rules, (_d = rules === null || rules === void 0 ? void 0 : rules.slice()) !== null && _d !== void 0 ? _d : tslib_1.__classPrivateFieldGet(this, _MLCore_rules, "f"), "f");
60
60
  tslib_1.__classPrivateFieldSet(this, _MLCore_locale, locale !== null && locale !== void 0 ? locale : tslib_1.__classPrivateFieldGet(this, _MLCore_locale, "f"), "f");
61
61
  tslib_1.__classPrivateFieldSet(this, _MLCore_schemas, schemas !== null && schemas !== void 0 ? schemas : tslib_1.__classPrivateFieldGet(this, _MLCore_schemas, "f"), "f");
62
62
  if (parserOptions &&
@@ -4,7 +4,9 @@ exports.getAccname = void 0;
4
4
  const ml_spec_1 = require("@markuplint/ml-spec");
5
5
  const debug_1 = require("../../debug");
6
6
  const accnameLog = debug_1.log.extend('accname');
7
- function getAccname(el, version) {
7
+ function getAccname(
8
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
9
+ el, version) {
8
10
  let accname = safeGet(el);
9
11
  if (accname) {
10
12
  return accname;
@@ -19,11 +21,12 @@ function getAccname(el, version) {
19
21
  if (isFromContent(el, version)) {
20
22
  return Array.from(el.childNodes)
21
23
  .map(child => {
24
+ var _a;
22
25
  if (child.is(child.ELEMENT_NODE)) {
23
26
  return getAccname(child, version);
24
27
  }
25
28
  if (child.is(child.TEXT_NODE)) {
26
- return child.textContent || '';
29
+ return (_a = child.textContent) !== null && _a !== void 0 ? _a : '';
27
30
  }
28
31
  return '';
29
32
  })
@@ -32,7 +35,9 @@ function getAccname(el, version) {
32
35
  return '';
33
36
  }
34
37
  exports.getAccname = getAccname;
35
- function safeGet(el) {
38
+ function safeGet(
39
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
40
+ el) {
36
41
  try {
37
42
  const name = (0, ml_spec_1.getAccname)(el);
38
43
  return name;
@@ -43,9 +48,11 @@ function safeGet(el) {
43
48
  return '';
44
49
  }
45
50
  }
46
- function getAccnameFromPretender(el) {
51
+ function getAccnameFromPretender(
52
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
53
+ el) {
47
54
  var _a, _b;
48
- if (((_a = el.pretenderContext) === null || _a === void 0 ? void 0 : _a.type) === 'pretender' && ((_b = el.pretenderContext.aria) === null || _b === void 0 ? void 0 : _b.name)) {
55
+ if (((_a = el.pretenderContext) === null || _a === void 0 ? void 0 : _a.type) === 'pretender' && ((_b = el.pretenderContext.aria) === null || _b === void 0 ? void 0 : _b.name) != null) {
49
56
  if (typeof el.pretenderContext.aria.name === 'boolean') {
50
57
  return 'some-name(Pretender Options)';
51
58
  }
@@ -57,10 +64,14 @@ function getAccnameFromPretender(el) {
57
64
  }
58
65
  return '';
59
66
  }
60
- function isHidden(el) {
67
+ function isHidden(
68
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
69
+ el) {
61
70
  return el.getAttribute('aria-hidden') === 'true' || el.hasAttribute('hidden');
62
71
  }
63
- function isFromContent(el, version) {
72
+ function isFromContent(
73
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
74
+ el, version) {
64
75
  var _a;
65
76
  const role = (0, ml_spec_1.getComputedRole)(el.ownerMLDocument.specs, el, version);
66
77
  return !!((_a = role.role) === null || _a === void 0 ? void 0 : _a.accessibleNameFromContent);
@@ -1,5 +1,9 @@
1
1
  import type { MLDocument } from '../node/document';
2
2
  import type { MappedNode } from '../node/types';
3
3
  import type { MLASTAbstractNode } from '@markuplint/ml-ast';
4
- import type { RuleConfigValue } from '@markuplint/ml-config';
5
- export declare function createNode<N extends MLASTAbstractNode, T extends RuleConfigValue, O = null>(astNode: N, document: MLDocument<T, O>): MappedNode<N, T, O>;
4
+ import type { PlainData, RuleConfigValue } from '@markuplint/ml-config';
5
+ export declare function createNode<
6
+ N extends MLASTAbstractNode,
7
+ T extends RuleConfigValue,
8
+ O extends PlainData = undefined,
9
+ >(astNode: N, document: MLDocument<T, O>): MappedNode<N, T, O>;
@@ -6,7 +6,9 @@ const comment_1 = require("../node/comment");
6
6
  const document_type_1 = require("../node/document-type");
7
7
  const element_1 = require("../node/element");
8
8
  const text_1 = require("../node/text");
9
- function createNode(astNode, document) {
9
+ function createNode(astNode,
10
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
11
+ document) {
10
12
  const _astNode = astNode;
11
13
  switch (_astNode.type) {
12
14
  case 'doctype': {
@@ -1,7 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.nodeListToDebugMaps = void 0;
4
- function nodeListToDebugMaps(nodeList, withAttr = false) {
4
+ function nodeListToDebugMaps(
5
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
6
+ nodeList, withAttr = false) {
5
7
  return nodeList
6
8
  .map(n => {
7
9
  const r = [];
@@ -13,7 +15,7 @@ function nodeListToDebugMaps(nodeList, withAttr = false) {
13
15
  if (n.is(n.ELEMENT_NODE)) {
14
16
  r.push(` namespaceURI: ${!!n.namespaceURI}`);
15
17
  r.push(` elementType: ${n.elementType}`);
16
- r.push(` isInFragmentDocument: ${!!n.isInFragmentDocument}`);
18
+ r.push(` isInFragmentDocument: ${n.isInFragmentDocument()}`);
17
19
  r.push(` isForeignElement: ${!!n.isForeignElement}`);
18
20
  if (withAttr) {
19
21
  r.push(...attributesToDebugMaps(n.attributes)
@@ -26,7 +28,9 @@ function nodeListToDebugMaps(nodeList, withAttr = false) {
26
28
  .flat();
27
29
  }
28
30
  exports.nodeListToDebugMaps = nodeListToDebugMaps;
29
- function attributesToDebugMaps(attributes) {
31
+ function attributesToDebugMaps(
32
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
33
+ attributes) {
30
34
  return attributes
31
35
  .map(n => {
32
36
  const r = [
@@ -77,7 +81,8 @@ function attributesToDebugMaps(attributes) {
77
81
  .flat();
78
82
  }
79
83
  function tokenDebug(n, type = '') {
80
- return `[${n.startLine}:${n.startCol}]>[${n.endLine}:${n.endCol}](${n.startOffset},${n.endOffset})${n.nodeName || n.potentialName || n.name || n.type || type}: ${visibleWhiteSpace(n.raw)}`;
84
+ var _a, _b, _c, _d;
85
+ return `[${n.startLine}:${n.startCol}]>[${n.endLine}:${n.endCol}](${n.startOffset},${n.endOffset})${(_d = (_c = (_b = (_a = n.nodeName) !== null && _a !== void 0 ? _a : n.potentialName) !== null && _b !== void 0 ? _b : n.name) !== null && _c !== void 0 ? _c : n.type) !== null && _d !== void 0 ? _d : type}: ${visibleWhiteSpace(n.raw)}`;
81
86
  }
82
87
  function visibleWhiteSpace(chars) {
83
88
  return chars.replace(/\n/g, '⏎').replace(/\t/g, '→').replace(/\s/g, '␣');
@@ -7,12 +7,12 @@ import type { MLText } from '../node/text';
7
7
  */
8
8
  export declare function getIndent(node: MLNode<any, any>): MLDOMIndentation | null;
9
9
  declare class MLDOMIndentation {
10
- #private;
11
- readonly line: number;
12
- constructor(originTextNode: MLText<any, any>, raw: string, line: number, parentNode: MLNode<any, any>);
13
- get raw(): string;
14
- get type(): 'tab' | 'space' | 'mixed' | 'none';
15
- get width(): number;
16
- fix(raw: string): void;
10
+ #private;
11
+ readonly line: number;
12
+ constructor(originTextNode: MLText<any, any>, raw: string, line: number, parentNode: MLNode<any, any>);
13
+ get raw(): string;
14
+ get type(): 'tab' | 'space' | 'mixed' | 'none';
15
+ get width(): number;
16
+ fix(raw: string): void;
17
17
  }
18
18
  export {};
@@ -8,7 +8,9 @@ const tslib_1 = require("tslib");
8
8
  * @deprecated
9
9
  * @param node
10
10
  */
11
- function getIndent(node) {
11
+ function getIndent(
12
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
13
+ node) {
12
14
  const prevToken = node.prevToken;
13
15
  if (!prevToken) {
14
16
  return null;
@@ -51,7 +53,11 @@ function getIndent(node) {
51
53
  }
52
54
  exports.getIndent = getIndent;
53
55
  class MLDOMIndentation {
54
- constructor(originTextNode, raw, line, parentNode) {
56
+ constructor(
57
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
58
+ originTextNode, raw, line,
59
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
60
+ parentNode) {
55
61
  _MLDOMIndentation_fixed.set(this, void 0);
56
62
  _MLDOMIndentation_node.set(this, void 0);
57
63
  _MLDOMIndentation_parent.set(this, void 0);
@@ -82,19 +88,19 @@ class MLDOMIndentation {
82
88
  fix(raw) {
83
89
  const current = tslib_1.__classPrivateFieldGet(this, _MLDOMIndentation_fixed, "f");
84
90
  tslib_1.__classPrivateFieldSet(this, _MLDOMIndentation_fixed, raw, "f");
85
- if (tslib_1.__classPrivateFieldGet(this, _MLDOMIndentation_node, "f")) {
86
- const node = tslib_1.__classPrivateFieldGet(this, _MLDOMIndentation_node, "f");
87
- const line = node.startLine;
88
- const lines = node.raw.split(/\r?\n/);
89
- const index = this.line - line;
90
- if (lines[index] != null) {
91
- lines[index] = lines[index].replace(current, tslib_1.__classPrivateFieldGet(this, _MLDOMIndentation_fixed, "f"));
92
- }
93
- node.fix(lines.join('\n'));
91
+ const node = tslib_1.__classPrivateFieldGet(this, _MLDOMIndentation_node, "f");
92
+ const line = node.startLine;
93
+ const lines = node.raw.split(/\r?\n/);
94
+ const index = this.line - line;
95
+ if (lines[index] != null) {
96
+ lines[index] = lines[index].replace(current, tslib_1.__classPrivateFieldGet(this, _MLDOMIndentation_fixed, "f"));
94
97
  }
98
+ node.fix(lines.join('\n'));
95
99
  }
96
100
  }
97
101
  _MLDOMIndentation_fixed = new WeakMap(), _MLDOMIndentation_node = new WeakMap(), _MLDOMIndentation_parent = new WeakMap();
98
- function isFirstToken(node) {
102
+ function isFirstToken(
103
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
104
+ node) {
99
105
  return !node.prevToken;
100
106
  }
@@ -1,6 +1,16 @@
1
1
  import type { MLNode } from '../node/node';
2
- import type { RuleConfigValue } from '@markuplint/ml-config';
3
- export type Walker<T extends RuleConfigValue, O = null, N = MLNode<T, O>> = (node: N) => void | Promise<void> | Promise<void>[];
4
- export type SyncWalker<T extends RuleConfigValue, O = null, N = MLNode<T, O>> = (node: N) => void;
5
- export declare function syncWalk<T extends RuleConfigValue, O = null>(nodeList: ReadonlyArray<MLNode<T, O>>, walker: SyncWalker<T, O>): void;
6
- export declare function sequentialWalker<T extends RuleConfigValue, O = null, N = MLNode<T, O>>(list: ReadonlyArray<N>, walker: Walker<T, O, N>): Promise<void>;
2
+ import type { PlainData, RuleConfigValue } from '@markuplint/ml-config';
3
+ export type Walker<T extends RuleConfigValue, O extends PlainData = undefined, N = MLNode<T, O>> = (
4
+ node: N,
5
+ ) => void | Promise<void> | Promise<void>[];
6
+ export type SyncWalker<T extends RuleConfigValue, O extends PlainData = undefined, N = MLNode<T, O>> = (
7
+ node: N,
8
+ ) => void;
9
+ export declare function syncWalk<T extends RuleConfigValue, O extends PlainData = undefined>(
10
+ nodeList: ReadonlyArray<MLNode<T, O>>,
11
+ walker: SyncWalker<T, O>,
12
+ ): void;
13
+ export declare function sequentialWalker<T extends RuleConfigValue, O extends PlainData = undefined, N = MLNode<T, O>>(
14
+ list: ReadonlyArray<N>,
15
+ walker: Walker<T, O, N>,
16
+ ): Promise<void>;
@@ -1,7 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.sequentialWalker = exports.syncWalk = void 0;
4
- function syncWalk(nodeList, walker) {
4
+ function syncWalk(
5
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
6
+ nodeList, walker) {
5
7
  for (const node of nodeList) {
6
8
  if (node.is(node.ELEMENT_NODE) || node.is(node.MARKUPLINT_PREPROCESSOR_BLOCK)) {
7
9
  syncWalk(Array.from(node.childNodes), walker);
@@ -25,21 +27,25 @@ function sequentialWalker(list, walker) {
25
27
  _reject = reject;
26
28
  });
27
29
  const loop = (index = 0) => {
28
- if (index >= list.length) {
29
- _resolve();
30
- return;
31
- }
32
- const node = list[index];
33
- if (!node) {
34
- _resolve();
35
- return;
36
- }
37
- const result = walker(node);
38
- if (result instanceof Promise) {
39
- result.then(() => loop(index + 1)).catch(_reject);
40
- }
41
- else {
42
- loop(index + 1);
30
+ // eslint-disable-next-line no-constant-condition
31
+ while (true) {
32
+ if (index >= list.length) {
33
+ _resolve();
34
+ return;
35
+ }
36
+ const node = list[index];
37
+ if (node == null) {
38
+ _resolve();
39
+ return;
40
+ }
41
+ const result = walker(node);
42
+ if (result instanceof Promise) {
43
+ result.then(() => loop(index + 1)).catch(_reject);
44
+ return;
45
+ }
46
+ else {
47
+ index = index + 1;
48
+ }
43
49
  }
44
50
  };
45
51
  loop();
@@ -1,33 +1,46 @@
1
1
  import type { MLElement } from '../node/element';
2
2
  import type { MLNode } from '../node/node';
3
- import type { RuleConfigValue } from '@markuplint/ml-config';
3
+ import type { PlainData, RuleConfigValue } from '@markuplint/ml-config';
4
4
  /**
5
5
  *
6
6
  * @see https://dom.spec.whatwg.org/#ref-for-dom-childnode-before%E2%91%A0
7
7
  */
8
- export declare function before<T extends RuleConfigValue, O = null>(node: MLNode<T, O>, ...additionalNodes: ReadonlyArray<MLNode<T, O> | string>): void;
8
+ export declare function before<T extends RuleConfigValue, O extends PlainData = undefined>(
9
+ node: MLNode<T, O>,
10
+ ...additionalNodes: ReadonlyArray<MLNode<T, O> | string>
11
+ ): void;
9
12
  /**
10
13
  *
11
14
  * @see https://dom.spec.whatwg.org/#ref-for-dom-childnode-after%E2%91%A0
12
15
  */
13
- export declare function after<T extends RuleConfigValue, O = null>(node: MLNode<T, O>, ...additionalNodes: ReadonlyArray<MLNode<T, O> | string>): void;
16
+ export declare function after<T extends RuleConfigValue, O extends PlainData = undefined>(
17
+ node: MLNode<T, O>,
18
+ ...additionalNodes: ReadonlyArray<MLNode<T, O> | string>
19
+ ): void;
14
20
  /**
15
21
  *
16
22
  * @see https://dom.spec.whatwg.org/#ref-for-dom-childnode-replacewith%E2%91%A0
17
23
  */
18
- export declare function replaceWith<T extends RuleConfigValue, O = null>(node: MLNode<T, O>, ...additionalNodes: ReadonlyArray<MLNode<T, O> | string>): void;
24
+ export declare function replaceWith<T extends RuleConfigValue, O extends PlainData = undefined>(
25
+ node: MLNode<T, O>,
26
+ ...additionalNodes: ReadonlyArray<MLNode<T, O> | string>
27
+ ): void;
19
28
  /**
20
29
  *
21
30
  * @see https://dom.spec.whatwg.org/#ref-for-dom-childnode-remove%E2%91%A0
22
31
  */
23
- export declare function remove<T extends RuleConfigValue, O = null>(node: MLNode<T, O>): void;
32
+ export declare function remove<T extends RuleConfigValue, O extends PlainData = undefined>(node: MLNode<T, O>): void;
24
33
  /**
25
34
  *
26
35
  * @see https://dom.spec.whatwg.org/#ref-for-dom-nondocumenttypechildnode-previouselementsibling%E2%91%A0
27
36
  */
28
- export declare function previousElementSibling<T extends RuleConfigValue, O = null>(node: MLNode<T, O>): MLElement<T, O> | null;
37
+ export declare function previousElementSibling<T extends RuleConfigValue, O extends PlainData = undefined>(
38
+ node: MLNode<T, O>,
39
+ ): MLElement<T, O> | null;
29
40
  /**
30
41
  *
31
42
  * @see https://dom.spec.whatwg.org/#ref-for-dom-nondocumenttypechildnode-nextelementsibling%E2%91%A0
32
43
  */
33
- export declare function nextElementSibling<T extends RuleConfigValue, O = null>(node: MLNode<T, O>): MLElement<T, O> | null;
44
+ export declare function nextElementSibling<T extends RuleConfigValue, O extends PlainData = undefined>(
45
+ node: MLNode<T, O>,
46
+ ): MLElement<T, O> | null;
@@ -7,7 +7,11 @@ const unexpected_call_error_1 = tslib_1.__importDefault(require("../node/unexpec
7
7
  *
8
8
  * @see https://dom.spec.whatwg.org/#ref-for-dom-childnode-before%E2%91%A0
9
9
  */
10
- function before(node, ...additionalNodes) {
10
+ function before(
11
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
12
+ node,
13
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
14
+ ...additionalNodes) {
11
15
  throw new unexpected_call_error_1.default('Not supported "before" method');
12
16
  }
13
17
  exports.before = before;
@@ -15,7 +19,11 @@ exports.before = before;
15
19
  *
16
20
  * @see https://dom.spec.whatwg.org/#ref-for-dom-childnode-after%E2%91%A0
17
21
  */
18
- function after(node, ...additionalNodes) {
22
+ function after(
23
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
24
+ node,
25
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
26
+ ...additionalNodes) {
19
27
  throw new unexpected_call_error_1.default('Not supported "after" method');
20
28
  }
21
29
  exports.after = after;
@@ -23,7 +31,11 @@ exports.after = after;
23
31
  *
24
32
  * @see https://dom.spec.whatwg.org/#ref-for-dom-childnode-replacewith%E2%91%A0
25
33
  */
26
- function replaceWith(node, ...additionalNodes) {
34
+ function replaceWith(
35
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
36
+ node,
37
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
38
+ ...additionalNodes) {
27
39
  throw new unexpected_call_error_1.default('Not supported "replaceWith" method');
28
40
  }
29
41
  exports.replaceWith = replaceWith;
@@ -31,7 +43,9 @@ exports.replaceWith = replaceWith;
31
43
  *
32
44
  * @see https://dom.spec.whatwg.org/#ref-for-dom-childnode-remove%E2%91%A0
33
45
  */
34
- function remove(node) {
46
+ function remove(
47
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
48
+ node) {
35
49
  throw new unexpected_call_error_1.default('Not supported "remove" method');
36
50
  }
37
51
  exports.remove = remove;
@@ -39,7 +53,9 @@ exports.remove = remove;
39
53
  *
40
54
  * @see https://dom.spec.whatwg.org/#ref-for-dom-nondocumenttypechildnode-previouselementsibling%E2%91%A0
41
55
  */
42
- function previousElementSibling(node) {
56
+ function previousElementSibling(
57
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
58
+ node) {
43
59
  var _a, _b;
44
60
  let prevNode = node.prevNode;
45
61
  while (prevNode) {
@@ -57,7 +73,9 @@ exports.previousElementSibling = previousElementSibling;
57
73
  *
58
74
  * @see https://dom.spec.whatwg.org/#ref-for-dom-nondocumenttypechildnode-nextelementsibling%E2%91%A0
59
75
  */
60
- function nextElementSibling(node) {
76
+ function nextElementSibling(
77
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
78
+ node) {
61
79
  var _a, _b;
62
80
  let nextNode = node.nextNode;
63
81
  while (nextNode) {
@@ -1,4 +1,6 @@
1
1
  import type { MLElement } from '../node/element';
2
2
  import type { MLNode } from '../node/node';
3
- import type { RuleConfigValue } from '@markuplint/ml-config';
4
- export declare function getChildren<T extends RuleConfigValue, O = null>(node: MLNode<T, O>): HTMLCollectionOf<MLElement<T, O>>;
3
+ import type { PlainData, RuleConfigValue } from '@markuplint/ml-config';
4
+ export declare function getChildren<T extends RuleConfigValue, O extends PlainData = undefined>(
5
+ node: MLNode<T, O>,
6
+ ): HTMLCollectionOf<MLElement<T, O>>;
@@ -2,7 +2,9 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getChildren = void 0;
4
4
  const node_list_1 = require("../node/node-list");
5
- function getChildren(node) {
5
+ function getChildren(
6
+ // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
7
+ node) {
6
8
  return (0, node_list_1.toHTMLCollection)(Array.from(node.childNodes).filter((child) => {
7
9
  return child.nodeType === child.ELEMENT_NODE;
8
10
  }));