@ckeditor/ckeditor5-dev-release-tools 54.0.0 → 54.1.0

package/lib/tasks/cleanuppackages.js

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md.
  */
 
-import fs from 'fs-extra';
+import fs from 'fs/promises';
 import upath from 'upath';
 import { glob } from 'glob';
 import { workspaces } from '@ckeditor/ckeditor5-dev-utils';
@@ -18,7 +18,7 @@ import { workspaces } from '@ckeditor/ckeditor5-dev-utils';
  *   - `README.md`
  *   - file pointed by the `main` field from `package.json`
  *   - file pointed by the `types` field from `package.json`
- * - Removes unnecessary fields from the `package.json` file.
+ * - Removes unnecessary fields from the `package.json` file. Supports nested field paths, e.g. `engines.pnpm`.
  *
  * @param {object} options
  * @param {string} options.packagesDirectory Relative path to a location of packages to be cleaned up.
@@ -34,12 +34,13 @@ export default async function cleanUpPackages( options ) {
 
 	for ( const packageJsonPath of packageJsonPaths ) {
 		const packagePath = upath.dirname( packageJsonPath );
-		const packageJson = await fs.readJson( packageJsonPath );
+		const packageJsonFile = await fs.readFile( packageJsonPath, 'utf-8' );
+		const packageJson = JSON.parse( packageJsonFile );
 
 		await cleanUpPackageDirectory( packageJson, packagePath );
 		cleanUpPackageJson( packageJson, packageJsonFieldsToRemove, preservePostInstallHook );
 
-		await fs.writeJson( packageJsonPath, packageJson, { spaces: 2 } );
+		await fs.writeFile( packageJsonPath, JSON.stringify( packageJson, null, 2 ) );
 	}
 }
 
@@ -96,7 +97,7 @@ async function cleanUpPackageDirectory( packageJson, packagePath ) {
 		} );
 
 		for ( const file of files ) {
-			await fs.remove( file );
+			await fs.rm( file );
 		}
 	}
 
@@ -114,12 +115,12 @@ async function cleanUpPackageDirectory( packageJson, packagePath ) {
 		const isEmpty = ( await fs.readdir( directory ) ).length === 0;
 
 		if ( isEmpty ) {
-			await fs.remove( directory );
+			await fs.rm( directory, { recursive: true, force: true } );
 		}
 	}
 
 	// Remove `node_modules`.
-	await fs.remove( upath.join( packagePath, 'node_modules' ) );
+	await fs.rm( upath.join( packagePath, 'node_modules' ), { recursive: true, force: true } );
 }
 
 /**
@@ -156,16 +157,14 @@ function getIgnoredFilePatterns( packageJson ) {
  * @param {boolean} preservePostInstallHook
  */
 function cleanUpPackageJson( packageJson, packageJsonFieldsToRemove, preservePostInstallHook ) {
-	for ( const key of Object.keys( packageJson ) ) {
-		if ( !packageJsonFieldsToRemove.includes( key ) ) {
+	for ( const field of packageJsonFieldsToRemove ) {
+		if ( field === 'scripts' && preservePostInstallHook && packageJson.scripts?.postinstall ) {
+			packageJson.scripts = { postinstall: packageJson.scripts.postinstall };
+
 			continue;
 		}
 
-		if ( key === 'scripts' && preservePostInstallHook && packageJson.scripts.postinstall ) {
-			packageJson.scripts = { 'postinstall': packageJson.scripts.postinstall };
-		} else {
-			delete packageJson[ key ];
-		}
+		removeField( packageJson, field );
 	}
 }
 
@@ -183,6 +182,39 @@ function sortPathsFromDeepestFirst( firstPath, secondPath ) {
 	return secondPathSegments - firstPathSegments;
 }
 
+/**
+ * Removes provided field from an object. Supports nested field paths, e.g. "a.b.c". It modifies the source `obj` argument.
+ *
+ * @param {object} obj Source object containing a field to remove.
+ * @param {string} path Path to the field to be removed.
+ */
+function removeField( obj, path ) {
+	const parts = path.split( '.' );
+	const lastPart = parts.pop();
+
+	let current = obj;
+
+	for ( const part of parts ) {
+		current = current[ part ];
+
+		if ( !isObject( current ) ) {
+			return;
+		}
+	}
+
+	delete current[ lastPart ];
+}
+
+/**
+ * Checks if provided value is an object literal.
+ *
+ * @param {*} value Value to check.
+ * @returns {boolean}
+ */
+function isObject( value ) {
+	return value !== null && typeof value === 'object' && !Array.isArray( value );
+}
+
 /**
  * @typedef {['devDependencies','depcheckIgnore','scripts','private']} DefaultFieldsToRemove
  */

package/lib/tasks/preparerepository.js

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md.
  */
 
-import fs from 'fs-extra';
+import fs from 'fs/promises';
 import { glob } from 'glob';
 import upath from 'upath';
 
@@ -35,7 +35,7 @@ export default async function prepareRepository( options ) {
 	}
 
 	const outputDirectoryPath = upath.join( cwd, outputDirectory );
-	await fs.ensureDir( outputDirectoryPath );
+	await fs.mkdir( outputDirectoryPath, { recursive: true } );
 	const outputDirContent = await fs.readdir( outputDirectoryPath );
 
 	if ( outputDirContent.length ) {
@@ -97,15 +97,15 @@ async function processRootPackage( { cwd, rootPackageJson, outputDirectoryPath }
 	const rootPackageOutputPath = upath.join( outputDirectoryPath, rootPackageDirName );
 	const pkgJsonOutputPath = upath.join( rootPackageOutputPath, 'package.json' );
 
-	await fs.ensureDir( rootPackageOutputPath );
-	await fs.writeJson( pkgJsonOutputPath, rootPackageJson, { spaces: 2, EOL: '\n' } );
+	await fs.mkdir( rootPackageOutputPath, { recursive: true } );
+	await fs.writeFile( pkgJsonOutputPath, JSON.stringify( rootPackageJson, null, 2 ) + '\n' );
 
 	return ( await glob( rootPackageJson.files ) )
 		.map( absoluteFilePath => {
 			const relativeFilePath = upath.relative( cwd, absoluteFilePath );
 			const absoluteFileOutputPath = upath.join( rootPackageOutputPath, relativeFilePath );
 
-			return fs.copy( absoluteFilePath, absoluteFileOutputPath );
+			return fs.cp( absoluteFilePath, absoluteFileOutputPath, { recursive: true } );
 		} );
 }
 
@@ -130,13 +130,13 @@ async function processMonorepoPackages( { cwd, packagesDirectory, packagesToCopy
 		}
 
 		const pkgJsonPath = upath.join( packagePath, 'package.json' );
-		const hasPkgJson = await fs.exists( pkgJsonPath );
+		const hasPkgJson = await fs.access( pkgJsonPath ).then( () => true, () => false );
 
 		if ( !hasPkgJson ) {
 			return;
 		}
 
-		return fs.copy( packagePath, upath.join( outputDirectoryPath, packageDir ) );
+		return fs.cp( packagePath, upath.join( outputDirectoryPath, packageDir ), { recursive: true } );
 	} );
 }
 

package/lib/tasks/publishpackages.js

@@ -4,7 +4,7 @@
  */
 
 import upath from 'upath';
-import fs from 'fs-extra';
+import fs from 'fs/promises';
 import assertNpmAuthorization from '../utils/assertnpmauthorization.js';
 import assertPackages from '../utils/assertpackages.js';
 import assertNpmTag from '../utils/assertnpmtag.js';
@@ -130,11 +130,12 @@ export default async function publishPackages( options ) {
 
 async function removeAlreadyPublishedPackages( packagePaths ) {
 	for ( const absolutePackagePath of packagePaths ) {
-		const pkgJson = await fs.readJson( upath.join( absolutePackagePath, 'package.json' ) );
+		const pkgJsonFile = await fs.readFile( upath.join( absolutePackagePath, 'package.json' ), 'utf-8' );
+		const pkgJson = JSON.parse( pkgJsonFile );
 		const isAvailable = await npm.checkVersionAvailability( pkgJson.version, pkgJson.name );
 
 		if ( !isAvailable ) {
-			await fs.remove( absolutePackagePath );
+			await fs.rm( absolutePackagePath, { recursive: true, force: true } );
 		}
 	}
 }

package/lib/tasks/reassignnpmtags.js

@@ -5,15 +5,14 @@
  * For licensing, see LICENSE.md.
  */
 
-import chalk from 'chalk';
-import columns from 'cli-columns';
 import { tools } from '@ckeditor/ckeditor5-dev-utils';
-import util from 'util';
+import { styleText, promisify } from 'util';
+import columns from 'cli-columns';
 import shellEscape from 'shell-escape';
 import assertNpmAuthorization from '../utils/assertnpmauthorization.js';
 import { exec } from 'child_process';
 
-const execPromise = util.promisify( exec );
+const execPromise = promisify( exec );
 
 /**
  * Used to switch the tags from `staging` to `latest` for specified array of packages.
@@ -71,17 +70,17 @@ export default async function reassignNpmTags( options ) {
 	counter.finish();
 
 	if ( packagesUpdated.length ) {
-		console.log( chalk.bold.green( '✨ Tags updated:' ) );
+		console.log( styleText( [ 'green', 'bold' ], '✨ Tags updated:' ) );
 		console.log( columns( packagesUpdated ) );
 	}
 
 	if ( packagesSkipped.length ) {
-		console.log( chalk.bold.yellow( '⬇️ Packages skipped:' ) );
+		console.log( styleText( [ 'yellow', 'bold' ], '⬇️ Packages skipped:' ) );
 		console.log( columns( packagesSkipped ) );
 	}
 
 	if ( errors.length ) {
-		console.log( chalk.bold.red( '🐛 Errors found:' ) );
+		console.log( styleText( [ 'red', 'bold' ], '🐛 Errors found:' ) );
 		errors.forEach( msg => console.log( `* ${ msg }` ) );
 	}
 }

package/lib/tasks/updatedependencies.js

@@ -4,7 +4,7 @@
  */
 
 import { workspaces } from '@ckeditor/ckeditor5-dev-utils';
-import fs from 'fs-extra';
+import fs from 'fs/promises';
 import upath from 'upath';
 
 const { normalizeTrim } = upath;
@@ -51,13 +51,14 @@ export default async function updateDependencies( options ) {
 	);
 
 	for ( const pkgJsonPath of pkgJsonPaths ) {
-		const pkgJson = await fs.readJson( pkgJsonPath );
+		const pkgJsonFile = await fs.readFile( pkgJsonPath, 'utf-8' );
+		const pkgJson = JSON.parse( pkgJsonFile );
 
 		updateVersion( version, shouldUpdateVersionCallback, pkgJson.dependencies );
 		updateVersion( version, shouldUpdateVersionCallback, pkgJson.devDependencies );
 		updateVersion( version, shouldUpdateVersionCallback, pkgJson.peerDependencies );
 
-		await fs.writeJson( pkgJsonPath, pkgJson, { spaces: 2 } );
+		await fs.writeFile( pkgJsonPath, JSON.stringify( pkgJson, null, 2 ) );
 	}
 }
 

package/lib/tasks/updateversions.js

@@ -3,9 +3,9 @@
  * For licensing, see LICENSE.md.
  */
 
+import fs from 'fs/promises';
 import { workspaces } from '@ckeditor/ckeditor5-dev-utils';
 import upath from 'upath';
-import fs from 'fs-extra';
 import semver from 'semver';
 
 const { normalizeTrim } = upath;
@@ -51,10 +51,11 @@ export default async function updateVersions( options ) {
 	checkIfVersionIsValid( version );
 
 	for ( const pkgJsonPath of pkgJsonPaths ) {
-		const pkgJson = await fs.readJson( pkgJsonPath );
+		const pkgJsonFile = await fs.readFile( pkgJsonPath, 'utf-8' );
+		const pkgJson = JSON.parse( pkgJsonFile );
 
 		pkgJson.version = version;
-		await fs.writeJson( pkgJsonPath, pkgJson, { spaces: 2 } );
+		await fs.writeFile( pkgJsonPath, JSON.stringify( pkgJson, null, 2 ) );
 	}
 }
 

package/lib/utils/assertfilestopublish.js

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md.
  */
 
-import fs from 'fs-extra';
+import fs from 'fs/promises';
 import upath from 'upath';
 import { glob } from 'glob';
 
@@ -19,8 +19,9 @@ export default async function assertFilesToPublish( packagePaths, optionalEntrie
 
 	for ( const packagePath of packagePaths ) {
 		const requiredEntries = [];
-		const packageJsonPath = upath.join( packagePath, 'package.json' );
-		const packageJson = await fs.readJson( packageJsonPath );
+		const path = upath.join( packagePath, 'package.json' );
+		const file = await fs.readFile( path, 'utf-8' );
+		const packageJson = JSON.parse( file );
 
 		if ( packageJson.main ) {
 			requiredEntries.push( packageJson.main );

package/lib/utils/assertnpmtag.js

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md.
  */
 
-import fs from 'fs-extra';
+import fs from 'fs/promises';
 import upath from 'upath';
 import getNpmTagFromVersion from './getnpmtagfromversion.js';
 
@@ -23,8 +23,9 @@ export default async function assertNpmTag( packagePaths, npmTag ) {
 	const errors = [];
 
 	for ( const packagePath of packagePaths ) {
-		const packageJsonPath = upath.join( packagePath, 'package.json' );
-		const packageJson = await fs.readJson( packageJsonPath );
+		const path = upath.join( packagePath, 'package.json' );
+		const file = await fs.readFile( path, 'utf-8' );
+		const packageJson = JSON.parse( file );
 		const versionTag = getNpmTagFromVersion( packageJson.version );
 
 		if ( versionTag === npmTag ) {

package/lib/utils/assertpackages.js

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md.
  */
 
-import fs from 'fs-extra';
+import fs from 'fs/promises';
 import upath from 'upath';
 
 /**
@@ -24,13 +24,14 @@ export default async function assertPackages( packagePaths, options ) {
 	for ( const packagePath of packagePaths ) {
 		const packageName = upath.basename( packagePath );
 		const packageJsonPath = upath.join( packagePath, 'package.json' );
+		const hasPkgJson = await fs.access( packageJsonPath ).then( () => true, () => false );
 
-		if ( await fs.pathExists( packageJsonPath ) ) {
+		if ( hasPkgJson ) {
 			if ( !requireEntryPoint ) {
 				continue;
 			}
 
-			const { name: packageName, main: entryPoint } = await fs.readJson( packageJsonPath );
+			const { name: packageName, main: entryPoint } = JSON.parse( await fs.readFile( packageJsonPath, 'utf-8' ) );
 
 			if ( optionalEntryPointPackages.includes( packageName ) ) {
 				continue;

package/lib/utils/confirmnpmtag.js

@@ -3,8 +3,8 @@
  * For licensing, see LICENSE.md.
  */
 
+import { styleText } from 'util';
 import inquirer from 'inquirer';
-import chalk from 'chalk';
 
 /**
  * Asks a user for a confirmation for updating and tagging versions of the packages.
@@ -15,7 +15,7 @@ import chalk from 'chalk';
  */
 export default function confirmNpmTag( versionTag, npmTag ) {
 	const areVersionsEqual = versionTag === npmTag;
-	const color = areVersionsEqual ? chalk.magenta : chalk.red;
+	const color = text => areVersionsEqual ? styleText( 'magenta', text ) : styleText( 'red', text );
 
 	// eslint-disable-next-line @stylistic/max-len
 	const message = `The next release bumps the "${ color( versionTag ) }" version. Should it be published to npm as "${ color( npmTag ) }"?`;

package/lib/utils/publishpackageonnpmcallback.js

@@ -13,7 +13,7 @@
  */
 export default async function publishPackageOnNpmCallback( packagePath, taskOptions ) {
 	const { tools } = await import( '@ckeditor/ckeditor5-dev-utils' );
-	const { default: fs } = await import( 'fs-extra' );
+	const { rm } = await import( 'fs/promises' );
 
 	try {
 		await tools.shExec( `npm publish --access=public --tag ${ taskOptions.npmTag }`, {
@@ -22,7 +22,7 @@ export default async function publishPackageOnNpmCallback( packagePath, taskOpti
 			verbosity: 'silent'
 		} );
 
-		await fs.remove( packagePath );
+		await rm( packagePath, { recursive: true, force: true } );
 	} catch {
 		// Do nothing if an error occurs. A parent task will handle it.
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-dev-release-tools",
-  "version": "54.0.0",
+  "version": "54.1.0",
   "description": "Tools used for releasing CKEditor 5 and related packages.",
   "keywords": [],
   "author": "CKSource (http://cksource.com/)",
@@ -22,11 +22,9 @@
     "lib"
   ],
   "dependencies": {
-    "@ckeditor/ckeditor5-dev-utils": "^54.0.0",
+    "@ckeditor/ckeditor5-dev-utils": "^54.1.0",
     "@octokit/rest": "^22.0.0",
-    "chalk": "^5.0.0",
     "cli-columns": "^4.0.0",
-    "fs-extra": "^11.0.0",
     "glob": "^11.0.2",
     "inquirer": "^12.5.2",
     "semver": "^7.6.3",
@@ -34,4 +32,4 @@
     "simple-git": "^3.27.0",
     "upath": "^2.0.1"
   }
-}
+}