@ckeditor/ckeditor5-dev-release-tools 34.0.2 → 34.1.0

package/lib/tasks/releasesubrepositories.js

@@ -10,6 +10,7 @@ const path = require( 'path' );
 const chalk = require( 'chalk' );
 const glob = require( 'glob' );
 const mkdirp = require( 'mkdirp' );
+const semver = require( 'semver' );
 const Table = require( 'cli-table' );
 const { tools, logger } = require( '@ckeditor/ckeditor5-dev-utils' );
 const parseGithubUrl = require( 'parse-github-url' );
@@ -98,6 +99,9 @@ const additionalFiles = [
  * @param {String|null} options.packages Where to look for other packages (dependencies). If `null`, only repository specified under
  * `options.cwd` will be used in the task.
  *
+ * @param {String} [options.npmTag='latest'] Defines an npm tag which the package manager will use when installing the package.
+ * Read more: https://docs.npmjs.com/cli/v8/commands/npm-publish#tag.
+ *
  * @param {Array.<String>} [options.skipPackages=[]] Name of packages which won't be released.
  *
  * @param {Boolean} [options.dryRun=false] If set on true, nothing will be published:
@@ -140,6 +144,7 @@ module.exports = async function releaseSubRepositories( options ) {
 
 	const dryRun = Boolean( options.dryRun );
 	const releaseBranch = options.releaseBranch || 'master';
+	const npmTag = options.npmTag || 'latest';
 	const customReleases = Array.isArray( options.customReleases ) ? options.customReleases : [ options.customReleases ].filter( Boolean );
 
 	// When preparing packages for release, we check whether there are files in the directory structure of the package, which are
@@ -188,6 +193,7 @@ module.exports = async function releaseSubRepositories( options ) {
 	return configureRelease()
 		.then( _releaseOptions => saveReleaseOptions( _releaseOptions ) )
 		.then( () => authCheck() )
+		.then( () => confirmNpmTag() )
 		.then( () => preparePackagesToRelease() )
 		.then( () => filterPackagesToReleaseOnNpm() )
 		.then( () => filterPackagesToReleaseOnGitHub() )
@@ -267,6 +273,33 @@ module.exports = async function releaseSubRepositories( options ) {
 		}
 	}
 
+	// Verifies if the provided by the user npm tag should be used to release new packages to npm.
+	//
+	// @returns {Promise}
+	function confirmNpmTag() {
+		if ( !releaseOptions.npm ) {
+			return Promise.resolve();
+		}
+
+		const packageJson = getPackageJson( options.cwd );
+		logProcess( 'Verifying the npm tag...' );
+
+		const [ versionTag ] = semver.prerelease( packageJson.version ) || [ 'latest' ];
+
+		if ( versionTag !== npmTag ) {
+			log.warning( '⚠️  The version tag is different from the npm tag.' );
+		} else {
+			log.info( '✅  Release tags are defined correctly.' );
+		}
+
+		return cli.confirmNpmTag( versionTag, npmTag )
+			.then( isConfirmed => {
+				if ( !isConfirmed ) {
+					throw new Error( BREAK_RELEASE_MESSAGE );
+				}
+			} );
+	}
+
 	// Checks whether to a user is logged to npm.
 	//
 	// @returns {Promise}
@@ -415,6 +448,7 @@ module.exports = async function releaseSubRepositories( options ) {
 		// The keys in returned map are file patterns, and their values represent number of matched files. If there is no `#files` key
 		// in `package.json`, then empty map is returned.
 		function getMatchedFilesToPublish( packageJson, repositoryPath ) {
+			// TODO: Include the `main` and `types` properties if they are specified.
 			if ( !packageJson.files ) {
 				return new Map();
 			}
@@ -727,10 +761,26 @@ module.exports = async function releaseSubRepositories( options ) {
 			// For this reason we have to temporarily replace the extension in the `main` field while the package is being published to npm.
 			// This change is then reverted.
 			const hasTypeScriptEntryPoint = packageJson.main && packageJson.main.endsWith( '.ts' );
+			const hasTypesProperty = !!packageJson.types;
 
+			// TODO: The entire update phase should be done before collecting packages
+			// TODO: to publish on npm (the `filterPackagesToReleaseOnNpm()` task).
 			if ( hasTypeScriptEntryPoint ) {
 				tools.updateJSONFile( packageJsonPath, jsonFile => {
-					jsonFile.main = jsonFile.main.replace( '.ts', '.js' );
+					const { main } = jsonFile;
+
+					jsonFile.main = main.replace( /\.ts$/, '.js' );
+
+					if ( !hasTypesProperty ) {
+						const typesPath = main.replace( /\.ts$/, '.d.ts' );
+						const absoluteTypesPath = path.join( repositoryPath, typesPath );
+
+						if ( fs.existsSync( absoluteTypesPath ) ) {
+							jsonFile.types = typesPath;
+						} else {
+							log.warning( `⚠️  The "${ typesPath }" file does not exist and cannot be a source of typings.` );
+						}
+					}
 
 					return jsonFile;
 				} );
@@ -756,7 +806,11 @@ module.exports = async function releaseSubRepositories( options ) {
 			// again to the `index.ts` file.
 			if ( hasTypeScriptEntryPoint ) {
 				tools.updateJSONFile( packageJsonPath, jsonFile => {
-					jsonFile.main = jsonFile.main.replace( '.js', '.ts' );
+					jsonFile.main = jsonFile.main.replace( /\.js$/, '.ts' );
+
+					if ( !hasTypesProperty ) {
+						delete jsonFile.types;
+					}
 
 					return jsonFile;
 				} );

package/lib/utils/cli.js

@@ -314,6 +314,31 @@ const cli = {
 						return options;
 					} );
 			} );
+	},
+
+	/**
+	 * Asks a user for a confirmation for updating and tagging versions of the packages.
+	 *
+	 * @param {String} versionTag A version tag based on a package version specified in `package.json`.
+	 * @param {String} npmTag A tag typed by the user when using the release tools.
+	 * @returns {Promise.<Boolean>}
+	 */
+	confirmNpmTag( versionTag, npmTag ) {
+		const areVersionsEqual = versionTag === npmTag;
+		const color = areVersionsEqual ? chalk.magenta : chalk.red;
+
+		// eslint-disable-next-line max-len
+		const message = `The next release bumps the "${ color( versionTag ) }" version. Should it be published to npm as "${ color( npmTag ) }"?`;
+
+		const confirmQuestion = {
+			message,
+			type: 'confirm',
+			name: 'confirm',
+			default: areVersionsEqual
+		};
+
+		return inquirer.prompt( [ confirmQuestion ] )
+			.then( answers => answers.confirm );
 	}
 };
 

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@ckeditor/ckeditor5-dev-release-tools",
-  "version": "34.0.2",
+  "version": "34.1.0",
   "description": "Tools used for releasing CKEditor 5 and related packages.",
   "keywords": [],
   "main": "lib/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-dev-utils": "^34.0.2",
+    "@ckeditor/ckeditor5-dev-utils": "^34.1.0",
     "@octokit/rest": "^17.9.2",
     "chalk": "^4.0.0",
     "cli-table": "^0.3.1",