forked from wellcometrust/next-plugin-transpile-modules
-
-
Notifications
You must be signed in to change notification settings - Fork 85
/
next-transpile-modules.js
290 lines (244 loc) · 9.34 KB
/
next-transpile-modules.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
/**
* disclaimer:
*
* THIS PLUGIN IS A F*CKING BIG HACK.
*
* don't even try to reason about the quality of the following lines of code.
*/
const path = require('path');
const process = require('process');
const enhancedResolve = require('enhanced-resolve');
const escalade = require('escalade/sync');
// Use me when needed
// const util = require('util');
// const inspect = (object) => {
// console.log(util.inspect(object, { showHidden: false, depth: null }));
// };
const CWD = process.cwd();
/**
* Our own Node.js resolver that can ignore symlinks resolution and can support
* PnP
*/
const resolve = enhancedResolve.create.sync({
symlinks: false,
extensions: ['.js', '.jsx', '.ts', '.tsx', '.mjs', '.css', '.scss', '.sass'],
mainFields: ['main', 'module', 'source'],
// Is it right? https://github.com/webpack/enhanced-resolve/issues/283#issuecomment-775162497
conditionNames: ['require'],
});
/**
* Check if two regexes are equal
* Stolen from https://stackoverflow.com/questions/10776600/testing-for-equality-of-regular-expressions
*
* @param {RegExp} x
* @param {RegExp} y
* @returns {boolean}
*/
const regexEqual = (x, y) => {
return (
x instanceof RegExp &&
y instanceof RegExp &&
x.source === y.source &&
x.global === y.global &&
x.ignoreCase === y.ignoreCase &&
x.multiline === y.multiline
);
};
/**
* Return the root path (package.json directory) of a given module
* @param {string} module
* @returns {string}
*/
const getPackageRootDirectory = (module) => {
let packageDirectory;
let packageRootDirectory;
try {
// Get the module path
packageDirectory = resolve(CWD, module);
if (!packageDirectory) {
throw new Error(
`next-transpile-modules - could not resolve module "${module}". Are you sure the name of the module you are trying to transpile is correct?`
);
}
// Get the location of its package.json
const pkgPath = escalade(packageDirectory, (dir, names) => {
if (names.includes('package.json')) {
return 'package.json';
}
return false;
});
if (pkgPath == null) {
throw new Error(
`next-transpile-modules - an error happened when trying to get the root directory of "${module}". Is it missing a package.json?\n${err}`
);
}
packageRootDirectory = path.dirname(pkgPath);
} catch (err) {
throw new Error(`next-transpile-modules - an unexpected error happened when trying to resolve "${module}"\n${err}`);
}
return packageRootDirectory;
};
/**
* Resolve modules to their real paths
* @param {string[]} modules
* @returns {string[]}
*/
const generateModulesPaths = (modules) => {
const packagesPaths = modules.map(getPackageRootDirectory);
return packagesPaths;
};
/**
* Logger for the debug mode
* @param {boolean} enable enable the logger or not
* @returns {(message: string, force: boolean) => void}
*/
const createLogger = (enable) => {
return (message, force) => {
if (enable || force) console.info(`next-transpile-modules - ${message}`);
};
};
/**
* Matcher function for webpack to decide which modules to transpile
* @param {string[]} modulesToTranspile
* @param {function} logger
* @returns {(path: string) => boolean}
*/
const createWebpackMatcher = (modulesToTranspile, logger = createLogger(false)) => {
return (filePath) => {
const isNestedNodeModules = (filePath.match(/node_modules/g) || []).length > 1;
if (isNestedNodeModules) {
return false;
}
return modulesToTranspile.some((modulePath) => {
const transpiled = filePath.startsWith(modulePath);
if (transpiled) logger(`transpiled: ${filePath}`);
return transpiled;
});
};
};
/**
* Transpile modules with Next.js Babel configuration
* @param {string[]} modules
* @param {{resolveSymlinks?: boolean, debug?: boolean, __unstable_matcher: (path: string) => boolean}} options
*/
const withTmInitializer = (modules = [], options = {}) => {
const withTM = (nextConfig = {}) => {
if (modules.length === 0) return nextConfig;
const resolveSymlinks = options.resolveSymlinks || false;
const isWebpack5 = (nextConfig.future && nextConfig.future.webpack5) || false;
const debug = options.debug || false;
const logger = createLogger(debug);
const modulesPaths = generateModulesPaths(modules);
if (isWebpack5) logger(`WARNING experimental Webpack 5 support enabled`, true);
logger(`the following paths will get transpiled:\n${modulesPaths.map((mod) => ` - ${mod}`).join('\n')}`);
// Generate Webpack condition for the passed modules
// https://webpack.js.org/configuration/module/#ruleinclude
const matcher = options.__unstable_matcher || createWebpackMatcher(modulesPaths, logger);
return Object.assign({}, nextConfig, {
webpack(config, options) {
// Safecheck for Next < 5.0
if (!options.defaultLoaders) {
throw new Error(
'This plugin is not compatible with Next.js versions below 5.0.0 https://err.sh/next-plugins/upgrade'
);
}
// Avoid Webpack to resolve transpiled modules path to their real path as
// we want to test modules from node_modules only. If it was enabled,
// modules in node_modules installed via symlink would then not be
// transpiled.
config.resolve.symlinks = resolveSymlinks;
const hasInclude = (context, request) => {
const test = modulesPaths.some((mod) => {
// If we the code requires/import an absolute path
if (!request.startsWith('.')) {
try {
const moduleDirectory = getPackageRootDirectory(request);
if (!moduleDirectory) return false;
return moduleDirectory.includes(mod);
} catch (err) {
return false;
}
}
// Otherwise, for relative imports
return path.resolve(context, request).includes(mod);
});
return test;
};
// Since Next.js 8.1.0, config.externals is undefined
if (config.externals) {
config.externals = config.externals.map((external) => {
if (typeof external !== 'function') return external;
if (isWebpack5) {
return async ({ context, request, getResolve }) => {
if (hasInclude(context, request)) return;
return external({ context, request, getResolve });
};
}
return (context, request, cb) => {
return hasInclude(context, request) ? cb() : external(context, request, cb);
};
});
}
// Add a rule to include and parse all modules (js & ts)
if (isWebpack5) {
config.module.rules.push({
test: /\.+(js|jsx|mjs|ts|tsx)$/,
use: options.defaultLoaders.babel,
include: matcher,
});
// IMPROVE ME: we are losing all the cache on node_modules, which is terrible
// The problem is managedPaths does not allow to isolate specific specific folders
config.snapshot = Object.assign(config.snapshot || {}, {
managedPaths: [],
});
} else {
config.module.rules.push({
test: /\.+(js|jsx|mjs|ts|tsx)$/,
loader: options.defaultLoaders.babel,
include: matcher,
});
}
// Support CSS modules + global in node_modules
// TODO ask Next.js maintainer to expose the css-loader via defaultLoaders
const nextCssLoaders = config.module.rules.find((rule) => typeof rule.oneOf === 'object');
// .module.css
if (nextCssLoaders) {
const nextCssLoader = nextCssLoaders.oneOf.find(
(rule) => rule.sideEffects === false && regexEqual(rule.test, /\.module\.css$/)
);
const nextSassLoader = nextCssLoaders.oneOf.find(
(rule) => rule.sideEffects === false && regexEqual(rule.test, /\.module\.(scss|sass)$/)
);
if (nextCssLoader) {
nextCssLoader.issuer.or = nextCssLoader.issuer.and ? nextCssLoader.issuer.and.concat(matcher) : matcher;
delete nextCssLoader.issuer.not;
delete nextCssLoader.issuer.and;
} else {
console.warn('next-transpile-modules - could not find default CSS rule, CSS imports may not work');
}
if (nextSassLoader) {
nextSassLoader.issuer.or = nextSassLoader.issuer.and ? nextSassLoader.issuer.and.concat(matcher) : matcher;
delete nextSassLoader.issuer.not;
delete nextSassLoader.issuer.and;
} else {
console.warn('next-transpile-modules - could not find default SASS rule, SASS imports may not work');
}
}
// Make hot reloading work!
// FIXME: not working on Wepback 5
// https://github.com/vercel/next.js/issues/13039
config.watchOptions.ignored = [
...config.watchOptions.ignored.filter((pattern) => pattern !== '**/node_modules/**'),
`**node_modules/{${modules.map((mod) => `!(${mod})`).join(',')}}/**/*`,
];
// Overload the Webpack config if it was already overloaded
if (typeof nextConfig.webpack === 'function') {
return nextConfig.webpack(config, options);
}
return config;
},
});
};
return withTM;
};
module.exports = withTmInitializer;