@markuplint/ml-core 3.2.0 → 3.3.1

package/lib/ml-rule/types.d.ts

@@ -3,18 +3,24 @@ import type { MLRuleContext } from './ml-rule-context';
 import type { Translator } from '@markuplint/i18n';
 import type { Report, RuleConfigValue, Severity } from '@markuplint/ml-config';
 export type RuleSeed<T extends RuleConfigValue = boolean, O = null> = {
-    defaultSeverity?: Severity;
-    defaultValue?: T;
-    defaultOptions?: O;
-    verify(context: ReturnType<MLRuleContext<T, O>['provide']>): void | Promise<void>;
-    fix?(context: ReturnType<MLRuleContext<T, O>['provide']>): void | Promise<void>;
+	defaultSeverity?: Severity;
+	defaultValue?: T;
+	defaultOptions?: O;
+	verify(context: ReturnType<MLRuleContext<T, O>['provide']>): void | Promise<void>;
+	fix?(context: ReturnType<MLRuleContext<T, O>['provide']>): void | Promise<void>;
 };
-export type Checker<T extends RuleConfigValue, O = null, P extends Record<string, unknown> = {}> = (params: P) => CheckerReport<T, O>;
-export type ElementChecker<T extends RuleConfigValue, O = null, P extends Record<string, unknown> = {}> = (params: P & {
-    el: Element<T, O>;
-}) => CheckerReport<T, O>;
-export type AttrChecker<T extends RuleConfigValue, O = null, P extends Record<string, unknown> = {}> = (params: P & {
-    attr: Attr<T, O>;
-}) => CheckerReport<T, O>;
+export type Checker<T extends RuleConfigValue, O = null, P extends Record<string, unknown> = {}> = (
+	params: P,
+) => CheckerReport<T, O>;
+export type ElementChecker<T extends RuleConfigValue, O = null, P extends Record<string, unknown> = {}> = (
+	params: P & {
+		el: Element<T, O>;
+	},
+) => CheckerReport<T, O>;
+export type AttrChecker<T extends RuleConfigValue, O = null, P extends Record<string, unknown> = {}> = (
+	params: P & {
+		attr: Attr<T, O>;
+	},
+) => CheckerReport<T, O>;
 export type CheckerReport<T extends RuleConfigValue, O = null> = (t: Translator) => Report<T, O> | undefined | null;
 export type AnyRuleSeed = RuleSeed<any, any>;

package/lib/plugin/types.d.ts

@@ -1,12 +1,12 @@
 import type { AnyRuleSeed } from '../ml-rule';
 import type { Config } from '@markuplint/ml-config';
 export type Plugin = {
-    name: string;
-    rules?: Record<string, AnyRuleSeed>;
-    configs?: Record<string, Config>;
+	name: string;
+	rules?: Record<string, AnyRuleSeed>;
+	configs?: Record<string, Config>;
 };
 export type PluginCreator<S extends CreatePluginSettings> = {
-    name: string;
-    create(setting: S): Omit<Plugin, 'name'>;
+	name: string;
+	create(setting: S): Omit<Plugin, 'name'>;
 };
 export type CreatePluginSettings = Record<string, unknown>;

package/lib/ruleset/index.d.ts

@@ -1,7 +1,7 @@
 import type { ChildNodeRule, Config, NodeRule, Rules } from '@markuplint/ml-config';
 export default class Ruleset {
-    readonly childNodeRules: ReadonlyArray<ChildNodeRule>;
-    readonly nodeRules: ReadonlyArray<NodeRule>;
-    readonly rules: Readonly<Rules>;
-    constructor(config: Config);
+	readonly childNodeRules: ReadonlyArray<ChildNodeRule>;
+	readonly nodeRules: ReadonlyArray<NodeRule>;
+	readonly rules: Readonly<Rules>;
+	constructor(config: Config);
 }

package/lib/test/index.d.ts

@@ -3,14 +3,26 @@ import type { Config, RuleConfigValue } from '@markuplint/ml-config';
 import type { ExtendedSpec, MLMLSpec } from '@markuplint/ml-spec';
 import { Document } from '../ml-dom';
 export type CreateTestOptions = {
-    config?: Config;
-    parser?: MLMarkupLanguageParser;
-    specs?: MLMLSpec;
+	config?: Config;
+	parser?: MLMarkupLanguageParser;
+	specs?: MLMLSpec;
 };
-export declare function createTestDocument<T extends RuleConfigValue = any, O = any>(sourceCode: string, options?: CreateTestOptions): Document<T, O>;
-export declare function createTestNodeList(sourceCode: string, options?: CreateTestOptions): readonly import("../ml-dom/node/node").MLNode<any, any, import("@markuplint/ml-ast").MLASTAbstractNode>[];
-export declare function createTestTokenList(sourceCode: string, options?: CreateTestOptions): readonly import("../ml-dom/token/token").MLToken<import("@markuplint/ml-ast").MLToken>[];
-export declare function createTestElement(sourceCode: string, options?: CreateTestOptions): import("../ml-dom").Element<any, any>;
+export declare function createTestDocument<T extends RuleConfigValue = any, O = any>(
+	sourceCode: string,
+	options?: CreateTestOptions,
+): Document<T, O>;
+export declare function createTestNodeList(
+	sourceCode: string,
+	options?: CreateTestOptions,
+): readonly import('../ml-dom/node/node').MLNode<any, any, import('@markuplint/ml-ast').MLASTAbstractNode>[];
+export declare function createTestTokenList(
+	sourceCode: string,
+	options?: CreateTestOptions,
+): readonly import('../ml-dom/token/token').MLToken<import('@markuplint/ml-ast').MLToken>[];
+export declare function createTestElement(
+	sourceCode: string,
+	options?: CreateTestOptions,
+): import('../ml-dom').Element<any, any>;
 /**
  * for test suite
  */

package/lib/types.d.ts

@@ -6,11 +6,11 @@ import type { Pretender } from '@markuplint/ml-config';
 import type { ExtendedSpec, MLMLSpec } from '@markuplint/ml-spec';
 export type MLSchema = Readonly<[MLMLSpec, ...ExtendedSpec[]]>;
 export type MLFabric = {
-    parser: MLMarkupLanguageParser;
-    ruleset: Partial<Ruleset>;
-    rules: AnyMLRule[];
-    locale: LocaleSet;
-    schemas: MLSchema;
-    parserOptions: ParserOptions;
-    pretenders: Pretender[];
+	parser: MLMarkupLanguageParser;
+	ruleset: Partial<Ruleset>;
+	rules: AnyMLRule[];
+	locale: LocaleSet;
+	schemas: MLSchema;
+	parserOptions: ParserOptions;
+	pretenders: Pretender[];
 };

package/lib/utils/get-location-from-chars.d.ts

@@ -1,7 +1,12 @@
 interface Location {
-    line: number;
-    col: number;
-    raw: string;
+	line: number;
+	col: number;
+	raw: string;
 }
-export declare function getLocationFromChars(searches: string[], text: string, currentLine: number, currentCol: number): Location[];
+export declare function getLocationFromChars(
+	searches: string[],
+	text: string,
+	currentLine: number,
+	currentCol: number,
+): Location[];
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-core",
-	"version": "3.2.0",
+	"version": "3.3.1",
 	"description": "The core module of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -11,6 +11,9 @@
 	"publishConfig": {
 		"access": "public"
 	},
+	"typedoc": {
+		"entryPoint": "./src/index.ts"
+	},
 	"scripts": {
 		"build": "tsc",
 		"dev": "tsc --build --watch",
@@ -20,19 +23,21 @@
 		"./lib/configs.js": "./lib/configs.browser.js"
 	},
 	"dependencies": {
-		"@markuplint/config-presets": "3.2.0",
-		"@markuplint/i18n": "3.2.0",
-		"@markuplint/ml-ast": "3.0.0-rc.5",
-		"@markuplint/ml-config": "3.2.0",
-		"@markuplint/ml-spec": "3.2.0",
-		"@markuplint/parser-utils": "3.2.0",
-		"@markuplint/selector": "3.2.0",
+		"@markuplint/config-presets": "3.3.0",
+		"@markuplint/html-parser": "3.3.1",
+		"@markuplint/html-spec": "3.3.1",
+		"@markuplint/i18n": "3.3.0",
+		"@markuplint/ml-ast": "3.0.0",
+		"@markuplint/ml-config": "3.3.0",
+		"@markuplint/ml-spec": "3.3.0",
+		"@markuplint/parser-utils": "3.3.0",
+		"@markuplint/selector": "3.3.0",
 		"debug": "^4.3.4",
 		"tslib": "^2.4.1"
 	},
 	"devDependencies": {
-		"@markuplint/html-parser": "3.2.0",
+		"@markuplint/html-parser": "3.3.0",
 		"@types/debug": "^4.1.7"
 	},
-	"gitHead": "26b04e045d91e29befca34c10dda2147b1bca9c7"
+	"gitHead": "f19e7de726cf01d53342bc5513c30da75d28da63"
 }

package/lib/ml-dom/node/pretender.d.ts

@@ -1,5 +0,0 @@
-import type { RuleConfigValue } from '@markuplint/ml-config';
-import { MLElement } from './element';
-export declare class Pretender<T extends RuleConfigValue, O = null> extends MLElement<T, O> {
-	readonly pretenderContext: null;
-}

package/lib/ml-dom/node/pretender.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Pretender = void 0;
-const element_1 = require("./element");
-class Pretender extends element_1.MLElement {
-    constructor() {
-        super(...arguments);
-        this.pretenderContext = null;
-    }
-}
-exports.Pretender = Pretender;