Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 1 | 'use strict'; |
| 2 | exports.__esModule = true; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 3 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 4 | const fs = require('fs'); |
| 5 | const Module = require('module'); |
| 6 | const path = require('path'); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 7 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 8 | const hashObject = require('./hash').hashObject; |
| 9 | const ModuleCache = require('./ModuleCache').default; |
Tim van der Lippe | 0ceb465 | 2022-01-06 14:23:36 +0100 | [diff] [blame] | 10 | const pkgDir = require('./pkgDir').default; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 11 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 12 | const CASE_SENSITIVE_FS = !fs.existsSync(path.join(__dirname.toUpperCase(), 'reSOLVE.js')); |
| 13 | exports.CASE_SENSITIVE_FS = CASE_SENSITIVE_FS; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 14 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 15 | const ERROR_NAME = 'EslintPluginImportResolveError'; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 16 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 17 | const fileExistsCache = new ModuleCache(); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 18 | |
| 19 | // Polyfill Node's `Module.createRequireFromPath` if not present (added in Node v10.12.0) |
| 20 | // Use `Module.createRequire` if available (added in Node v12.2.0) |
| 21 | const createRequire = Module.createRequire || Module.createRequireFromPath || function (filename) { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 22 | const mod = new Module(filename, null); |
| 23 | mod.filename = filename; |
| 24 | mod.paths = Module._nodeModulePaths(path.dirname(filename)); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 25 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 26 | mod._compile(`module.exports = require;`, filename); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 27 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 28 | return mod.exports; |
| 29 | }; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 30 | |
| 31 | function tryRequire(target, sourceFile) { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 32 | let resolved; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 33 | try { |
| 34 | // Check if the target exists |
| 35 | if (sourceFile != null) { |
| 36 | try { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 37 | resolved = createRequire(path.resolve(sourceFile)).resolve(target); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 38 | } catch (e) { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 39 | resolved = require.resolve(target); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 40 | } |
| 41 | } else { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 42 | resolved = require.resolve(target); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 43 | } |
Tim van der Lippe | bc3a0b7 | 2021-11-08 15:22:37 +0000 | [diff] [blame] | 44 | } catch (e) { |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 45 | // If the target does not exist then just return undefined |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 46 | return undefined; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 47 | } |
| 48 | |
| 49 | // If the target exists then return the loaded module |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 50 | return require(resolved); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 51 | } |
| 52 | |
Tim van der Lippe | 0ceb465 | 2022-01-06 14:23:36 +0100 | [diff] [blame] | 53 | // https://stackoverflow.com/a/27382838 |
Tim van der Lippe | bc3a0b7 | 2021-11-08 15:22:37 +0000 | [diff] [blame] | 54 | exports.fileExistsWithCaseSync = function fileExistsWithCaseSync(filepath, cacheSettings, strict) { |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 55 | // don't care if the FS is case-sensitive |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 56 | if (CASE_SENSITIVE_FS) return true; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 57 | |
| 58 | // null means it resolved to a builtin |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 59 | if (filepath === null) return true; |
Tim van der Lippe | bc3a0b7 | 2021-11-08 15:22:37 +0000 | [diff] [blame] | 60 | if (filepath.toLowerCase() === process.cwd().toLowerCase() && !strict) return true; |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 61 | const parsedPath = path.parse(filepath); |
| 62 | const dir = parsedPath.dir; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 63 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 64 | let result = fileExistsCache.get(filepath, cacheSettings); |
| 65 | if (result != null) return result; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 66 | |
| 67 | // base case |
| 68 | if (dir === '' || parsedPath.root === filepath) { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 69 | result = true; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 70 | } else { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 71 | const filenames = fs.readdirSync(dir); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 72 | if (filenames.indexOf(parsedPath.base) === -1) { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 73 | result = false; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 74 | } else { |
Tim van der Lippe | bc3a0b7 | 2021-11-08 15:22:37 +0000 | [diff] [blame] | 75 | result = fileExistsWithCaseSync(dir, cacheSettings, strict); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 76 | } |
| 77 | } |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 78 | fileExistsCache.set(filepath, result); |
| 79 | return result; |
| 80 | }; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 81 | |
| 82 | function relative(modulePath, sourceFile, settings) { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 83 | return fullResolve(modulePath, sourceFile, settings).path; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 84 | } |
| 85 | |
| 86 | function fullResolve(modulePath, sourceFile, settings) { |
| 87 | // check if this is a bonus core module |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 88 | const coreSet = new Set(settings['import/core-modules']); |
| 89 | if (coreSet.has(modulePath)) return { found: true, path: null }; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 90 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 91 | const sourceDir = path.dirname(sourceFile); |
| 92 | const cacheKey = sourceDir + hashObject(settings).digest('hex') + modulePath; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 93 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 94 | const cacheSettings = ModuleCache.getSettings(settings); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 95 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 96 | const cachedPath = fileExistsCache.get(cacheKey, cacheSettings); |
| 97 | if (cachedPath !== undefined) return { found: true, path: cachedPath }; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 98 | |
| 99 | function cache(resolvedPath) { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 100 | fileExistsCache.set(cacheKey, resolvedPath); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 101 | } |
| 102 | |
| 103 | function withResolver(resolver, config) { |
| 104 | |
| 105 | function v1() { |
| 106 | try { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 107 | const resolved = resolver.resolveImport(modulePath, sourceFile, config); |
| 108 | if (resolved === undefined) return { found: false }; |
| 109 | return { found: true, path: resolved }; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 110 | } catch (err) { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 111 | return { found: false }; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 112 | } |
| 113 | } |
| 114 | |
| 115 | function v2() { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 116 | return resolver.resolve(modulePath, sourceFile, config); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 117 | } |
| 118 | |
| 119 | switch (resolver.interfaceVersion) { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 120 | case 2: |
| 121 | return v2(); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 122 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 123 | default: |
| 124 | case 1: |
| 125 | return v1(); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 126 | } |
| 127 | } |
| 128 | |
| 129 | const configResolvers = (settings['import/resolver'] |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 130 | || { 'node': settings['import/resolve'] }); // backward compatibility |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 131 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 132 | const resolvers = resolverReducer(configResolvers, new Map()); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 133 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 134 | for (const pair of resolvers) { |
| 135 | const name = pair[0]; |
| 136 | const config = pair[1]; |
| 137 | const resolver = requireResolver(name, sourceFile); |
| 138 | const resolved = withResolver(resolver, config); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 139 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 140 | if (!resolved.found) continue; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 141 | |
| 142 | // else, counts |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 143 | cache(resolved.path); |
| 144 | return resolved; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 145 | } |
| 146 | |
| 147 | // failed |
| 148 | // cache(undefined) |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 149 | return { found: false }; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 150 | } |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 151 | exports.relative = relative; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 152 | |
| 153 | function resolverReducer(resolvers, map) { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 154 | if (Array.isArray(resolvers)) { |
| 155 | resolvers.forEach(r => resolverReducer(r, map)); |
| 156 | return map; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 157 | } |
| 158 | |
| 159 | if (typeof resolvers === 'string') { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 160 | map.set(resolvers, null); |
| 161 | return map; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 162 | } |
| 163 | |
| 164 | if (typeof resolvers === 'object') { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 165 | for (const key in resolvers) { |
| 166 | map.set(key, resolvers[key]); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 167 | } |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 168 | return map; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 169 | } |
| 170 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 171 | const err = new Error('invalid resolver config'); |
| 172 | err.name = ERROR_NAME; |
| 173 | throw err; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 174 | } |
| 175 | |
| 176 | function getBaseDir(sourceFile) { |
Tim van der Lippe | 0ceb465 | 2022-01-06 14:23:36 +0100 | [diff] [blame] | 177 | return pkgDir(sourceFile) || process.cwd(); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 178 | } |
| 179 | function requireResolver(name, sourceFile) { |
| 180 | // Try to resolve package with conventional name |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 181 | const resolver = tryRequire(`eslint-import-resolver-${name}`, sourceFile) || |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 182 | tryRequire(name, sourceFile) || |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 183 | tryRequire(path.resolve(getBaseDir(sourceFile), name)); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 184 | |
| 185 | if (!resolver) { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 186 | const err = new Error(`unable to load resolver "${name}".`); |
| 187 | err.name = ERROR_NAME; |
| 188 | throw err; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 189 | } |
| 190 | if (!isResolverValid(resolver)) { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 191 | const err = new Error(`${name} with invalid interface loaded as resolver`); |
| 192 | err.name = ERROR_NAME; |
| 193 | throw err; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 194 | } |
| 195 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 196 | return resolver; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 197 | } |
| 198 | |
| 199 | function isResolverValid(resolver) { |
| 200 | if (resolver.interfaceVersion === 2) { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 201 | return resolver.resolve && typeof resolver.resolve === 'function'; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 202 | } else { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 203 | return resolver.resolveImport && typeof resolver.resolveImport === 'function'; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 204 | } |
| 205 | } |
| 206 | |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 207 | const erroredContexts = new Set(); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 208 | |
| 209 | /** |
| 210 | * Given |
| 211 | * @param {string} p - module path |
| 212 | * @param {object} context - ESLint context |
| 213 | * @return {string} - the full module filesystem path; |
| 214 | * null if package is core; |
| 215 | * undefined if not found |
| 216 | */ |
| 217 | function resolve(p, context) { |
| 218 | try { |
Tim van der Lippe | a661941 | 2021-09-13 14:28:55 +0200 | [diff] [blame] | 219 | return relative(p, context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename(), context.settings); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 220 | } catch (err) { |
| 221 | if (!erroredContexts.has(context)) { |
| 222 | // The `err.stack` string starts with `err.name` followed by colon and `err.message`. |
| 223 | // We're filtering out the default `err.name` because it adds little value to the message. |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 224 | let errMessage = err.message; |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 225 | if (err.name !== ERROR_NAME && err.stack) { |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 226 | errMessage = err.stack.replace(/^Error: /, ''); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 227 | } |
| 228 | context.report({ |
| 229 | message: `Resolve error: ${errMessage}`, |
| 230 | loc: { line: 1, column: 0 }, |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 231 | }); |
| 232 | erroredContexts.add(context); |
Tim van der Lippe | fdbd42e | 2020-04-07 15:14:36 +0100 | [diff] [blame] | 233 | } |
| 234 | } |
| 235 | } |
Tim van der Lippe | 2c89197 | 2021-07-29 16:22:50 +0100 | [diff] [blame] | 236 | resolve.relative = relative; |
| 237 | exports.default = resolve; |