@markuplint/file-resolver 3.2.0 → 3.3.1

package/lib/auto-load-rules.d.ts

@@ -3,6 +3,6 @@ import type { Ruleset, AnyMLRule } from '@markuplint/ml-core';
  * @deprecated
  */
 export declare function autoLoadRules(ruleset: Ruleset): Promise<{
-    rules: AnyMLRule[];
-    errors: unknown[];
+	rules: AnyMLRule[];
+	errors: unknown[];
 }>;

package/lib/config-provider.d.ts

@@ -2,12 +2,12 @@ import type { MLFile } from './ml-file';
 import type { ConfigSet, Nullable } from './types';
 import type { Config } from '@markuplint/ml-config';
 export declare class ConfigProvider {
-    #private;
-    resolve(targetFile: MLFile, names: Nullable<string>[], cache?: boolean): Promise<ConfigSet>;
-    search(targetFile: MLFile): Promise<string | null>;
-    set(config: Config, key?: string): string;
-    private _load;
-    private _mergeConfigs;
-    private _pathResolve;
-    private _recursiveLoad;
+	#private;
+	resolve(targetFile: MLFile, names: Nullable<string>[], cache?: boolean): Promise<ConfigSet>;
+	search(targetFile: MLFile): Promise<string | null>;
+	set(config: Config, key?: string): string;
+	private _load;
+	private _mergeConfigs;
+	private _pathResolve;
+	private _recursiveLoad;
 }

package/lib/cosmiconfig.d.ts

@@ -1,11 +1,17 @@
 import type { LoaderSync } from 'cosmiconfig';
 type CosmiConfig = ReturnType<LoaderSync>;
-export declare function search<T = CosmiConfig>(dir: string, cacheClear: boolean): Promise<{
-    filePath: string;
-    config: T;
+export declare function search<T = CosmiConfig>(
+	dir: string,
+	cacheClear: boolean,
+): Promise<{
+	filePath: string;
+	config: T;
 } | null>;
-export declare function load<T = CosmiConfig>(filePath: string, cacheClear: boolean): Promise<{
-    filePath: string;
-    config: T;
+export declare function load<T = CosmiConfig>(
+	filePath: string,
+	cacheClear: boolean,
+): Promise<{
+	filePath: string;
+	config: T;
 } | null>;
 export {};

package/lib/ml-file/ml-file.d.ts

@@ -1,23 +1,23 @@
 import type { Target } from '../types';
 export declare class MLFile {
-    #private;
-    constructor(target: Target);
-    get dirname(): string;
-    /**
-     * Normalized `MLFile.dirname`
-     */
-    get nDirname(): string;
-    /**
-     * Normalized `MLFile.path`
-     */
-    get nPath(): string;
-    get path(): string;
-    dirExists(): Promise<boolean>;
-    getCode(): Promise<string>;
-    isExist(): Promise<boolean>;
-    isFile(): Promise<boolean>;
-    matches(globPath: string): boolean;
-    setCode(code: string): void;
-    private _fetch;
-    private _stat;
+	#private;
+	constructor(target: Target);
+	get dirname(): string;
+	/**
+	 * Normalized `MLFile.dirname`
+	 */
+	get nDirname(): string;
+	/**
+	 * Normalized `MLFile.path`
+	 */
+	get nPath(): string;
+	get path(): string;
+	dirExists(): Promise<boolean>;
+	getCode(): Promise<string>;
+	isExist(): Promise<boolean>;
+	isFile(): Promise<boolean>;
+	matches(globPath: string): boolean;
+	setCode(code: string): void;
+	private _fetch;
+	private _stat;
 }

package/lib/pretender-provider.d.ts

@@ -0,0 +1,22 @@
+import type { OptimizedConfig, Pretender } from '@markuplint/ml-config';
+type PretendersConfig = OptimizedConfig['pretenders'];
+type PretenderWatchCallback = (pretenders: Pretender[]) => void;
+export declare class PretenderProvider {
+	#private;
+	getPretenders(): Promise<Pretender[]>;
+	setConfig(config: PretendersConfig): Promise<void>;
+	/**
+	 * Stops watching.
+	 * It does nothing if it is not in watching mode or it doesn't have scanning files.
+	 */
+	unwatch(): Promise<void>;
+	/**
+	 * Starts watching related files.
+	 * It passes the results of pretenders to callback every file changed.
+	 * It requires calling `setConfig` method in advance before calling this.
+	 *
+	 * @param callback
+	 */
+	watch(callback: PretenderWatchCallback): Promise<void>;
+}
+export {};

package/lib/pretender-provider.js

@@ -0,0 +1,146 @@
+"use strict";
+var _PretenderProvider_staticData, _PretenderProvider_scanners, _PretenderProvider_watchCallback, _Scanner_cache, _Scanner_options, _Scanner_watcher;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PretenderProvider = void 0;
+const tslib_1 = require("tslib");
+const cache_1 = require("@markuplint/cache");
+const watcher_1 = require("./watcher");
+const DIDNT_SPECIFY_CONFIG_ERROR_MSG = 'Cannot return pretenders because it did not specify the configuration yet. It might be the wrong order to call this method';
+class PretenderProvider {
+    constructor() {
+        _PretenderProvider_staticData.set(this, null);
+        _PretenderProvider_scanners.set(this, []);
+        _PretenderProvider_watchCallback.set(this, null);
+    }
+    async getPretenders() {
+        if (!tslib_1.__classPrivateFieldGet(this, _PretenderProvider_staticData, "f")) {
+            throw new ReferenceError(DIDNT_SPECIFY_CONFIG_ERROR_MSG);
+        }
+        const result = [...tslib_1.__classPrivateFieldGet(this, _PretenderProvider_staticData, "f")];
+        for (const scanner of tslib_1.__classPrivateFieldGet(this, _PretenderProvider_scanners, "f")) {
+            const pretenders = await scanner.scan();
+            result.push(...pretenders);
+        }
+        return result;
+    }
+    async setConfig(config) {
+        const [data, scanConfig] = await resolvePretendersConfig(config);
+        tslib_1.__classPrivateFieldSet(this, _PretenderProvider_staticData, data, "f");
+        if (scanConfig) {
+            for (const scan of scanConfig) {
+                if (scan.type === 'jsx') {
+                    const { jsxScanner } = await Promise.resolve().then(() => tslib_1.__importStar(require('@markuplint/pretenders/lib/jsx')));
+                    const scanner = new Scanner(scan.type, scan.files, jsxScanner, scan.options);
+                    tslib_1.__classPrivateFieldGet(this, _PretenderProvider_scanners, "f").push(scanner);
+                }
+            }
+        }
+        // It regards to be enabled watch mode if it has `#watchCallback`.
+        // And call the watch method then add the callback to each scanner.
+        if (tslib_1.__classPrivateFieldGet(this, _PretenderProvider_watchCallback, "f")) {
+            await this.watch(tslib_1.__classPrivateFieldGet(this, _PretenderProvider_watchCallback, "f"));
+        }
+    }
+    /**
+     * Stops watching.
+     * It does nothing if it is not in watching mode or it doesn't have scanning files.
+     */
+    async unwatch() {
+        for (const scanner of tslib_1.__classPrivateFieldGet(this, _PretenderProvider_scanners, "f")) {
+            await scanner.unwatch();
+        }
+    }
+    /**
+     * Starts watching related files.
+     * It passes the results of pretenders to callback every file changed.
+     * It requires calling `setConfig` method in advance before calling this.
+     *
+     * @param callback
+     */
+    async watch(callback) {
+        tslib_1.__classPrivateFieldSet(this, _PretenderProvider_watchCallback, callback, "f");
+        for (const scanner of tslib_1.__classPrivateFieldGet(this, _PretenderProvider_scanners, "f")) {
+            await scanner.watch(async () => {
+                var _a;
+                if (!tslib_1.__classPrivateFieldGet(this, _PretenderProvider_staticData, "f")) {
+                    throw new ReferenceError(DIDNT_SPECIFY_CONFIG_ERROR_MSG);
+                }
+                const allPretenders = await this.getPretenders();
+                (_a = tslib_1.__classPrivateFieldGet(this, _PretenderProvider_watchCallback, "f")) === null || _a === void 0 ? void 0 : _a.call(this, allPretenders);
+            });
+        }
+    }
+}
+exports.PretenderProvider = PretenderProvider;
+_PretenderProvider_staticData = new WeakMap(), _PretenderProvider_scanners = new WeakMap(), _PretenderProvider_watchCallback = new WeakMap();
+class Scanner {
+    constructor(type, glob, method, options) {
+        _Scanner_cache.set(this, void 0);
+        _Scanner_options.set(this, void 0);
+        _Scanner_watcher.set(this, null);
+        tslib_1.__classPrivateFieldSet(this, _Scanner_options, options, "f");
+        tslib_1.__classPrivateFieldSet(this, _Scanner_cache, new cache_1.Cache(type, glob, files => {
+            return method(Array.from(files), options);
+        }), "f");
+    }
+    /**
+     * Scans component files.
+     *
+     * @param newFileList
+     * @returns
+     */
+    async scan() {
+        const pretenders = await tslib_1.__classPrivateFieldGet(this, _Scanner_cache, "f").get();
+        return pretenders;
+    }
+    /**
+     * Stops watching.
+     * It does nothing if it is not in watching mode.
+     */
+    async unwatch() {
+        var _a;
+        await ((_a = tslib_1.__classPrivateFieldGet(this, _Scanner_watcher, "f")) === null || _a === void 0 ? void 0 : _a.close());
+    }
+    /**
+     * Starts watching related files.
+     * It passes the results of pretenders to callback every file changed.
+     *
+     * @param callback
+     */
+    async watch(callback) {
+        tslib_1.__classPrivateFieldSet(this, _Scanner_watcher, await watcher_1.Watcher.create(tslib_1.__classPrivateFieldGet(this, _Scanner_cache, "f").glob, tslib_1.__classPrivateFieldGet(this, _Scanner_options, "f")), "f");
+        tslib_1.__classPrivateFieldGet(this, _Scanner_watcher, "f").addChangeListener(async (file, type) => {
+            const pretenders = type === 'unlink' ? await tslib_1.__classPrivateFieldGet(this, _Scanner_cache, "f").delete(file) : await tslib_1.__classPrivateFieldGet(this, _Scanner_cache, "f").update(file);
+            if (!pretenders) {
+                return;
+            }
+            callback();
+        });
+    }
+}
+_Scanner_cache = new WeakMap(), _Scanner_options = new WeakMap(), _Scanner_watcher = new WeakMap();
+function resolvePretendersConfig(config) {
+    if (!config) {
+        return Promise.resolve([[], []]);
+    }
+    const data = [];
+    if (config.files) {
+        for (const file of config.files) {
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            const pretenderFile = require(file);
+            data.push(...pretenderFile.data);
+        }
+    }
+    // Experimental
+    if (config.imports) {
+        for (const module of config.imports) {
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            const pretenderFile = require(`${module}/pretenders.json`);
+            data.push(...pretenderFile.data);
+        }
+    }
+    if (config.data) {
+        data.push(...config.data);
+    }
+    return Promise.resolve([data, config.scan]);
+}

package/lib/resolve-parser.d.ts

@@ -1,9 +1,13 @@
 import type { MLFile } from './ml-file';
 import type { MLMarkupLanguageParser, ParserOptions } from '@markuplint/ml-ast';
 import type { ParserConfig } from '@markuplint/ml-config';
-export declare function resolveParser(file: MLFile, parserConfig?: ParserConfig, parserOptions?: ParserOptions): Promise<{
-    parserModName: string;
-    parser: MLMarkupLanguageParser;
-    parserOptions: ParserOptions;
-    matched: boolean;
+export declare function resolveParser(
+	file: MLFile,
+	parserConfig?: ParserConfig,
+	parserOptions?: ParserOptions,
+): Promise<{
+	parserModName: string;
+	parser: MLMarkupLanguageParser;
+	parserOptions: ParserOptions;
+	matched: boolean;
 }>;

package/lib/resolve-pretenders.d.ts

@@ -1,7 +1,4 @@
 import type { OptimizedConfig, Pretender } from '@markuplint/ml-config';
-import { PretenderScanner } from '@markuplint/pretenders';
 type PretendersConfig = OptimizedConfig['pretenders'];
-export declare function resolvePretenders(
-	config: PretendersConfig,
-): Promise<[data: Pretender[], scanners: PretenderScanner[]]>;
+export declare function resolvePretenders(config: PretendersConfig): Promise<Pretender[]>;
 export {};

package/lib/resolve-pretenders.js

@@ -1,37 +1,11 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolvePretenders = void 0;
-const pretenders_1 = require("@markuplint/pretenders");
-const utils_1 = require("./utils");
 async function resolvePretenders(config) {
     if (!config) {
-        return [[], []];
+        return [];
     }
     const data = [];
-    const scanners = [];
     if (config.files) {
         for (const file of config.files) {
             // eslint-disable-next-line @typescript-eslint/no-var-requires
@@ -50,16 +24,7 @@ async function resolvePretenders(config) {
     if (config.data) {
         data.push(...config.data);
     }
-    if (config.scan) {
-        for (const scan of config.scan) {
-            if (scan.type === 'jsx') {
-                const { scanJSX } = await Promise.resolve().then(() => __importStar(require('@markuplint/pretenders/lib/jsx')));
-                const files = await (0, utils_1.asyncGlob)(scan.files);
-                const scanner = new pretenders_1.PretenderScanner(files, scan.options, scanJSX);
-                scanners.push(scanner);
-            }
-        }
-    }
-    return [data, scanners];
+    // It wraps `Promise` currently due to needing to use `import()` someday.
+    return await Promise.resolve(data);
 }
 exports.resolvePretenders = resolvePretenders;

package/lib/resolve-rules.d.ts

@@ -1,7 +1,11 @@
 import type { AnyMLRule, Ruleset, Plugin } from '@markuplint/ml-core';
 import { MLRule } from '@markuplint/ml-core';
-export declare function resolveRules(plugins: Plugin[], ruleset: Ruleset, importPreset: boolean, 
-/**
- * @deprecated
- */
-autoLoad: boolean): Promise<AnyMLRule[] | MLRule<any, any>[]>;
+export declare function resolveRules(
+	plugins: Plugin[],
+	ruleset: Ruleset,
+	importPreset: boolean,
+	/**
+	 * @deprecated
+	 */
+	autoLoad: boolean,
+): Promise<AnyMLRule[] | MLRule<any, any>[]>;

package/lib/resolve-specs.d.ts

@@ -30,6 +30,9 @@ import type { ExtendedSpec, MLMLSpec } from '@markuplint/ml-spec';
  * @param specConfig The `spec` property part of the config
  * @returns
  */
-export declare function resolveSpecs(filePath: string, specConfig?: SpecConfig): Promise<{
-    schemas: readonly [MLMLSpec, ...ExtendedSpec[]];
+export declare function resolveSpecs(
+	filePath: string,
+	specConfig?: SpecConfig,
+): Promise<{
+	schemas: readonly [MLMLSpec, ...ExtendedSpec[]];
 }>;

package/lib/types.d.ts

@@ -2,22 +2,24 @@ import type { Config } from '@markuplint/ml-config';
 import type { Plugin } from '@markuplint/ml-core';
 export type Nullable<T> = T | null | undefined;
 export interface ConfigSet {
-    config: Config;
-    plugins: Plugin[];
-    files: Set<string>;
-    errs: Error[];
+	config: Config;
+	plugins: Plugin[];
+	files: Set<string>;
+	errs: Error[];
 }
-export type Target = string | {
-    /**
-     * Target source code of evaluation
-     */
-    sourceCode: string;
-    /**
-     * File names when `sourceCodes`
-     */
-    name?: string;
-    /**
-     * Workspace path when `sourceCodes`
-     */
-    workspace?: string;
-};
+export type Target =
+	| string
+	| {
+			/**
+			 * Target source code of evaluation
+			 */
+			sourceCode: string;
+			/**
+			 * File names when `sourceCodes`
+			 */
+			name?: string;
+			/**
+			 * Workspace path when `sourceCodes`
+			 */
+			workspace?: string;
+	  };

package/lib/watcher.d.ts

@@ -0,0 +1,15 @@
+type Options = {
+	cwd?: string;
+};
+type ChangeListener = (this: Watcher, filePath: string, type: 'change' | 'add' | 'unlink') => void;
+export declare class Watcher {
+	#private;
+	static create(pattern: string, options?: Options): Promise<Watcher>;
+	private constructor();
+	get files(): string[];
+	addChangeListener(changeListener: ChangeListener): void;
+	close(): Promise<void>;
+	private onEvent;
+	private update;
+}
+export {};

package/lib/watcher.js

@@ -0,0 +1,64 @@
+"use strict";
+var _Watcher_changeListener, _Watcher_cwd, _Watcher_filesObserver;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Watcher = void 0;
+const tslib_1 = require("tslib");
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const chokidar_1 = require("chokidar");
+const watcherOptions = {
+    persistent: true,
+    ignored: ['**/.git/**/*', '**/node_modules/**/*'],
+};
+class Watcher {
+    static async create(pattern, options) {
+        const watcher = new Watcher(options);
+        await watcher.update(pattern);
+        return watcher;
+    }
+    constructor(options) {
+        var _a;
+        _Watcher_changeListener.set(this, null);
+        _Watcher_cwd.set(this, void 0);
+        _Watcher_filesObserver.set(this, new chokidar_1.FSWatcher(watcherOptions));
+        tslib_1.__classPrivateFieldSet(this, _Watcher_cwd, (_a = options === null || options === void 0 ? void 0 : options.cwd) !== null && _a !== void 0 ? _a : process.cwd(), "f");
+    }
+    get files() {
+        return Object.entries(tslib_1.__classPrivateFieldGet(this, _Watcher_filesObserver, "f").getWatched())
+            .map(([dir, files]) => files.map(file => node_path_1.default.join(dir, file)))
+            .flat()
+            .sort();
+    }
+    addChangeListener(changeListener) {
+        tslib_1.__classPrivateFieldSet(this, _Watcher_changeListener, changeListener, "f");
+    }
+    async close() {
+        await tslib_1.__classPrivateFieldGet(this, _Watcher_filesObserver, "f").close();
+    }
+    onEvent(eventName, filePath) {
+        var _a;
+        switch (eventName) {
+            case 'change':
+            case 'add':
+            case 'unlink':
+                (_a = tslib_1.__classPrivateFieldGet(this, _Watcher_changeListener, "f")) === null || _a === void 0 ? void 0 : _a.call(this, filePath, eventName);
+                break;
+            default:
+                break;
+        }
+    }
+    async update(pattern) {
+        const absPattern = node_path_1.default.isAbsolute(pattern) ? pattern : node_path_1.default.resolve(tslib_1.__classPrivateFieldGet(this, _Watcher_cwd, "f"), pattern);
+        await tslib_1.__classPrivateFieldGet(this, _Watcher_filesObserver, "f").close();
+        tslib_1.__classPrivateFieldGet(this, _Watcher_filesObserver, "f").add(absPattern);
+        return new Promise(resolve => {
+            const onReady = () => {
+                tslib_1.__classPrivateFieldGet(this, _Watcher_filesObserver, "f").on('all', this.onEvent.bind(this));
+                tslib_1.__classPrivateFieldGet(this, _Watcher_filesObserver, "f").off('ready', onReady);
+                resolve();
+            };
+            tslib_1.__classPrivateFieldGet(this, _Watcher_filesObserver, "f").on('ready', onReady);
+        });
+    }
+}
+exports.Watcher = Watcher;
+_Watcher_changeListener = new WeakMap(), _Watcher_cwd = new WeakMap(), _Watcher_filesObserver = new WeakMap();

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/file-resolver",
-	"version": "3.2.0",
+	"version": "3.3.1",
 	"description": "The file resolver 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",
 		"clean": "tsc --build --clean"
@@ -21,16 +24,16 @@
 		"@types/node": "latest"
 	},
 	"dependencies": {
-		"@markuplint/html-parser": "3.2.0",
-		"@markuplint/ml-ast": "3.0.0-rc.5",
-		"@markuplint/ml-config": "3.2.0",
-		"@markuplint/ml-core": "3.2.0",
-		"@markuplint/ml-spec": "3.2.0",
+		"@markuplint/html-parser": "3.3.1",
+		"@markuplint/ml-ast": "3.0.0",
+		"@markuplint/ml-config": "3.3.0",
+		"@markuplint/ml-core": "3.3.1",
+		"@markuplint/ml-spec": "3.3.0",
 		"cosmiconfig": "^8.0.0",
 		"glob": "^8.0.3",
 		"jsonc": "^2.0.0",
 		"minimatch": "^5.1.1",
 		"tslib": "^2.4.1"
 	},
-	"gitHead": "26b04e045d91e29befca34c10dda2147b1bca9c7"
+	"gitHead": "f19e7de726cf01d53342bc5513c30da75d28da63"
 }