@markuplint/file-resolver 3.0.0-alpha.66 → 3.0.0-dev.176

package/lib/resolve-plugins.js

@@ -55,15 +55,19 @@ async function importPlugin(pluginPath) {
         ...pluginCreator.create(config.settings),
     };
     cache.set(plugin.name, plugin);
-    if (!plugin.name) {
-        plugin.name = config.name
+    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 "${plugin.name}"`);
+        console.info(`The plugin name became "${name}"`);
     }
-    return plugin;
+    return {
+        ...plugin,
+        name,
+    };
 }
 function getPluginConfig(pluginPath) {
     if (typeof pluginPath === 'string') {
@@ -72,7 +76,7 @@ function getPluginConfig(pluginPath) {
     return pluginPath;
 }
 async function failSafeImport(name) {
-    const res = await Promise.resolve().then(() => __importStar(require(name))).catch(e => e);
+    const res = await Promise.resolve(`${name}`).then(s => __importStar(require(s))).catch(e => e);
     if ('code' in res && res === 'MODULE_NOT_FOUND') {
         return null;
     }

package/lib/resolve-rules.d.ts

@@ -1,7 +1,10 @@
 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: readonly Plugin[],
+	ruleset: Ruleset,
+	importPreset: boolean,
+	/**
+	 * @deprecated
+	 */
+	autoLoad: boolean,
+): Promise<Readonly<AnyMLRule>[]>;

package/lib/resolve-rules.js

@@ -60,7 +60,7 @@ async function importPresetRules() {
         return cachedPresetRules.slice();
     }
     const modName = '@markuplint/rules';
-    const presetRules = (await Promise.resolve().then(() => __importStar(require(modName)))).default;
+    const presetRules = (await Promise.resolve(`${modName}`).then(s => __importStar(require(s)))).default;
     const ruleList = Object.entries(presetRules).map(([name, seed]) => {
         const rule = new ml_core_1.MLRule({
             name,

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/resolve-specs.js

@@ -43,16 +43,13 @@ async function resolveSpecs(filePath, specConfig) {
             const spec = await importSpecs(specConfig);
             extendedSpecs.push(spec);
         }
-        else if (Array.isArray(specConfig)) {
-            for (const specModName of specConfig) {
-                const spec = await importSpecs(specModName);
-                extendedSpecs.push(spec);
-            }
-        }
         else {
             for (const pattern of Object.keys(specConfig)) {
-                if (path_1.default.basename(filePath).match((0, utils_1.toRegxp)(pattern))) {
+                if (path_1.default.basename(filePath).match((0, utils_1.toRegexp)(pattern))) {
                     const specModName = specConfig[pattern];
+                    if (!specModName) {
+                        continue;
+                    }
                     const spec = await importSpecs(specModName);
                     extendedSpecs.push(spec);
                 }
@@ -73,7 +70,8 @@ async function importSpecs(specModName) {
             return spec;
         }
     }
-    const spec = (await Promise.resolve().then(() => tslib_1.__importStar(require(specModName)))).default;
+    const spec = (await Promise.resolve(`${specModName}`).then(s => tslib_1.__importStar(require(s)))).default;
+    // @ts-ignore
     caches.set(specModName, spec);
     return spec;
 }

package/lib/types.d.ts

@@ -1,23 +1,24 @@
 import type { Config } from '@markuplint/ml-config';
 import type { Plugin } from '@markuplint/ml-core';
-export declare type Nullable<T> = T | null | undefined;
 export interface ConfigSet {
-    config: Config;
-    plugins: Plugin[];
-    files: Set<string>;
-    errs: Error[];
+	readonly config: Config;
+	readonly plugins: readonly Plugin[];
+	readonly files: ReadonlySet<string>;
+	readonly errs: readonly Readonly<Error>[];
 }
-export declare 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
+			 */
+			readonly sourceCode: string;
+			/**
+			 * File names when `sourceCodes`
+			 */
+			readonly name?: string;
+			/**
+			 * Workspace path when `sourceCodes`
+			 */
+			readonly workspace?: string;
+	  };

package/lib/utils.d.ts

@@ -1,5 +1,3 @@
-import type { Nullable } from './types';
-export declare function nonNullableFilter<T>(item: Nullable<T>): item is T;
 export declare function uuid(): string;
 export declare function fileExists(filePath: string): boolean;
-export declare function toRegxp(pattern: string): string | RegExp;
+export declare function toRegexp(pattern: string): string | RegExp;

package/lib/utils.js

@@ -1,12 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toRegxp = exports.fileExists = exports.uuid = exports.nonNullableFilter = void 0;
+exports.toRegexp = exports.fileExists = exports.uuid = void 0;
 const tslib_1 = require("tslib");
 const fs_1 = tslib_1.__importDefault(require("fs"));
-function nonNullableFilter(item) {
-    return !!item;
-}
-exports.nonNullableFilter = nonNullableFilter;
 let uuidNum = 0;
 function uuid() {
     const out = `${uuidNum}`;
@@ -18,11 +14,11 @@ function fileExists(filePath) {
     return fs_1.default.existsSync(filePath);
 }
 exports.fileExists = fileExists;
-function toRegxp(pattern) {
+function toRegexp(pattern) {
     const matched = pattern.match(/^\/(.+)\/([ig]*)$/i);
-    if (matched) {
+    if (matched && matched[1]) {
         return new RegExp(matched[1], matched[2]);
     }
     return pattern;
 }
-exports.toRegxp = toRegxp;
+exports.toRegexp = toRegexp;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/file-resolver",
-	"version": "3.0.0-alpha.66+6cde1134",
+	"version": "3.0.0-dev.176+f6ad62e9",
 	"description": "The file resolver of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -11,25 +11,31 @@
 	"publishConfig": {
 		"access": "public"
 	},
+	"typedoc": {
+		"entryPoint": "./src/index.ts"
+	},
 	"scripts": {
 		"build": "tsc",
 		"clean": "tsc --build --clean"
 	},
 	"devDependencies": {
-		"@types/cosmiconfig": "^6.0.0",
-		"@types/glob": "^7.2.0",
-		"@types/node": "^17.0.16"
+		"@types/node": "18.16.3"
 	},
 	"dependencies": {
-		"@markuplint/ml-ast": "2.0.1-dev.20220307.0",
-		"@markuplint/ml-config": "3.0.0-alpha.66+6cde1134",
-		"@markuplint/ml-core": "3.0.0-alpha.66+6cde1134",
-		"@markuplint/ml-spec": "3.0.0-alpha.82+6cde1134",
-		"cosmiconfig": "^7.0.1",
-		"glob": "^7.2.0",
+		"@markuplint/html-parser": "3.0.0-dev.176+f6ad62e9",
+		"@markuplint/ml-ast": "3.0.0-dev.176+f6ad62e9",
+		"@markuplint/ml-config": "3.0.0-dev.176+f6ad62e9",
+		"@markuplint/ml-core": "3.0.0-dev.176+f6ad62e9",
+		"@markuplint/ml-spec": "3.0.0-dev.176+f6ad62e9",
+		"@markuplint/shared": "3.5.1-dev.3129+f6ad62e9",
+		"@types/cosmiconfig": "^6.0.0",
+		"@types/glob": "^8.0.0",
+		"cosmiconfig": "^8.0.0",
+		"cosmiconfig-typescript-loader": "^4.3.0",
+		"glob": "^10.2.2",
 		"jsonc": "^2.0.0",
-		"minimatch": "^5.0.1",
-		"tslib": "^2.3.1"
+		"minimatch": "^9.0.0",
+		"tslib": "^2.4.1"
 	},
-	"gitHead": "6cde113402758a8fdbd6a0fcf98e78efd2cdb778"
+	"gitHead": "f6ad62e992e1569be4067f1e90d2d6017a658f57"
 }

package/__mocks__/markuplint-angular-parser.js

@@ -1,3 +0,0 @@
-module.exports = {
-	parse() {},
-};

package/__mocks__/markuplint-rule-fake.js

@@ -1 +0,0 @@
-module.exports = {};

package/__mocks__/packaged-config.js

@@ -1,3 +0,0 @@
-module.exports = {
-	mock: true,
-};

package/test/fixtures/001/package.json

@@ -1,15 +0,0 @@
-{
-	"private": true,
-	"markuplint": {
-		"dummy": true,
-		"key": "001/package.json",
-		"plugins": [
-			"a",
-			"@markuplint/file-resolver",
-			{
-				"name": "b",
-				"foo": "001"
-			}
-		]
-	}
-}

package/test/fixtures/002/.markuplintrc.json

@@ -1,52 +0,0 @@
-{
-	"extends": "../001/package.json",
-	"dummy2": false,
-	"key": "002/.markuplintrc.json",
-	"plugins": [
-		{
-			"name": "@markuplint/file-resolver",
-			"foo": "002"
-		},
-		{
-			"name": "b",
-			"foo": "002"
-		}
-	],
-	"rules": {
-		"rule__enabled": true,
-		"rule__disabled": false,
-		"rule__custom-setting": {
-			"severity": "error",
-			"value": "VALUE"
-		},
-		"rule__custom-setting-with-detail-option": {
-			"value": "VALUE",
-			"option": {
-				"OPTIONAL_PROP": "OPTIONAL_VALUE"
-			}
-		},
-		"rule__custom-setting2": {
-			"severity": "error",
-			"value": "VALUE"
-		}
-	},
-	"nodeRules": [
-		{
-			"selector": "div",
-			"rules": {
-				"rule__disable-for-div-tag": false
-			}
-		}
-	],
-	"childNodeRules": [
-		{
-			"selector": "[data-attr^=\"value\"]",
-			"inheritance": true,
-			"rules": {
-				"rule__overwrite-setting-of-selector-matched-element": {
-					"value": "OVERWROTE_VALUE"
-				}
-			}
-		}
-	]
-}

package/test/fixtures/003/.markuplintrc

@@ -1,50 +0,0 @@
-{
-	"extends": ["plugin:foo/bar-config", "../002/.markuplintrc.json", "markuplint:___test"],
-	"dummy2": true,
-	"key": "003/.markuplintrc",
-	"key2": "001-2.js",
-	"plugins": ["../../plugins/001.js"],
-	"rules": {
-		"rule__enabled": false,
-		"rule__disabled": true,
-		"rule__custom-setting": {
-			"severity": "error",
-			"value": "CHANGED_VALUE"
-		},
-		"rule__custom-setting-with-detail-option": {
-			"value": "VALUE",
-			"option": {
-				"OPTIONAL_PROP": "CHANGED_OPTIONAL_VALUE"
-			}
-		},
-		"rule__custom-setting2": false,
-		"additional_rule": {
-			"value": "VALUE"
-		}
-	},
-	"nodeRules": [
-		{
-			"selector": "div",
-			"rules": {
-				"rule__disable-for-div-tag": true
-			}
-		},
-		{
-			"selector": "a",
-			"rules": {
-				"rule__enble-for-a-tag": true
-			}
-		}
-	],
-	"childNodeRules": [
-		{
-			"selector": "[data-attr^=\"value\"]",
-			"inheritance": false,
-			"rules": {
-				"rule__overwrite-setting-of-selector-matched-element": {
-					"value": "OVERWROTE_VALUE"
-				}
-			}
-		}
-	]
-}

package/test/fixtures/004/.markuplintrc

@@ -1,4 +0,0 @@
-{
-	"extends": ["./dir/dir/dir/dir/dir/.markuplintrc"],
-	"dir01": true
-}

package/test/fixtures/004/dir/.markuplintrc

@@ -1,4 +0,0 @@
-{
-	"extends": ["../.markuplintrc"],
-	"dir02": true
-}

package/test/fixtures/004/dir/dir/.markuplintrc

@@ -1,4 +0,0 @@
-{
-	"extends": ["../.markuplintrc"],
-	"dir03": true
-}

package/test/fixtures/004/dir/dir/dir/.markuplintrc

@@ -1,4 +0,0 @@
-{
-	"extends": ["../.markuplintrc"],
-	"dir04": true
-}

package/test/fixtures/004/dir/dir/dir/dir/.markuplintrc

@@ -1,4 +0,0 @@
-{
-	"extends": ["../.markuplintrc"],
-	"dir05": true
-}

package/test/fixtures/004/dir/dir/dir/dir/dir/.markuplintrc

@@ -1,4 +0,0 @@
-{
-	"extends": ["../.markuplintrc"],
-	"dir06": true
-}

package/test/fixtures/005/.markuplintrc

@@ -1,4 +0,0 @@
-{
-	// With Comment
-	"extends": ["packaged-config"]
-}

package/test/fixtures/006/.markuplintrc

@@ -1,12 +0,0 @@
-{
-	"rules": {
-		"foo": true
-	},
-	"overrides": {
-		"./*.html": {
-			"rules": {
-				"foo": false
-			}
-		}
-	}
-}

package/test/plugins/001.js

@@ -1,27 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const { createPlugin } = require('@markuplint/ml-core');
-
-module.exports = createPlugin({
-	name: 'foo',
-	create(settings) {
-		return {
-			rules: {
-				bar: {
-					verify: async () => [],
-				},
-			},
-			configs: {
-				'bar-config': {
-					key: '001.js',
-					key2: '001-2.js',
-					rules: {
-						xxx: 'yyy',
-						zzz: {
-							severity: 'error',
-						},
-					},
-				},
-			},
-		};
-	},
-});

package/test/plugins/002.js

@@ -1,9 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const { createPlugin } = require('@markuplint/ml-core');
-
-module.exports = createPlugin({
-	// No name
-	create() {
-		return {};
-	},
-});

package/tsconfig.test.json

@@ -1,3 +0,0 @@
-{
-	"extends": "../../../tsconfig.json"
-}