@markuplint/file-resolver 3.15.0 → 4.0.0-alpha.10

package/lib/module-exists.js

@@ -0,0 +1,49 @@
+import { createRequire } from 'node:module';
+import { log } from './debug.js';
+const require = createRequire(import.meta.url);
+const mLog = log.extend('module-exists');
+export async function moduleExists(name) {
+    try {
+        await import(name);
+    }
+    catch (error) {
+        if (
+        // @ts-ignore
+        'code' in error &&
+            // @ts-ignore
+            error.code === 'ERR_IMPORT_ASSERTION_TYPE_MISSING') {
+            // It exists, but it is may be a JSON file.
+            mLog('Return true, but it caught Error in `import()`: %O', error);
+            return true;
+        }
+        if (error instanceof Error && /^parse failure/i.test(error.message)) {
+            // It exists, but it failed to parse.
+            mLog('Return true, but it caught Error in `import()`: %O', error);
+            return true;
+        }
+        try {
+            require.resolve(name);
+        }
+        catch (error) {
+            if (
+            // @ts-ignore
+            'code' in error &&
+                // @ts-ignore
+                error.code === 'ERR_PACKAGE_PATH_NOT_EXPORTED') {
+                // Even if there are issues with the fields,
+                // assume that the module exists and return true.
+                mLog('Return true, but it caught Error in `require.resolve()`: %O', error);
+                return true;
+            }
+            if (
+            // @ts-ignore
+            'code' in error &&
+                // @ts-ignore
+                error.code === 'MODULE_NOT_FOUND') {
+                return false;
+            }
+            throw error;
+        }
+    }
+    return true;
+}

package/lib/path-to-abs-or-name.d.ts

@@ -0,0 +1 @@
+export declare function relPathToNameOrAbsPath<T extends string | readonly (string | Record<string, unknown>)[] | Readonly<Record<string, unknown>> | undefined>(dir: string, filePath?: T, resolveProps?: readonly string[], resolveKey?: boolean): Promise<T>;

package/lib/path-to-abs-or-name.js

@@ -0,0 +1,38 @@
+import { resolveNameOrAbsPath } from './resolve-name-or-abs-path.js';
+export async function relPathToNameOrAbsPath(dir, filePath, resolveProps, resolveKey = false) {
+    if (filePath == null) {
+        // @ts-ignore
+        return undefined;
+    }
+    if (typeof filePath === 'string') {
+        // @ts-ignore
+        return resolveNameOrAbsPath(dir, filePath);
+    }
+    if (Array.isArray(filePath)) {
+        // @ts-ignore
+        return Promise.all(filePath.map(fp => relPathToNameOrAbsPath(dir, fp, resolveProps)));
+    }
+    const res = {};
+    for (const [key, fp] of Object.entries(filePath)) {
+        let _key = key;
+        if (resolveKey) {
+            _key = await resolveNameOrAbsPath(dir, key);
+        }
+        if (typeof fp === 'string') {
+            if (!resolveProps) {
+                res[_key] = await resolveNameOrAbsPath(dir, fp);
+            }
+            else if (resolveProps.includes(key)) {
+                res[_key] = await resolveNameOrAbsPath(dir, fp);
+            }
+            else {
+                res[_key] = fp;
+            }
+        }
+        else {
+            res[_key] = fp;
+        }
+    }
+    // @ts-ignore
+    return res;
+}

package/lib/resolve-files.d.ts

@@ -1,3 +1,3 @@
-import type { MLFile } from './ml-file';
-import type { Target } from './types';
-export declare function resolveFiles(targetList: readonly Readonly<Target>[]): Promise<MLFile[]>;
+import type { MLFile } from './ml-file/index.js';
+import type { Target } from './types.js';
+export declare function resolveFiles(targetList: readonly Readonly<Target>[], ignoreGlob?: string): Promise<MLFile[]>;

package/lib/resolve-files.js

@@ -1,17 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveFiles = void 0;
-const ml_file_1 = require("./ml-file");
-async function resolveFiles(targetList) {
+import { getAnonymousFile, getFiles } from './ml-file/index.js';
+export async function resolveFiles(targetList, ignoreGlob) {
     const res = [];
     for (const target of targetList) {
         if (typeof target === 'string') {
-            const file = await (0, ml_file_1.getFiles)(target);
+            const file = await getFiles(target, ignoreGlob);
             res.push(...file);
             continue;
         }
-        res.push((0, ml_file_1.getAnonymousFile)(target.sourceCode, target.workspace, target.name));
+        res.push(getAnonymousFile(target.sourceCode, target.workspace, target.name));
     }
     return res;
 }
-exports.resolveFiles = resolveFiles;

package/lib/resolve-name-or-abs-path.d.ts

@@ -0,0 +1 @@
+export declare function resolveNameOrAbsPath(dir: string, pathOrModName: string): Promise<string>;

package/lib/resolve-name-or-abs-path.js

@@ -0,0 +1,14 @@
+import path from 'node:path';
+import { isPluginModuleName } from './is-plugin-module-name.js';
+import { isPresetModuleName } from './is-preset-module-name.js';
+import { moduleExists } from './module-exists.js';
+export async function resolveNameOrAbsPath(dir, pathOrModName) {
+    if ((await moduleExists(pathOrModName)) || isPresetModuleName(pathOrModName) || isPluginModuleName(pathOrModName)) {
+        return pathOrModName;
+    }
+    const bangAndPath = /^(!)(.*)/.exec(pathOrModName) ?? [];
+    const bang = bangAndPath[1] ?? '';
+    const pathname = bangAndPath[2] ?? pathOrModName;
+    const absPath = path.resolve(dir, pathname);
+    return bang + absPath;
+}

package/lib/resolve-parser.d.ts

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

package/lib/resolve-parser.js

@@ -1,20 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveParser = void 0;
-const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const utils_1 = require("./utils");
+import path from 'node:path';
+import { generalImport } from './general-import.js';
+import { toRegexp } from './utils.js';
 const parsers = new Map();
-async function resolveParser(file, parserConfig, parserOptions) {
+export async function resolveParser(file, parserConfig, parserOptions) {
     parserConfig = {
         ...parserConfig,
         '/\\.html?$/i': '@markuplint/html-parser',
     };
-    parserOptions = parserOptions !== null && parserOptions !== void 0 ? parserOptions : {};
+    parserOptions = parserOptions ?? {};
     let parserModName = '@markuplint/html-parser';
     let matched = false;
     for (const pattern of Object.keys(parserConfig)) {
-        if (path_1.default.basename(file.path).match((0, utils_1.toRegexp)(pattern))) {
+        // eslint-disable-next-line unicorn/prefer-regexp-test
+        if (path.basename(file.path).match(toRegexp(pattern))) {
             const modName = parserConfig[pattern];
             if (!modName) {
                 continue;
@@ -32,12 +30,18 @@ async function resolveParser(file, parserConfig, parserOptions) {
         matched,
     };
 }
-exports.resolveParser = resolveParser;
 async function importParser(parserModName) {
     const entity = parsers.get(parserModName);
     if (entity) {
         return entity;
     }
-    const parser = await Promise.resolve(`${parserModName}`).then(s => tslib_1.__importStar(require(s)));
-    return parser;
+    const parserMod = await generalImport(parserModName);
+    if (!parserMod) {
+        throw new Error(`Parser module "${parserModName}" is not found.`);
+    }
+    // TODO: To be dropped in v5
+    if (!('parser' in parserMod)) {
+        return parserMod;
+    }
+    return parserMod.parser;
 }

package/lib/resolve-plugins.js

@@ -1,73 +1,48 @@
-"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.cacheClear = exports.resolvePlugins = void 0;
+import { log } from './debug.js';
+import { generalImport } from './general-import.js';
+const pLog = log.extend('resolve-plugins');
 const cache = new Map();
-async function resolvePlugins(pluginPaths) {
+export async function resolvePlugins(pluginPaths) {
     if (!pluginPaths) {
         return [];
     }
     const plugins = await Promise.all(pluginPaths.map(p => importPlugin(p)));
     // Clone
-    return plugins.slice();
+    return [...plugins];
 }
-exports.resolvePlugins = resolvePlugins;
-function cacheClear() {
+export function cacheClear() {
     cache.clear();
 }
-exports.cacheClear = cacheClear;
 async function importPlugin(pluginPath) {
     const config = getPluginConfig(pluginPath);
     const cached = cache.get(config.name);
     if (cached) {
+        pLog('Return from cache: %s', config.name);
         return cached;
     }
-    const pluginCreator = await failSafeImport(config.name);
-    if (!pluginCreator) {
-        return {
-            name: config.name,
+    const pluginCreator = await generalImport(config.name);
+    let name = config.name;
+    let plugin = null;
+    if (typeof pluginCreator?.create === 'function' || pluginCreator?.name) {
+        plugin = {
+            name: pluginCreator.name,
+            ...pluginCreator.create(config.settings),
         };
+        name = plugin.name ?? name;
     }
-    const plugin = {
-        name: pluginCreator.name,
-        ...pluginCreator.create(config.settings),
-    };
-    cache.set(plugin.name, plugin);
-    let name = plugin.name;
-    if (!name) {
-        name = config.name
-            .toLowerCase()
-            .replace(/^(?:markuplint-rule-|@markuplint\/rule-)/i, '')
-            .replace(/\s+|\/|\\|\./g, '-');
-        // eslint-disable-next-line no-console
-        console.info(`The plugin name became "${name}"`);
+    else if (pluginCreator) {
+        pLog('Invalid plugin: %s', config.name);
     }
-    return {
+    name = name
+        .toLowerCase()
+        .replace(/^(?:markuplint-rule-|@markuplint\/rule-)/i, '')
+        .replaceAll(/\s+|[./\\]/g, '-');
+    const result = {
         ...plugin,
         name,
     };
+    cache.set(name, result);
+    return result;
 }
 function getPluginConfig(pluginPath) {
     if (typeof pluginPath === 'string') {
@@ -75,10 +50,3 @@ function getPluginConfig(pluginPath) {
     }
     return pluginPath;
 }
-async function failSafeImport(name) {
-    const res = await Promise.resolve(`${name}`).then(s => __importStar(require(s))).catch(e => e);
-    if ('code' in res && res === 'MODULE_NOT_FOUND') {
-        return null;
-    }
-    return res.default;
-}

package/lib/resolve-rules.d.ts

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

package/lib/resolve-rules.js

@@ -1,68 +1,42 @@
-"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.resolveRules = void 0;
-const ml_core_1 = require("@markuplint/ml-core");
-const auto_load_rules_1 = require("./auto-load-rules");
+import { MLRule } from '@markuplint/ml-core';
+import { autoLoadRules } from './auto-load-rules.js';
 let cachedPresetRules = null;
-async function resolveRules(plugins, ruleset, importPreset, 
+export async function resolveRules(plugins, ruleset, importPreset, 
 /**
  * @deprecated
  */
 autoLoad) {
     const rules = importPreset ? await importPresetRules() : [];
-    plugins.forEach(plugin => {
+    for (const plugin of plugins) {
         if (!plugin.rules) {
-            return;
+            continue;
         }
-        Object.entries(plugin.rules).forEach(([name, seed]) => {
-            const rule = new ml_core_1.MLRule({
+        for (const [name, seed] of Object.entries(plugin.rules)) {
+            const rule = new MLRule({
                 name: `${plugin.name}/${name}`,
                 ...seed,
             });
             rules.push(rule);
-        });
-    });
+        }
+    }
     if (autoLoad) {
-        const { rules: additionalRules } = await (0, auto_load_rules_1.autoLoadRules)(ruleset);
-        additionalRules.forEach(rule => {
+        const { rules: additionalRules } = await autoLoadRules(ruleset);
+        for (const rule of additionalRules) {
             rules.push(rule);
-        });
+        }
     }
     // Clone
-    return rules.slice();
+    return [...rules];
 }
-exports.resolveRules = resolveRules;
 async function importPresetRules() {
     if (cachedPresetRules) {
-        return cachedPresetRules.slice();
+        return [...cachedPresetRules];
     }
     const modName = '@markuplint/rules';
-    const presetRules = (await Promise.resolve(`${modName}`).then(s => __importStar(require(s)))).default;
+    const mod = await import(modName);
+    const presetRules = mod.default;
     const ruleList = Object.entries(presetRules).map(([name, seed]) => {
-        const rule = new ml_core_1.MLRule({
+        const rule = new MLRule({
             name,
             ...seed,
         });
@@ -70,5 +44,5 @@ async function importPresetRules() {
     });
     cachedPresetRules = ruleList;
     // Clone
-    return ruleList.slice();
+    return [...ruleList];
 }

package/lib/resolve-specs.d.ts

@@ -30,9 +30,6 @@ 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/resolve-specs.js

@@ -1,9 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveSpecs = void 0;
-const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const utils_1 = require("./utils");
+import path from 'node:path';
+import { generalImport } from './general-import.js';
+import { toRegexp } from './utils.js';
 const caches = new Map();
 /**
  * Loading and importing form specs.
@@ -35,7 +32,7 @@ const caches = new Map();
  * @param specConfig The `spec` property part of the config
  * @returns
  */
-async function resolveSpecs(filePath, specConfig) {
+export async function resolveSpecs(filePath, specConfig) {
     const htmlSpec = await importSpecs('@markuplint/html-spec');
     const extendedSpecs = [];
     if (specConfig) {
@@ -45,7 +42,8 @@ async function resolveSpecs(filePath, specConfig) {
         }
         else {
             for (const pattern of Object.keys(specConfig)) {
-                if (path_1.default.basename(filePath).match((0, utils_1.toRegexp)(pattern))) {
+                // eslint-disable-next-line unicorn/prefer-regexp-test
+                if (path.basename(filePath).match(toRegexp(pattern))) {
                     const specModName = specConfig[pattern];
                     if (!specModName) {
                         continue;
@@ -61,7 +59,6 @@ async function resolveSpecs(filePath, specConfig) {
         schemas,
     };
 }
-exports.resolveSpecs = resolveSpecs;
 async function importSpecs(specModName) {
     {
         // @ts-ignore
@@ -70,8 +67,10 @@ async function importSpecs(specModName) {
             return spec;
         }
     }
-    const spec = (await Promise.resolve(`${specModName}`).then(s => tslib_1.__importStar(require(s)))).default;
-    // @ts-ignore
+    const spec = await generalImport(specModName);
+    if (!spec) {
+        throw new Error(`Spec "${specModName}" is not found.`);
+    }
     caches.set(specModName, spec);
     return spec;
 }

package/lib/types.d.ts

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

package/lib/types.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/lib/utils.js

@@ -1,24 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toRegexp = exports.fileExists = exports.uuid = void 0;
-const tslib_1 = require("tslib");
-const fs_1 = tslib_1.__importDefault(require("fs"));
+import fs from 'node:fs';
 let uuidNum = 0;
-function uuid() {
+export function uuid() {
     const out = `${uuidNum}`;
     uuidNum++;
     return out;
 }
-exports.uuid = uuid;
-function fileExists(filePath) {
-    return fs_1.default.existsSync(filePath);
+export function fileExists(filePath) {
+    return fs.existsSync(filePath);
 }
-exports.fileExists = fileExists;
-function toRegexp(pattern) {
-    const matched = pattern.match(/^\/(.+)\/([ig]*)$/i);
+export function toRegexp(pattern) {
+    const matched = pattern.match(/^\/(.+)\/([gi]*)$/i);
     if (matched && matched[1]) {
         return new RegExp(matched[1], matched[2]);
     }
     return pattern;
 }
-exports.toRegexp = toRegexp;

package/package.json

@@ -1,13 +1,18 @@
 {
 	"name": "@markuplint/file-resolver",
-	"version": "3.15.0",
+	"version": "4.0.0-alpha.10",
 	"description": "The file resolver of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
 	"license": "MIT",
 	"private": false,
-	"main": "lib/index.js",
-	"types": "lib/index.d.ts",
+	"type": "module",
+	"exports": {
+		".": {
+			"import": "./lib/index.js"
+		}
+	},
+	"types": "./lib/index.d.ts",
 	"publishConfig": {
 		"access": "public"
 	},
@@ -19,24 +24,23 @@
 		"clean": "tsc --build --clean"
 	},
 	"devDependencies": {
-		"@types/node": "20.10.0"
+		"@types/node": "20.11.10"
 	},
 	"dependencies": {
-		"@markuplint/html-parser": "3.13.0",
-		"@markuplint/ml-ast": "3.2.0",
-		"@markuplint/ml-config": "3.14.0",
-		"@markuplint/ml-core": "3.15.0",
-		"@markuplint/ml-spec": "3.14.0",
-		"@markuplint/parser-utils": "3.13.0",
-		"@markuplint/selector": "3.14.0",
-		"@markuplint/shared": "3.8.0",
-		"cosmiconfig": "^8.3.6",
-		"cosmiconfig-typescript-loader": "^5.0.0",
-		"glob": "^10.3.10",
+		"@markuplint/html-parser": "4.0.0-alpha.10",
+		"@markuplint/ml-ast": "4.0.0-alpha.10",
+		"@markuplint/ml-config": "4.0.0-alpha.10",
+		"@markuplint/ml-core": "4.0.0-alpha.10",
+		"@markuplint/ml-spec": "4.0.0-alpha.10",
+		"@markuplint/parser-utils": "4.0.0-alpha.10",
+		"@markuplint/selector": "4.0.0-alpha.10",
+		"@markuplint/shared": "4.0.0-alpha.10",
+		"cosmiconfig": "^9.0.0",
+		"debug": "^4.3.4",
+		"glob": "^10.3.6",
 		"ignore": "^5.3.0",
 		"jsonc": "^2.0.0",
-		"minimatch": "^9.0.3",
-		"tslib": "^2.6.2"
+		"minimatch": "^9.0.3"
 	},
-	"gitHead": "b37b749d7ac0f9e6cbd022ee7031bc020c6677d3"
+	"gitHead": "b41153ea665aa8f091daf6114a06047f4ccb8350"
 }