Skip to content

Commit 53ff5c4

Browse files
DavidAnsonDavidAnson
committed
Stop using module.createRequire (problematic under webpack), incorporate and export resolveModule helper from markdownlint-cli2.
1 parent a1da464 commit 53ff5c4

16 files changed

Lines changed: 327 additions & 25 deletions

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ demo/markdownlint-browser.js
44
demo/markdownlint-browser.min.js
55
node_modules
66
!test/node_modules
7+
!test/rules/node_modules
78
npm-debug.log
89
test-repos
910
.DS_Store

‎lib/defer-require.cjs‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// @ts-check
2+
3+
"use strict";
4+
5+
/**
6+
* Calls require for markdownit.cjs. Used to synchronously defer loading because module.createRequire is buggy under webpack (https://github.com/webpack/webpack/issues/16724).
7+
*
8+
* @returns {any} Exported module content.
9+
*/
10+
function requireMarkdownItCjs() {
11+
return require("./markdownit.cjs");
12+
}
13+
14+
module.exports = {
15+
requireMarkdownItCjs
16+
};

‎lib/exports.d.mts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
export { resolveModule } from "./resolve-module.cjs";
12
export type Configuration = import("./markdownlint.mjs").Configuration;
23
export type ConfigurationParser = import("./markdownlint.mjs").ConfigurationParser;
34
export type ConfigurationStrict = import("./markdownlint.mjs").ConfigurationStrict;

‎lib/exports.mjs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// @ts-check
22

33
export { applyFix, applyFixes, getVersion } from "./markdownlint.mjs";
4+
export { resolveModule } from "./resolve-module.cjs";
45

56
/** @typedef {import("./markdownlint.mjs").Configuration} Configuration */
67
/** @typedef {import("./markdownlint.mjs").ConfigurationParser} ConfigurationParser */

‎lib/markdownlint.mjs‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
// @ts-check
22

33
// @ts-ignore
4-
import { fs as nodeFs, module, os, path } from "#node-imports";
5-
const dynamicRequire = module.createRequire(import.meta.url);
4+
import { fs as nodeFs, os, path } from "#node-imports";
65
import { initialize as cacheInitialize } from "./cache.mjs";
76
import { version } from "./constants.mjs";
7+
import { requireMarkdownItCjs } from "./defer-require.cjs";
8+
import { resolveModule } from "./resolve-module.cjs";
89
import rules from "./rules.mjs";
910
import { parse as micromarkParse } from "./micromark-parse.mjs";
1011
import * as helpers from "../helpers/helpers.cjs";
@@ -501,7 +502,7 @@ function lintContent(
501502
// Parse content into lines and get markdown-it tokens
502503
const lines = content.split(helpers.newLineRe);
503504
const markdownitTokens = needMarkdownItTokens ?
504-
dynamicRequire("./markdownit.cjs").getMarkdownItTokens(markdownItPlugins, preClearedContent, lines) :
505+
requireMarkdownItCjs().getMarkdownItTokens(markdownItPlugins, preClearedContent, lines) :
505506
[];
506507
// Create (frozen) parameters for rules
507508
/** @type {MarkdownParsers} */
@@ -1010,10 +1011,10 @@ function resolveConfigExtends(configFile, referenceId, fs, callback) {
10101011
if (err) {
10111012
// Not a file, try require.resolve
10121013
try {
1013-
return callback(null, dynamicRequire.resolve(
1014-
referenceId,
1015-
{ "paths": [ configFileDirname ] }
1016-
));
1014+
return callback(
1015+
null,
1016+
resolveModule(referenceId, [ configFileDirname ])
1017+
);
10171018
} catch {
10181019
// Unable to resolve, use resolvedExtendsFile
10191020
}
@@ -1041,10 +1042,7 @@ function resolveConfigExtendsSync(configFile, referenceId, fs) {
10411042
// Not a file, try require.resolve
10421043
}
10431044
try {
1044-
return dynamicRequire.resolve(
1045-
referenceId,
1046-
{ "paths": [ configFileDirname ] }
1047-
);
1045+
return resolveModule(referenceId, [ configFileDirname ]);
10481046
} catch {
10491047
// Unable to resolve, return resolvedExtendsFile
10501048
}

‎lib/node-imports-browser-module.cjs‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎lib/node-imports-browser.mjs‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ export const fs = {
1212
"readFileSync": throwForSync
1313
};
1414

15-
export { default as module } from "./node-imports-browser-module.cjs";
16-
1715
export const os = {};
1816

1917
export const path = {

‎lib/node-imports-node.mjs‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@
33
import { access, accessSync, readFile, readFileSync } from "node:fs";
44
export const fs = { access, accessSync, readFile, readFileSync };
55

6-
import { createRequire } from "node:module";
7-
export const module = { createRequire };
8-
96
import { EOL, homedir } from "node:os";
107
export const os = { EOL, homedir };
118

‎lib/resolve-module.cjs‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
// @ts-check
2+
3+
"use strict";
4+
5+
// @ts-ignore
6+
// eslint-disable-next-line camelcase, no-inline-comments, no-undef
7+
const nativeRequire = (typeof __non_webpack_require__ === "undefined") ? require : /* c8 ignore next */ __non_webpack_require__;
8+
// Captures the native require implementation (even under webpack).
9+
10+
/**
11+
* @typedef RequireResolveOptions
12+
* @property {string[]} [paths] Additional paths to resolve from.
13+
*/
14+
15+
/**
16+
* @callback RequireResolve
17+
* @param {string} id Module name or path.
18+
* @param {RequireResolveOptions} options Options to apply.
19+
* @returns {string} Resolved module path.
20+
*/
21+
22+
/**
23+
* Resolves modules according to Node's resolution rules.
24+
*
25+
* @param {RequireResolve} resolve Node-like require.resolve implementation.
26+
* @param {string} id Module name or path.
27+
* @param {string[]} [paths] Additional paths to resolve from.
28+
* @returns {string} Resolved module path.
29+
*/
30+
const resolveModuleCustomResolve = (resolve, id, paths = []) => {
31+
// resolve.paths is sometimes not present under webpack or VS Code
32+
// @ts-ignore
33+
const resolvePaths = resolve.paths?.("") || [];
34+
const allPaths = [ ...paths, ...resolvePaths ];
35+
return resolve(id, { "paths": allPaths });
36+
};
37+
38+
/**
39+
* Resolves modules according to Node's resolution rules.
40+
*
41+
* @param {string} id Module name or path.
42+
* @param {string[]} [paths] Additional paths to resolve from.
43+
* @returns {string} Resolved module path.
44+
*/
45+
const resolveModule = (id, paths) => (
46+
resolveModuleCustomResolve(nativeRequire.resolve, id, paths)
47+
);
48+
49+
module.exports = {
50+
resolveModule,
51+
resolveModuleCustomResolve
52+
};

‎lib/resolve-module.d.cts‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
export type RequireResolveOptions = {
2+
/**
3+
* Additional paths to resolve from.
4+
*/
5+
paths?: string[];
6+
};
7+
export type RequireResolve = (id: string, options: RequireResolveOptions) => string;
8+
/**
9+
* Resolves modules according to Node's resolution rules.
10+
*
11+
* @param {string} id Module name or path.
12+
* @param {string[]} [paths] Additional paths to resolve from.
13+
* @returns {string} Resolved module path.
14+
*/
15+
export function resolveModule(id: string, paths?: string[]): string;
16+
/**
17+
* @typedef RequireResolveOptions
18+
* @property {string[]} [paths] Additional paths to resolve from.
19+
*/
20+
/**
21+
* @callback RequireResolve
22+
* @param {string} id Module name or path.
23+
* @param {RequireResolveOptions} options Options to apply.
24+
* @returns {string} Resolved module path.
25+
*/
26+
/**
27+
* Resolves modules according to Node's resolution rules.
28+
*
29+
* @param {RequireResolve} resolve Node-like require.resolve implementation.
30+
* @param {string} id Module name or path.
31+
* @param {string[]} [paths] Additional paths to resolve from.
32+
* @returns {string} Resolved module path.
33+
*/
34+
export function resolveModuleCustomResolve(resolve: RequireResolve, id: string, paths?: string[]): string;

0 commit comments

Comments
 (0)