|
| 1 | +import { log } from './log'; |
| 2 | +import path from 'path'; |
| 3 | +import fs from 'fs'; |
| 4 | +import { createRequire } from 'module'; |
| 5 | + |
| 6 | +export function findRootSvelteDependencies(root: string, cwdFallback = true): SvelteDependency[] { |
| 7 | + log.debug(`findSvelteDependencies: searching svelte dependencies in ${root}`); |
| 8 | + const pkgFile = path.join(root, 'package.json'); |
| 9 | + if (!fs.existsSync(pkgFile)) { |
| 10 | + if (cwdFallback) { |
| 11 | + const cwd = process.cwd(); |
| 12 | + if (root !== cwd) { |
| 13 | + log.debug(`no package.json found in vite root ${root}`); |
| 14 | + return findRootSvelteDependencies(cwd, false); |
| 15 | + } |
| 16 | + } |
| 17 | + log.warn(`no package.json found, findRootSvelteDependencies failed`); |
| 18 | + return []; |
| 19 | + } |
| 20 | + |
| 21 | + const pkg = parsePkg(root); |
| 22 | + if (!pkg) { |
| 23 | + return []; |
| 24 | + } |
| 25 | + |
| 26 | + const deps = [ |
| 27 | + ...Object.keys(pkg.dependencies || {}), |
| 28 | + ...Object.keys(pkg.devDependencies || {}) |
| 29 | + ].filter((dep) => !is_common_without_svelte_field(dep)); |
| 30 | + |
| 31 | + return getSvelteDependencies(deps, root); |
| 32 | +} |
| 33 | + |
| 34 | +function getSvelteDependencies( |
| 35 | + deps: string[], |
| 36 | + pkgDir: string, |
| 37 | + path: string[] = [] |
| 38 | +): SvelteDependency[] { |
| 39 | + const result = []; |
| 40 | + const localRequire = createRequire(`${pkgDir}/package.json`); |
| 41 | + const resolvedDeps = deps |
| 42 | + .map((dep) => resolveSvelteDependency(dep, localRequire)) |
| 43 | + .filter(Boolean); |
| 44 | + // @ts-ignore |
| 45 | + for (const { pkg, dir } of resolvedDeps) { |
| 46 | + result.push({ name: pkg.name, pkg, dir, path }); |
| 47 | + if (pkg.dependencies) { |
| 48 | + let dependencyNames = Object.keys(pkg.dependencies); |
| 49 | + const circular = dependencyNames.filter((name) => path.includes(name)); |
| 50 | + if (circular.length > 0) { |
| 51 | + log.warn.enabled && |
| 52 | + log.warn( |
| 53 | + `skipping circular svelte dependencies in automated vite optimizeDeps handling`, |
| 54 | + circular.map((x) => path.concat(x).join('>')) |
| 55 | + ); |
| 56 | + dependencyNames = dependencyNames.filter((name) => !path.includes(name)); |
| 57 | + } |
| 58 | + if (path.length === 3) { |
| 59 | + log.debug.once(`encountered deep svelte dependency tree: ${path.join('>')}`); |
| 60 | + } |
| 61 | + result.push(...getSvelteDependencies(dependencyNames, dir, path.concat(pkg.name))); |
| 62 | + } |
| 63 | + } |
| 64 | + return result; |
| 65 | +} |
| 66 | + |
| 67 | +function resolveSvelteDependency( |
| 68 | + dep: string, |
| 69 | + localRequire: NodeRequire |
| 70 | +): { dir: string; pkg: Pkg } | void { |
| 71 | + try { |
| 72 | + const pkgJson = `${dep}/package.json`; |
| 73 | + const pkg = localRequire(pkgJson); |
| 74 | + if (!isSvelte(pkg)) { |
| 75 | + return; |
| 76 | + } |
| 77 | + const dir = path.dirname(localRequire.resolve(pkgJson)); |
| 78 | + return { dir, pkg }; |
| 79 | + } catch (e) { |
| 80 | + log.debug.once(`dependency ${dep} does not export package.json`, e); |
| 81 | + // walk up from default export until we find package.json with name=dep |
| 82 | + try { |
| 83 | + let dir = path.dirname(localRequire.resolve(dep)); |
| 84 | + while (dir) { |
| 85 | + const pkg = parsePkg(dir, true); |
| 86 | + if (pkg && pkg.name === dep) { |
| 87 | + if (!isSvelte(pkg)) { |
| 88 | + return; |
| 89 | + } |
| 90 | + log.warn.once( |
| 91 | + `package.json of ${dep} has a "svelte" field but does not include itself in exports field. Please ask package maintainer to update` |
| 92 | + ); |
| 93 | + return { dir, pkg }; |
| 94 | + } |
| 95 | + const parent = path.dirname(dir); |
| 96 | + if (parent === dir) { |
| 97 | + break; |
| 98 | + } |
| 99 | + dir = parent; |
| 100 | + } |
| 101 | + } catch (e) { |
| 102 | + log.debug.once(`error while trying to find package.json of ${dep}`, e); |
| 103 | + } |
| 104 | + } |
| 105 | + log.debug.once(`failed to resolve ${dep}`); |
| 106 | +} |
| 107 | + |
| 108 | +function parsePkg(dir: string, silent = false): Pkg | void { |
| 109 | + const pkgFile = path.join(dir, 'package.json'); |
| 110 | + try { |
| 111 | + return JSON.parse(fs.readFileSync(pkgFile, 'utf-8')); |
| 112 | + } catch (e) { |
| 113 | + !silent && log.warn.enabled && log.warn(`failed to parse ${pkgFile}`, e); |
| 114 | + } |
| 115 | +} |
| 116 | + |
| 117 | +function isSvelte(pkg: Pkg) { |
| 118 | + return !!pkg.svelte; |
| 119 | +} |
| 120 | + |
| 121 | +const COMMON_DEPENDENCIES_WITHOUT_SVELTE_FIELD = [ |
| 122 | + '@lukeed/uuid', |
| 123 | + '@sveltejs/vite-plugin-svelte', |
| 124 | + '@sveltejs/kit', |
| 125 | + 'autoprefixer', |
| 126 | + 'cookie', |
| 127 | + 'dotenv', |
| 128 | + 'esbuild', |
| 129 | + 'eslint', |
| 130 | + 'jest', |
| 131 | + 'mdsvex', |
| 132 | + 'postcss', |
| 133 | + 'prettier', |
| 134 | + 'svelte', |
| 135 | + 'svelte-check', |
| 136 | + 'svelte-hmr', |
| 137 | + 'svelte-preprocess', |
| 138 | + 'tslib', |
| 139 | + 'typescript', |
| 140 | + 'vite' |
| 141 | +]; |
| 142 | +const COMMON_PREFIXES_WITHOUT_SVELTE_FIELD = [ |
| 143 | + '@fontsource/', |
| 144 | + '@postcss-plugins/', |
| 145 | + '@rollup/', |
| 146 | + '@sveltejs/adapter-', |
| 147 | + '@types/', |
| 148 | + '@typescript-eslint/', |
| 149 | + 'eslint-', |
| 150 | + 'jest-', |
| 151 | + 'postcss-plugin-', |
| 152 | + 'prettier-plugin-', |
| 153 | + 'rollup-plugin-', |
| 154 | + 'vite-plugin-' |
| 155 | +]; |
| 156 | + |
| 157 | +/** |
| 158 | + * Test for common dependency names that tell us it is not a package including a svelte field, eg. eslint + plugins. |
| 159 | + * |
| 160 | + * This speeds up the find process as we don't have to try and require the package.json for all of them |
| 161 | + * |
| 162 | + * @param dependency {string} |
| 163 | + * @returns {boolean} true if it is a dependency without a svelte field |
| 164 | + */ |
| 165 | +function is_common_without_svelte_field(dependency: string): boolean { |
| 166 | + return ( |
| 167 | + COMMON_DEPENDENCIES_WITHOUT_SVELTE_FIELD.includes(dependency) || |
| 168 | + COMMON_PREFIXES_WITHOUT_SVELTE_FIELD.some( |
| 169 | + (prefix) => |
| 170 | + prefix.startsWith('@') |
| 171 | + ? dependency.startsWith(prefix) |
| 172 | + : dependency.substring(dependency.lastIndexOf('/') + 1).startsWith(prefix) // check prefix omitting @scope/ |
| 173 | + ) |
| 174 | + ); |
| 175 | +} |
| 176 | + |
| 177 | +export interface SvelteDependency { |
| 178 | + name: string; |
| 179 | + dir: string; |
| 180 | + pkg: Pkg; |
| 181 | + path: string[]; |
| 182 | +} |
| 183 | + |
| 184 | +export interface Pkg { |
| 185 | + name: string; |
| 186 | + svelte?: string; |
| 187 | + dependencies?: DependencyList; |
| 188 | + devDependencies?: DependencyList; |
| 189 | + [key: string]: any; |
| 190 | +} |
| 191 | + |
| 192 | +export interface DependencyList { |
| 193 | + [key: string]: string; |
| 194 | +} |
0 commit comments