-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathworkspace.js
More file actions
272 lines (251 loc) · 8.67 KB
/
Copy pathworkspace.js
File metadata and controls
272 lines (251 loc) · 8.67 KB
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
import fs from 'node:fs'
import path from 'node:path'
import fg from 'fast-glob'
import { load as yamlLoad } from 'js-yaml'
import micromatch from 'micromatch'
import { getCustom, getCustomPath, invokeCommand } from './tools.js'
/** Default paths skipped during JS workspace discovery (merged with user patterns). */
const DEFAULT_WORKSPACE_DISCOVERY_IGNORE = [
'**/node_modules/**',
'**/.git/**',
]
/**
* Resolve ignore globs for workspace discovery: defaults + `TRUSTIFY_DA_WORKSPACE_DISCOVERY_IGNORE` + `opts.workspaceDiscoveryIgnore`.
* Patterns are fast-glob / micromatch style, relative to the workspace root (forward slashes).
*
* @param {{ workspaceDiscoveryIgnore?: string[], TRUSTIFY_DA_WORKSPACE_DISCOVERY_IGNORE?: string, [key: string]: unknown }} [opts={}]
* @returns {string[]}
*/
export function resolveWorkspaceDiscoveryIgnore(opts = {}) {
const merged = [...DEFAULT_WORKSPACE_DISCOVERY_IGNORE]
const fromEnv = getCustom('TRUSTIFY_DA_WORKSPACE_DISCOVERY_IGNORE', null, opts)
if (fromEnv && String(fromEnv).trim()) {
merged.push(...String(fromEnv).split(',').map(s => s.trim()).filter(Boolean))
}
const extra = opts.workspaceDiscoveryIgnore
if (Array.isArray(extra)) {
for (const p of extra) {
if (typeof p === 'string' && p.trim()) {
merged.push(p.trim())
}
}
}
return [...new Set(merged)]
}
/**
* @param {string} root - Workspace root (absolute)
* @param {string[]} ignorePatterns
*/
function buildWorkspaceDiscoveryGlobOptions(root, ignorePatterns) {
return {
cwd: root,
absolute: true,
onlyFiles: true,
ignore: ignorePatterns,
followSymbolicLinks: false,
}
}
/**
* @param {string} filePath - Absolute path
* @param {string} root - Workspace root (absolute)
* @returns {string} Relative path with forward slashes
*/
function relativePathForGlobMatch(filePath, root) {
const rel = path.relative(root, filePath)
return rel.split(path.sep).join('/')
}
/**
* Drop manifest paths whose location matches an ignore pattern (e.g. root unshift, Cargo paths).
*
* @param {string[]} manifestPaths
* @param {string} root
* @param {string[]} ignorePatterns
* @returns {string[]}
*/
export function filterManifestPathsByDiscoveryIgnore(manifestPaths, root, ignorePatterns) {
if (!ignorePatterns.length) {
return manifestPaths
}
const resolvedRoot = path.resolve(root)
return manifestPaths.filter(absPath => {
const rel = relativePathForGlobMatch(absPath, resolvedRoot)
if (rel === '') {
return true
}
return !ignorePatterns.some(pattern => micromatch.isMatch(rel, pattern, { dot: true }))
})
}
/**
* @typedef {{ valid: true, name: string, version: string } | { valid: false, error: string }} ValidatePackageJsonResult
*/
/**
* Validate a package.json has non-empty `name` and `version` (required for stable SBOM root identity in batch).
*
* @param {string} packageJsonPath - Absolute or relative path to package.json
* @returns {ValidatePackageJsonResult}
*/
export function validatePackageJson(packageJsonPath) {
let content
try {
const raw = fs.readFileSync(packageJsonPath, 'utf-8')
content = JSON.parse(raw)
} catch (err) {
const msg = err instanceof Error ? err.message : String(err)
return { valid: false, error: `Invalid package.json: ${msg}` }
}
if (!content || typeof content !== 'object') {
return { valid: false, error: 'package.json must be a JSON object' }
}
const name = content.name
const version = content.version
if (typeof name !== 'string' || !name.trim()) {
return { valid: false, error: 'Missing or invalid name' }
}
if (typeof version !== 'string' || !version.trim()) {
return { valid: false, error: 'Missing or invalid version' }
}
return { valid: true, name: name.trim(), version: version.trim() }
}
/**
* Discover all package.json paths in a JS/TS workspace.
* Reads pnpm-workspace.yaml or package.json workspaces.
*
* @param {string} workspaceRoot - Absolute or relative path to workspace root
* @param {{ workspaceDiscoveryIgnore?: string[], TRUSTIFY_DA_WORKSPACE_DISCOVERY_IGNORE?: string, [key: string]: unknown }} [opts={}] - optional `workspaceDiscoveryIgnore` globs (merged with defaults and env)
* @returns {Promise<string[]>} Paths to package.json files (absolute)
*/
export async function discoverWorkspacePackages(workspaceRoot, opts = {}) {
const root = path.resolve(workspaceRoot)
const ignorePatterns = resolveWorkspaceDiscoveryIgnore(opts)
const globOpts = buildWorkspaceDiscoveryGlobOptions(root, ignorePatterns)
const pnpmWorkspace = path.join(root, 'pnpm-workspace.yaml')
const packageJson = path.join(root, 'package.json')
if (fs.existsSync(pnpmWorkspace)) {
return discoverFromPnpmWorkspace(root, pnpmWorkspace, globOpts, ignorePatterns)
}
if (fs.existsSync(packageJson)) {
return discoverFromPackageJsonWorkspaces(root, packageJson, globOpts, ignorePatterns)
}
return []
}
/**
* @param {string} root
* @param {string} pnpmWorkspacePath
* @param {object} globOpts - fast-glob options (cwd, ignore, followSymbolicLinks, …)
* @param {string[]} ignorePatterns - for post-filter
* @returns {Promise<string[]>}
*/
async function discoverFromPnpmWorkspace(root, pnpmWorkspacePath, globOpts, ignorePatterns) {
const content = fs.readFileSync(pnpmWorkspacePath, 'utf-8')
const packages = parsePnpmPackages(content)
if (packages.length === 0) {
return []
}
const patterns = toManifestGlobPatterns(packages, 'package.json')
const manifestPaths = await fg(patterns, globOpts)
return filterManifestPathsByDiscoveryIgnore(manifestPaths, root, ignorePatterns)
}
/**
* Parse the `packages` array from pnpm-workspace.yaml content.
* @param {string} content - Raw YAML content
* @returns {string[]}
*/
function parsePnpmPackages(content) {
let doc
try {
doc = yamlLoad(content)
} catch {
return []
}
if (!doc || typeof doc !== 'object' || !Array.isArray(doc.packages)) {
return []
}
return doc.packages.filter(p => typeof p === 'string' && p.trim()).map(p => p.trim())
}
/**
* Convert workspace glob patterns to manifest-file glob patterns,
* correctly handling negation prefixes.
*
* @param {string[]} patterns - Workspace glob patterns (may include negations)
* @param {string} manifestFileName - e.g. 'package.json' or 'Cargo.toml'
* @returns {string[]}
*/
export function toManifestGlobPatterns(patterns, manifestFileName) {
return patterns.map(p => {
if (p.startsWith('!')) {
return `!${p.slice(1)}/${manifestFileName}`
}
return `${p}/${manifestFileName}`
})
}
/**
* @param {string} root
* @param {string} packageJsonPath
* @param {object} globOpts
* @param {string[]} ignorePatterns
* @returns {Promise<string[]>}
*/
async function discoverFromPackageJsonWorkspaces(root, packageJsonPath, globOpts, ignorePatterns) {
let pkg
try {
pkg = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'))
} catch {
return []
}
const workspaces = pkg.workspaces
if (!workspaces) {
return []
}
const raw = Array.isArray(workspaces) ? workspaces : workspaces.packages || []
const patterns = toManifestGlobPatterns(raw.filter(p => typeof p === 'string'), 'package.json')
if (patterns.length === 0) {
return []
}
const manifestPaths = await fg(patterns, globOpts)
const rootPkg = path.join(root, 'package.json')
if (fs.existsSync(rootPkg) && !manifestPaths.includes(rootPkg)) {
manifestPaths.unshift(rootPkg)
}
return filterManifestPathsByDiscoveryIgnore(manifestPaths, root, ignorePatterns)
}
/**
* Discover all Cargo.toml manifest paths in a Cargo workspace.
* Uses `cargo metadata` to get workspace members.
*
* @param {string} workspaceRoot - Absolute or relative path to workspace root (must contain Cargo.toml and Cargo.lock)
* @param {import('./index.js').Options} [opts={}]
* @returns {Promise<string[]>} Paths to Cargo.toml files (absolute)
*/
export async function discoverWorkspaceCrates(workspaceRoot, opts = {}) {
const root = path.resolve(workspaceRoot)
const cargoToml = path.join(root, 'Cargo.toml')
const cargoLock = path.join(root, 'Cargo.lock')
if (!fs.existsSync(cargoToml) || !fs.existsSync(cargoLock)) {
return []
}
const cargoBin = getCustomPath('cargo', opts)
let output
try {
output = invokeCommand(cargoBin, ['metadata', '--format-version', '1', '--no-deps'], { cwd: root })
} catch {
return []
}
let metadata
try {
metadata = JSON.parse(output.toString().trim())
} catch {
return []
}
const memberIds = new Set(metadata.workspace_members || [])
const manifestPaths = []
for (const pkg of metadata.packages || []) {
if (memberIds.has(pkg.id) && pkg.manifest_path) {
const manifestPath = path.resolve(pkg.manifest_path)
if (fs.existsSync(manifestPath)) {
manifestPaths.push(manifestPath)
}
}
}
const ignorePatterns = resolveWorkspaceDiscoveryIgnore(opts)
return filterManifestPathsByDiscoveryIgnore(manifestPaths, root, ignorePatterns)
}