Merge pull request #304 from ckeditor/i/284-dep0190

Fix DEP0190 warning in generator subprocess calls

Author: pomek

.changelog/20260220131318_i_284_dep0190.md

@@ -0,0 +1,9 @@
+---
+type: Fix
+scope:
+  - ckeditor5-package-generator
+closes:
+  - 284
+---
+
+Address the `DEP0190` deprecation warning shown during package generation by changing dependency and Git hook installation subprocess calls to avoid passing argument arrays with `shell: true`.

packages/ckeditor5-package-generator/lib/utils/install-dependencies.js

@@ -49,20 +49,18 @@ function installPackages( directoryPath, packageManager, verbose, dev ) {
 		}
 
 		if ( packageManager === 'npm' ) {
-			const npmArguments = [
-				'install'
-			];
+			let npmCommand = 'npm install';
 
 			// Flag required for npm 8 to install linked packages' dependencies
 			if ( dev ) {
-				npmArguments.push( '--install-links' );
+				npmCommand += ' --install-links';
 			}
 
-			installTask = spawn( 'npm', npmArguments, spawnOptions );
+			installTask = spawn( npmCommand, spawnOptions );
 		} else if ( packageManager === 'yarn' ) {
-			installTask = spawn( 'yarnpkg', [], spawnOptions );
+			installTask = spawn( 'yarnpkg install', spawnOptions );
 		} else if ( packageManager === 'pnpm' ) {
-			installTask = spawn( 'pnpm', [ 'install' ], spawnOptions );
+			installTask = spawn( 'pnpm install', spawnOptions );
 		} else {
 			throw new Error( 'Unhandled package manager ' + packageManager );
 		}

packages/ckeditor5-package-generator/lib/utils/install-git-hooks.js

@@ -21,14 +21,12 @@ export default function installGitHooks( directoryPath, logger, verbose ) {
 			stderr: 'inherit'
 		};
 
-		const spawnArguments = [ 'rebuild', 'husky' ];
-
 		if ( verbose ) {
 			spawnOptions.stdio = 'inherit';
 		}
 
 		// 'rebuild' was added to yarn in version 2, but we use yarn 1, thus only npm can be used.
-		const rebuildTask = spawn( 'npm', spawnArguments, spawnOptions );
+		const rebuildTask = spawn( 'npm rebuild husky', spawnOptions );
 
 		rebuildTask.on( 'close', exitCode => {
 			if ( exitCode ) {

packages/ckeditor5-package-generator/tests/utils/install-dependencies.js

@@ -57,8 +57,7 @@ describe( 'lib/utils/install-dependencies', () => {
 
 		expect( spawn ).toHaveBeenCalledTimes( 1 );
 		expect( spawn ).toHaveBeenCalledWith(
-			'yarnpkg',
-			[],
+			'yarnpkg install',
 			{
 				encoding: 'utf8',
 				shell: true,
@@ -73,8 +72,7 @@ describe( 'lib/utils/install-dependencies', () => {
 
 		expect( spawn ).toHaveBeenCalledTimes( 1 );
 		expect( spawn ).toHaveBeenCalledWith(
-			'yarnpkg',
-			[],
+			'yarnpkg install',
 			{
 				encoding: 'utf8',
 				shell: true,
@@ -90,8 +88,7 @@ describe( 'lib/utils/install-dependencies', () => {
 
 		expect( spawn ).toHaveBeenCalledTimes( 1 );
 		expect( spawn ).toHaveBeenCalledWith(
-			'npm',
-			[ 'install' ],
+			'npm install',
 			{
 				encoding: 'utf8',
 				shell: true,
@@ -106,8 +103,7 @@ describe( 'lib/utils/install-dependencies', () => {
 
 		expect( spawn ).toHaveBeenCalledTimes( 1 );
 		expect( spawn ).toHaveBeenCalledWith(
-			'npm',
-			[ 'install' ],
+			'npm install',
 			{
 				encoding: 'utf8',
 				shell: true,
@@ -122,8 +118,7 @@ describe( 'lib/utils/install-dependencies', () => {
 		await runTest( { packageManager: 'npm', verbose: true, dev: true } );
 
 		expect( spawn ).toHaveBeenCalledWith(
-			'npm',
-			[ 'install', '--install-links' ],
+			'npm install --install-links',
 			expect.any( Object )
 		);
 	} );
@@ -133,8 +128,7 @@ describe( 'lib/utils/install-dependencies', () => {
 
 		expect( spawn ).toHaveBeenCalledTimes( 1 );
 		expect( spawn ).toHaveBeenCalledWith(
-			'pnpm',
-			[ 'install' ],
+			'pnpm install',
 			{
 				encoding: 'utf8',
 				shell: true,
@@ -149,8 +143,7 @@ describe( 'lib/utils/install-dependencies', () => {
 
 		expect( spawn ).toHaveBeenCalledTimes( 1 );
 		expect( spawn ).toHaveBeenCalledWith(
-			'pnpm',
-			[ 'install' ],
+			'pnpm install',
 			{
 				encoding: 'utf8',
 				shell: true,
@@ -165,8 +158,7 @@ describe( 'lib/utils/install-dependencies', () => {
 		await runTest( { packageManager: 'pnpm', dev: true } );
 
 		expect( spawn ).toHaveBeenCalledWith(
-			'pnpm',
-			[ 'install' ],
+			'pnpm install',
 			expect.any( Object )
 		);
 	} );

packages/ckeditor5-package-generator/tests/utils/install-git-hooks.js

@@ -43,8 +43,7 @@ describe( 'lib/utils/install-git-hooks', () => {
 
 		expect( spawn ).toHaveBeenCalledTimes( 1 );
 		expect( spawn ).toHaveBeenCalledWith(
-			'npm',
-			[ 'rebuild', 'husky' ],
+			'npm rebuild husky',
 			{
 				encoding: 'utf8',
 				shell: true,
@@ -59,8 +58,7 @@ describe( 'lib/utils/install-git-hooks', () => {
 
 		expect( spawn ).toHaveBeenCalledTimes( 1 );
 		expect( spawn ).toHaveBeenCalledWith(
-			'npm',
-			[ 'rebuild', 'husky' ],
+			'npm rebuild husky',
 			{
 				encoding: 'utf8',
 				shell: true,

scripts/ci/verify-build.js

@@ -148,9 +148,11 @@ async function verifyBuild( { language, packageManager, customPluginName, instal
  * @returns {Object} Process
  */
 function executeCommand( command, options ) {
-	console.log( chalk.italic.gray( `Executing: "${ command.join( ' ' ) }".` ) );
+	const commandString = command.join( ' ' );
 
-	const newProcess = spawnSync( command.shift(), command, {
+	console.log( chalk.italic.gray( `Executing: "${ commandString }".` ) );
+
+	const newProcess = spawnSync( commandString, {
 		cwd: options.cwd,
 		encoding: 'utf8',
 		shell: true,
@@ -176,7 +178,7 @@ function executeCommand( command, options ) {
  */
 function startDevelopmentServer( cwd ) {
 	return new Promise( ( resolve, reject ) => {
-		const sampleServer = spawn( 'npm', [ 'run', 'start', '--', '--no-open' ], {
+		const sampleServer = spawn( 'npm run start -- --no-open', {
 			cwd,
 			encoding: 'utf8',
 			shell: true
@@ -227,7 +229,7 @@ function startDevelopmentServer( cwd ) {
  */
 function startDevelopmentServerForDllBuild( cwd ) {
 	return new Promise( ( resolve, reject ) => {
-		const sampleServer = spawn( 'npx', [ 'http-server', './' ], {
+		const sampleServer = spawn( 'npx http-server ./', {
 			cwd,
 			encoding: 'utf8',
 			shell: true