@html-validate/release-scripts 3.4.3 → 3.5.1

package/README.md

@@ -9,13 +9,49 @@ Various scripts used by release toolchain.
 ```json
 {
   "scripts": {
-    "prepack": "release-prepack package.json",
-    "postpack": "release-postpack package.json"
-    "prepublishOnly": "release-prepublish package.json",
-    "postpublish": "release-postpublish package.json"
+    "prepack": "release-prepack",
+    "postpack": "release-postpack",
+    "prepublishOnly": "release-prepublish",
+    "postpublish": "release-postpublish"
   }
 }
 ```
 
-If the library or CLI tool bundles all dependencies use `release-prepack package.json --bundle`.
+If the library or CLI tool bundles all dependencies use `release-prepack --bundle`.
 Dependencies can also be filtered by marking dependencies as external: `--bundle --external:foo --external:bar`.
+
+```json
+{
+  "scripts": {
+    "prepack": "release-prepack --bundle --external:foo --external:bar",
+    "postpack": "release-postpack",
+    "prepublishOnly": "release-prepublish --bundle --external:foo --external:bar",
+    "postpublish": "release-postpublish"
+  }
+}
+```
+
+### Usage
+
+    release-prepack [FILENAME] [OPTIONS..]
+    release-postpack [FILENAME]
+    release-prepublish [FILENAME] [OPTIONS..]
+    release-postpublish [FILENAME]
+
+If `FILENAME` is set it is the filename to use instead of the default `package.json`.
+
+### Options
+
+#### `--bundle`
+
+By default the `dependencies` field in `package.json` is intact but if your package bundles its dependencies the `--bundle` flag can be used to strip out dependencies as well.
+
+#### `--external:${NAME}`
+
+When using in conjunction with `--bundle` it marks a dependency which should still be intact.
+For instance, using `--external:foobar` all packages in `dependencies` except `foobar` will be stripped.
+This flag can be used multiple times.
+
+#### `--retain-scripts`
+
+By default the `scripts` field is stripped but with this flag enabled the scripts will be intact.

package/lib/get-args.js

@@ -0,0 +1,11 @@
+/**
+ * @param {string[]} argv
+ * @returns {[flags: string[], positionals: string[]]}
+ */
+function getArgs(argv) {
+	const flags = argv.filter((it) => it.startsWith("--"));
+	const positionals = argv.filter((it) => !it.startsWith("--"));
+	return [flags, positionals];
+}
+
+module.exports = { getArgs };

package/lib/postpack.js

@@ -9,7 +9,7 @@ if (command === "publish" && event === "postpack") {
 	process.exit(0);
 }
 
-const filename = process.argv[2];
+const filename = process.argv[2] || "package.json";
 const filepath = path.resolve(filename);
 const origfile = `${filepath}.orig`;
 

package/lib/prepack.js

@@ -3,6 +3,8 @@
 const path = require("path");
 const fs = require("fs");
 const { filterDependencies } = require("./filter-dependencies");
+const { getArgs } = require("./get-args");
+const { readPackageJson } = require("./read-package-json");
 const { stripFields } = require("./strip-fields");
 
 /* ensure this script runs via the correct lifecycle event */
@@ -11,41 +13,45 @@ if (command === "publish" && event === "prepack") {
 	process.exit(0);
 }
 
-const filename = process.argv[2];
-const filepath = path.resolve(filename);
-const tmpfile = `${filepath}.tmp`;
-const origfile = `${filepath}.orig`;
-
-const bundle = process.argv.includes("--bundle");
-const externals = process.argv
+const [flags, positionals] = getArgs(process.argv.slice(2));
+const bundle = flags.includes("--bundle");
+const retainScripts = flags.includes("--retain-scripts");
+const externals = flags
 	.filter((it) => it.startsWith("--external:"))
 	.map((it) => it.slice("--external:".length));
 
-if (!fs.existsSync(filepath)) {
-	process.stderr.write(`release-prepack: No such file or directory: "${filepath}"\n`);
+const filename = positionals[0] || "package.json";
+const filePath = path.resolve(filename);
+const tmpfile = `${filePath}.tmp`;
+const origfile = `${filePath}.orig`;
+
+if (!fs.existsSync(filePath)) {
+	process.stderr.write(`release-prepack: No such file or directory: "${filePath}"\n`);
 	process.exit(1);
 }
 
-const pkg = JSON.parse(fs.readFileSync(filepath, "utf-8"));
+const pkg = readPackageJson(filePath);
 pkg.dependencies = filterDependencies(pkg.dependencies, bundle, externals);
 
-stripFields(pkg);
+const stripped = stripFields(pkg, {
+	retainScripts,
+});
 
-const content = JSON.stringify(pkg, null, 2);
+const content = JSON.stringify(stripped, null, 2);
 console.log(content);
 
 /* backup original file in case of error */
-fs.copyFileSync(filepath, origfile);
+fs.copyFileSync(filePath, origfile);
 
 try {
 	/* write to a temporary file first */
 	fs.writeFileSync(tmpfile, `${content}\n`, "utf-8");
 
 	/* swap tempfile for original */
-	fs.renameSync(tmpfile, filepath);
+	fs.renameSync(tmpfile, filePath);
 } catch (err) {
 	console.error(err);
 	process.stderr.write(`\nRestoring "${filename}" after failure\n`);
-	fs.copyFileSync(origfile, filepath);
+	fs.copyFileSync(origfile, filePath);
 	process.exit(1);
 }

package/lib/read-package-json.js

@@ -0,0 +1,11 @@
+const fs = require("fs");
+
+/**
+ * @param {string} filePath
+ * @returns {object}
+ */
+function readPackageJson(filePath) {
+	return JSON.parse(fs.readFileSync(filePath, "utf-8"));
+}
+
+module.exports = { readPackageJson };

package/lib/strip-fields.js

@@ -1,3 +1,8 @@
+/**
+ * @typedef {object} StripOptions
+ * @property {boolean} [retainScripts]
+ */
+
 const strip = [
 	"ava",
 	"c8",
@@ -12,18 +17,30 @@ const strip = [
 	"prettier",
 	"release",
 	"renovate",
-	"scripts",
 	"simple-git-hooks",
 	"stylelint",
 	"tsd",
 	"xo",
 ];
 
-function stripFields(pkg) {
+/**
+ * @template T
+ * @param {T} pkg
+ * @param {StripOptions} options
+ * @returns {Partial<T>}
+ */
+function stripFields(pkg, options = {}) {
+	const result = { ...pkg };
 	for (const key of strip) {
 		/* eslint-disable-next-line security/detect-object-injection */
-		delete pkg[key];
+		delete result[key];
+	}
+
+	if (!options.retainScripts) {
+		delete result.scripts;
 	}
+
+	return result;
 }
 
 module.exports = { stripFields };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@html-validate/release-scripts",
-  "version": "3.4.3",
+  "version": "3.5.1",
   "description": "Various script used by release toolchain",
   "keywords": [
     "release"
@@ -38,5 +38,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f14f12b2be0e76be0ee4436f7a19d9ecb5039186"
+  "gitHead": "401cc65adde6b671a7859d28ff994e74e01f5953"
 }