@versatiles/release-tool 1.1.0 → 1.2.0

package/README.md

@@ -9,6 +9,35 @@ Tools used internally for:
 * creating Markdown documentation of executables: [`vrt cmd2md`](#subcommand-vrt-cmd2md)
 * inserting Markdown into documents: [`vrt insertmd`](#subcommand-vrt-insertmd)
 * updating "Table of Content" in Markdown files: [`vrt inserttoc`](#subcommand-vrt-inserttoc)
+* releasing the current version as npm package: [`vrt release-npm`](#subcommand-vrt-release-npm)
+
+# Installation
+
+```bash
+npm i -D @versatiles/release-tool
+```
+
+# configure scripts
+
+You need to configure the scripts in the package.json:
+
+```JSON
+{
+  "scripts": {
+    "check": "npm run lint && npm run build && npm run test",
+    "prepack": "npm run build && npm run doc",
+    "release": "vrt release-npm",
+    ...
+  },
+  ...
+}
+```
+
+* `scripts.check` is **required** by the release command. Here you can lint, build and test your code.
+* `scripts.prepack` is **recommended** to ensure that all files are up-to-date before releasing. Here you can build code and documentation.
+* `scripts.release` is **recommended** to make it easy to release a new version.
+
+Have a look at this [package.json](https://github.com/versatiles-org/node-release-tool/blob/main/package.json) as an example.
 
 # Command `vrt`
 

package/dist/commands/release.js

@@ -25,12 +25,8 @@ export async function release(directory, branch = 'main') {
         panic('package.json is missing "version"');
     if (!('scripts' in pkg) || (typeof pkg.scripts !== 'object') || (pkg.scripts == null))
         panic('package.json is missing "scripts"');
-    const { scripts } = pkg;
-    for (const scriptName of ['lint', 'build', 'test', 'doc']) {
-        if (!(scriptName in scripts)) {
-            panic(`missing npm script "${scriptName}" in package.json`);
-        }
-    }
+    if (!('check' in pkg.scripts))
+        panic('missing npm script "check" in package.json');
     // get last version
     const tag = await check('get last github tag', getLastGitHubTag());
     const shaLast = tag?.sha;
@@ -46,14 +42,8 @@ export async function release(directory, branch = 'main') {
     const releaseNotes = await check('prepare release notes', getReleaseNotes(nextVersion, shaLast, shaCurrent));
     // update version
     await check('update version', setNextVersion(nextVersion));
-    // lint
-    await check('lint', shell.run('npm run lint'));
-    // build
-    await check('build', shell.run('npm run build'));
-    // test
-    await check('run tests', shell.run('npm run test'));
     // test
-    await check('update doc', shell.run('npm run doc'));
+    await check('run checks', shell.run('npm run check'));
     // npm publish
     await check('npm publish', shell.run('npm publish --access public'));
     // git push

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@versatiles/release-tool",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "VersaTiles release and documentation tools",
   "bin": {
     "vrt": "./dist/index.js"
@@ -15,6 +15,7 @@
     "doc": "npx vrt cmd2md vrt | npx vrt insertmd README.md '# Command'",
     "lint": "eslint . --color",
     "prepack": "npm run build && npm run doc",
+    "release": "npx vrt release-npm",
     "test-coverage": "NODE_OPTIONS=--experimental-vm-modules jest --coverage",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest",
     "upgrade": "npm-check-updates -u && rm -f package-lock.json; rm -rf node_modules; npm i && npm update"
@@ -30,7 +31,7 @@
   "devDependencies": {
     "@types/inquirer": "^9.0.7",
     "@types/jest": "^29.5.11",
-    "@types/node": "^20.11.10",
+    "@types/node": "^20.11.15",
     "@typescript-eslint/eslint-plugin": "^6.20.0",
     "@typescript-eslint/parser": "^6.20.0",
     "eslint": "^8.56.0",