@markuplint/file-resolver 4.7.2 → 4.8.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.8.0](https://github.com/markuplint/markuplint/compare/@markuplint/file-resolver@4.7.2...@markuplint/file-resolver@4.8.0) (2024-05-28)
+
+### Features
+
+- **file-resolver:** `configProvider` resolves paths of `pretenders` field ([08ccc73](https://github.com/markuplint/markuplint/commit/08ccc7306ac748ce66e33ab571dab1a2eeace12e))
+- **file-resolver:** `generalImport` supports to access protected path in module ([6d0c60e](https://github.com/markuplint/markuplint/commit/6d0c60e25d63d31a150a5f2cf7c41bef481302d4))
+- **file-resolver:** add `resolve-pretenders` function ([68ba7f5](https://github.com/markuplint/markuplint/commit/68ba7f5acaba13484172bca3ea5f60e0bf3044ef))
+
 ## [4.7.2](https://github.com/markuplint/markuplint/compare/@markuplint/file-resolver@4.7.1...@markuplint/file-resolver@4.7.2) (2024-05-12)
 
 **Note:** Version bump only for package @markuplint/file-resolver

package/lib/config-provider.d.ts

@@ -1,6 +1,6 @@
 import type { MLFile } from './ml-file/index.js';
 import type { ConfigSet } from './types.js';
-import type { Config } from '@markuplint/ml-config';
+import type { OptimizedConfig } from '@markuplint/ml-config';
 import type { Nullable } from '@markuplint/shared';
 export declare class ConfigProvider {
     #private;
@@ -10,7 +10,7 @@ export declare class ConfigProvider {
     }>;
     resolve(targetFile: Readonly<MLFile>, names: readonly Nullable<string>[], cache?: boolean): Promise<ConfigSet>;
     search(targetFile: Readonly<MLFile>): Promise<string | null>;
-    set(config: Config, key?: string): string;
+    set(config: OptimizedConfig, key?: string): string;
     private _load;
     private _mergeConfigs;
     private _pathResolve;

package/lib/config-provider.js

@@ -98,7 +98,7 @@ export class ConfigProvider {
                         const plugin = plugins.find(plugin => plugin.name === namespace);
                         const config = plugin?.configs?.[name ?? ''];
                         if (config) {
-                            this.set(config, held);
+                            this.set(mergeConfig(config), held);
                         }
                         break;
                     }
@@ -212,15 +212,22 @@ export class ConfigProvider {
         };
     }
     async _pathResolve(config, filePath) {
+        const optimizedConfig = mergeConfig(config);
         const dir = path.dirname(filePath);
         return {
-            ...config,
-            extends: await relPathToNameOrAbsPath(dir, config.extends),
-            plugins: await relPathToNameOrAbsPath(dir, config.plugins, ['name']),
-            parser: await relPathToNameOrAbsPath(dir, config.parser),
-            specs: await relPathToNameOrAbsPath(dir, config.specs),
-            excludeFiles: await relPathToNameOrAbsPath(dir, config.excludeFiles),
-            overrides: await relPathToNameOrAbsPath(dir, config.overrides, undefined, true),
+            ...optimizedConfig,
+            extends: await relPathToNameOrAbsPath(dir, optimizedConfig.extends),
+            plugins: await relPathToNameOrAbsPath(dir, optimizedConfig.plugins, ['name']),
+            parser: await relPathToNameOrAbsPath(dir, optimizedConfig.parser),
+            specs: await relPathToNameOrAbsPath(dir, optimizedConfig.specs),
+            excludeFiles: await relPathToNameOrAbsPath(dir, optimizedConfig.excludeFiles),
+            pretenders: optimizedConfig.pretenders
+                ? {
+                    ...optimizedConfig.pretenders,
+                    files: await relPathToNameOrAbsPath(dir, optimizedConfig.pretenders?.files),
+                }
+                : undefined,
+            overrides: await relPathToNameOrAbsPath(dir, optimizedConfig.overrides, undefined, true),
         };
     }
     _validateConfig(config, filePath) {

package/lib/general-import.js

@@ -1,6 +1,11 @@
+import fs from 'node:fs/promises';
 import { createRequire } from 'node:module';
+import path from 'node:path';
+import { resolve } from 'import-meta-resolve';
 import { log } from './debug.js';
 const gLog = log.extend('general-import');
+const gLogSuccess = gLog.extend('success');
+const gLogError = gLog.extend('error');
 const cache = new Map();
 const require = createRequire(import.meta.url);
 export async function generalImport(name) {
@@ -10,6 +15,7 @@ export async function generalImport(name) {
     try {
         const imported = await import(name);
         const mod = imported?.default ?? imported ?? null;
+        gLogSuccess('Success by import("%s"): %O', name, mod);
         cache.set(name, mod);
         return mod;
     }
@@ -21,19 +27,40 @@ export async function generalImport(name) {
             error.code === 'ERR_IMPORT_ASSERTION_TYPE_MISSING') {
             try {
                 const mod = require(name) ?? null;
+                gLogSuccess('Success by require("%s"): %O', name, mod);
                 cache.set(name, mod);
                 return mod;
             }
             catch (error) {
                 if (error instanceof Error && /^parse failure/i.test(error.message)) {
-                    gLog('Error in `createRequire(import.meta.url)()`: %O', error);
+                    gLogError('Error in `createRequire(import.meta.url)()`: %O', error);
                     cache.set(name, null);
                     return null;
                 }
-                gLog('Error in generalImport: %O', error);
+                gLogError('Error in generalImport: %O', error);
             }
         }
-        gLog('Error in `import()`: %O', error);
+        if (error instanceof Error) {
+            const { filePath, packageName } = /Missing\s"(?<filePath>[^"]+)"\sspecifier\sin\s"(?<packageName>[^"]+)"\spackage/.exec(error.message)
+                ?.groups ?? {};
+            if (filePath && packageName) {
+                const modFile = resolve(packageName, import.meta.url);
+                const modPath = path.dirname(modFile);
+                const candidate = path.join(modPath, filePath);
+                gLog('Try import absolute path: "%s"', candidate);
+                const result = await generalImport(candidate);
+                cache.set(name, result);
+                return result;
+            }
+        }
+        if (path.isAbsolute(name) && name.endsWith('.json')) {
+            const file = await fs.readFile(name, 'utf8');
+            const json = JSON.parse(file);
+            gLogSuccess('Success by readFile("%s") and JSON.parse: %O', name, json);
+            cache.set(name, json);
+            return json;
+        }
+        gLogError('Error in `import()`: %O', error);
         cache.set(name, null);
         return null;
     }

package/lib/index.d.ts

@@ -2,6 +2,7 @@ export type { MLFile } from './ml-file/index.js';
 export * from './config-provider.js';
 export * from './resolve-files.js';
 export * from './resolve-parser.js';
+export * from './resolve-pretenders.js';
 export * from './resolve-rules.js';
 export * from './resolve-specs.js';
 export * from './types.js';

package/lib/index.js

@@ -1,6 +1,7 @@
 export * from './config-provider.js';
 export * from './resolve-files.js';
 export * from './resolve-parser.js';
+export * from './resolve-pretenders.js';
 export * from './resolve-rules.js';
 export * from './resolve-specs.js';
 export * from './types.js';

package/lib/resolve-pretenders.d.ts

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

package/lib/resolve-pretenders.js

@@ -0,0 +1,32 @@
+import { generalImport } from './general-import.js';
+export async function resolvePretenders(config) {
+    if (!config) {
+        return [];
+    }
+    const data = [];
+    if (config.files) {
+        for (const file of config.files) {
+            const pretenderFile = await generalImport(file);
+            if (!pretenderFile?.data) {
+                continue;
+            }
+            data.push(...pretenderFile.data);
+        }
+    }
+    if (config.imports) {
+        for (const module of config.imports) {
+            const pretenderFile = 
+            // eslint-disable-next-line unicorn/no-await-expression-member
+            (await generalImport(`${module}/package.json`))?.pretenders ??
+                (await generalImport(`${module}/pretenders.json`));
+            if (!pretenderFile?.data) {
+                continue;
+            }
+            data.push(...pretenderFile.data);
+        }
+    }
+    if (config.data) {
+        data.push(...config.data);
+    }
+    return data;
+}

package/lib/types.d.ts

@@ -1,7 +1,7 @@
-import type { Config } from '@markuplint/ml-config';
+import type { OptimizedConfig } from '@markuplint/ml-config';
 import type { Plugin } from '@markuplint/ml-core';
 export interface ConfigSet {
-    readonly config: Config;
+    readonly config: OptimizedConfig;
     readonly plugins: readonly Plugin[];
     readonly files: ReadonlySet<string>;
     readonly errs: readonly Readonly<Error>[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/file-resolver",
-	"version": "4.7.2",
+	"version": "4.8.0",
 	"description": "The file resolver of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -24,23 +24,24 @@
 		"clean": "tsc --build --clean"
 	},
 	"devDependencies": {
-		"@types/node": "20.12.11"
+		"@types/node": "20.12.12"
 	},
 	"dependencies": {
-		"@markuplint/html-parser": "4.6.2",
-		"@markuplint/ml-ast": "4.3.1",
-		"@markuplint/ml-config": "4.6.2",
-		"@markuplint/ml-core": "4.7.2",
-		"@markuplint/ml-spec": "4.6.0",
-		"@markuplint/parser-utils": "4.6.2",
-		"@markuplint/selector": "4.6.2",
-		"@markuplint/shared": "4.4.0",
+		"@markuplint/html-parser": "4.6.3",
+		"@markuplint/ml-ast": "4.4.0",
+		"@markuplint/ml-config": "4.7.0",
+		"@markuplint/ml-core": "4.8.0",
+		"@markuplint/ml-spec": "4.6.1",
+		"@markuplint/parser-utils": "4.6.3",
+		"@markuplint/selector": "4.6.3",
+		"@markuplint/shared": "4.4.1",
 		"cosmiconfig": "9.0.0",
 		"debug": "4.3.4",
-		"glob": "10.3.15",
+		"glob": "10.4.1",
 		"ignore": "5.3.1",
+		"import-meta-resolve": "4.1.0",
 		"jsonc": "2.0.0",
 		"minimatch": "9.0.4"
 	},
-	"gitHead": "ca7dc6bf40eac4f2813e492878f889eb77751a70"
+	"gitHead": "bf70c41b1d2497e85b73c9ecd5551eb522e6bdfc"
 }