-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #841 from oclif/mdonnalley/use-yarn-if-needed
fix: use yarn to install deps when linking yarn plugins
- Loading branch information
Showing
6 changed files
with
183 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| import {Errors, ux} from '@oclif/core' | ||
| import makeDebug from 'debug' | ||
| import {fork as cpFork} from 'node:child_process' | ||
| import {npmRunPathEnv} from 'npm-run-path' | ||
|
|
||
| import {LogLevel} from './log-level.js' | ||
|
|
||
| export type ExecOptions = { | ||
| cwd: string | ||
| logLevel: LogLevel | ||
| } | ||
|
|
||
| export type Output = { | ||
| stderr: string[] | ||
| stdout: string[] | ||
| } | ||
|
|
||
| const debug = makeDebug('@oclif/plugin-plugins:fork') | ||
|
|
||
| export async function fork(modulePath: string, args: string[] = [], {cwd, logLevel}: ExecOptions): Promise<Output> { | ||
| return new Promise((resolve, reject) => { | ||
| const forked = cpFork(modulePath, args, { | ||
| cwd, | ||
| env: { | ||
| ...npmRunPathEnv(), | ||
| // Disable husky hooks because a plugin might be trying to install them, which will | ||
| // break the install since the install location isn't a .git directory. | ||
| HUSKY: '0', | ||
| }, | ||
| execArgv: process.execArgv | ||
| .join(' ') | ||
| // Remove --loader ts-node/esm from execArgv so that the subprocess doesn't fail if it can't find ts-node. | ||
| // The ts-node/esm loader isn't need to execute npm or yarn commands anyways. | ||
| .replace('--loader ts-node/esm', '') | ||
| .replace('--loader=ts-node/esm', '') | ||
| .split(' ') | ||
| .filter(Boolean), | ||
| stdio: [0, null, null, 'ipc'], | ||
| }) | ||
|
|
||
| const possibleLastLinesOfNpmInstall = ['up to date', 'added'] | ||
| const stderr: string[] = [] | ||
| const stdout: string[] = [] | ||
| const loggedStderr: string[] = [] | ||
| const loggedStdout: string[] = [] | ||
|
|
||
| const shouldPrint = (str: string): boolean => { | ||
| // For ux cleanliness purposes, don't print the final line of npm install output if | ||
| // the log level is 'notice' and there's no other output. | ||
| const noOtherOutput = loggedStderr.length === 0 && loggedStdout.length === 0 | ||
| const isLastLine = possibleLastLinesOfNpmInstall.some((line) => str.startsWith(line)) | ||
| if (noOtherOutput && isLastLine && logLevel === 'notice') { | ||
| return false | ||
| } | ||
|
|
||
| return logLevel !== 'silent' | ||
| } | ||
|
|
||
| forked.stderr?.setEncoding('utf8') | ||
| forked.stderr?.on('data', (d: Buffer) => { | ||
| const output = d.toString().trim() | ||
| stderr.push(output) | ||
| if (shouldPrint(output)) { | ||
| loggedStderr.push(output) | ||
| ux.log(output) | ||
| } else debug(output) | ||
| }) | ||
|
|
||
| forked.stdout?.setEncoding('utf8') | ||
| forked.stdout?.on('data', (d: Buffer) => { | ||
| const output = d.toString().trim() | ||
| stdout.push(output) | ||
| if (shouldPrint(output)) { | ||
| loggedStdout.push(output) | ||
| ux.log(output) | ||
| } else debug(output) | ||
| }) | ||
|
|
||
| forked.on('error', reject) | ||
| forked.on('exit', (code: number) => { | ||
| if (code === 0) { | ||
| resolve({stderr, stdout}) | ||
| } else { | ||
| reject( | ||
| new Errors.CLIError(`${modulePath} ${args.join(' ')} exited with code ${code}`, { | ||
| suggestions: ['Run with DEBUG=@oclif/plugin-plugins* to see debug output.'], | ||
| }), | ||
| ) | ||
| } | ||
| }) | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| import {Interfaces, ux} from '@oclif/core' | ||
| import makeDebug from 'debug' | ||
| import {createRequire} from 'node:module' | ||
| import {fileURLToPath} from 'node:url' | ||
|
|
||
| import {ExecOptions, Output, fork} from './fork.js' | ||
| import {LogLevel} from './log-level.js' | ||
|
|
||
| const require = createRequire(import.meta.url) | ||
| const debug = makeDebug('@oclif/plugin-plugins:yarn') | ||
|
|
||
| export class Yarn { | ||
| private config: Interfaces.Config | ||
| private logLevel: LogLevel | ||
|
|
||
| public constructor({config, logLevel}: {config: Interfaces.Config; logLevel: LogLevel}) { | ||
| this.config = config | ||
| this.logLevel = logLevel | ||
| } | ||
|
|
||
| async exec(args: string[] = [], options: ExecOptions): Promise<Output> { | ||
| const bin = await this.findYarn() | ||
| debug('yarn binary path', bin) | ||
|
|
||
| if (options.logLevel === 'verbose') args.push('--verbose') | ||
| if (this.config.npmRegistry) args.push(`--registry=${this.config.npmRegistry}`) | ||
|
|
||
| if (options.logLevel !== 'notice' && options.logLevel !== 'silent') { | ||
| ux.logToStderr(`${options.cwd}: ${bin} ${args.join(' ')}`) | ||
| } | ||
|
|
||
| debug(`${options.cwd}: ${bin} ${args.join(' ')}`) | ||
| try { | ||
| const output = await fork(bin, args, options) | ||
| debug('yarn done') | ||
| return output | ||
| } catch (error: unknown) { | ||
| debug('yarn error', error) | ||
| throw error | ||
| } | ||
| } | ||
|
|
||
| async install(args: string[], opts: ExecOptions): Promise<Output> { | ||
| return this.exec(['install', ...args], opts) | ||
| } | ||
|
|
||
| private async findYarn(): Promise<string> { | ||
| return require.resolve('yarn/bin/yarn.js', {paths: [this.config.root, fileURLToPath(import.meta.url)]}) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7179,6 +7179,11 @@ yargs@^17.0.0: | |
| y18n "^5.0.5" | ||
| yargs-parser "^21.1.1" | ||
|
|
||
| yarn@^1.22.22: | ||
| version "1.22.22" | ||
| resolved "https://registry.yarnpkg.com/yarn/-/yarn-1.22.22.tgz#ac34549e6aa8e7ead463a7407e1c7390f61a6610" | ||
| integrity sha512-prL3kGtyG7o9Z9Sv8IPfBNrWTDmXB4Qbes8A9rEzt6wkJV8mUvoirjU0Mp3GGAU06Y0XQyA3/2/RQFVuK7MTfg== | ||
|
|
||
| [email protected]: | ||
| version "3.1.1" | ||
| resolved "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz" | ||
|
|
||