@gkiely/safe-install 0.1.4 → 0.1.6

package/README.md

@@ -30,7 +30,7 @@ ignore-scripts=true
 ```json
 {
   "scripts": {
-    "safe-install": "npx -y @gkiely/safe-install -- --no-audit --no-fund"
+    "safe-install": "npx -y @gkiely/safe-install"
   }
 }
 ```
@@ -62,6 +62,12 @@ specifiers.
 npm run safe-install
 ```
 
+You can pass npm install args through:
+
+```sh
+npm run safe-install left-pad@latest
+```
+
 ## What `safe-install` does
 
 `safe-install` runs npm install with scripts blocked, then runs install scripts only for packages listed in
@@ -81,6 +87,16 @@ npm rebuild --ignore-scripts=false esbuild sharp
 
 ## Notes
 
+Supports npm install flags:
+
+```json
+{
+  "scripts": {
+    "safe-install": "npx -y @gkiely/safe-install --no-audit --no-fund"
+  }
+}
+```
+
 Only add a package to `trustedDependencies` after reviewing why it needs an
 install script. This does not make dependency scripts safe; it makes the trust
 decision explicit and version-controlled.

package/dist/index.d.ts

@@ -13,6 +13,14 @@ type LockPackage = {
 type PackageLock = {
     packages?: Record<string, LockPackage>;
 };
+type ParsedCommand = {
+    kind: "install";
+    args: string[];
+} | {
+    kind: "review-deps";
+} | {
+    kind: "help";
+};
 export declare function getTrustedDependencies(pkg: PackageJson): string[];
 export declare function findInstallScriptDependencies(packageLock: PackageLock, trustedDependencies?: readonly string[]): string[];
 type SafeInstallConfig = {
@@ -21,6 +29,7 @@ type SafeInstallConfig = {
 export declare function getSafeInstallConfig(pkg: PackageJson): SafeInstallConfig;
 export declare function assertNoBlockedExoticSubdeps(config: SafeInstallConfig, packageLock: PackageLock): void;
 export declare function getInstallArgs(args?: readonly string[]): string[];
+export declare function parseCommand(args: readonly string[]): ParsedCommand;
 export declare function reviewDepsCommand(): void;
 export declare function installCommand(args?: readonly string[]): void;
 export declare function main(args?: string[]): void;

package/dist/index.js

@@ -118,13 +118,22 @@ function run(command, args) {
 export function getInstallArgs(args = []) {
     return ["install", "--ignore-scripts", ...args];
 }
+export function parseCommand(args) {
+    if (args.includes("--help") || args.includes("-h")) {
+        return { kind: "help" };
+    }
+    if (args[0] === "--" && args[1] === "review-deps") {
+        return { kind: "review-deps" };
+    }
+    return { kind: "install", args: args.filter((arg) => arg !== "--") };
+}
 function printHelp() {
     console.log(`safe-install
 
 Usage:
-  safe-install [npm install flags]
+  safe-install [npm install args]
                         Run npm install with scripts disabled, then rebuild trusted dependencies
-  safe-install review-deps
+  safe-install -- review-deps
                         List dependencies that declare install-time scripts
 `);
 }
@@ -154,20 +163,16 @@ export function installCommand(args = []) {
     }
 }
 export function main(args = process.argv.slice(2)) {
-    if (args.includes("--help") || args.includes("-h")) {
+    const command = parseCommand(args);
+    if (command.kind === "help") {
         printHelp();
         return;
     }
-    const command = args.find((arg) => arg !== "--" && !arg.startsWith("-"));
-    if (command === undefined) {
-        installCommand(args.filter((arg) => arg !== "--"));
-        return;
-    }
-    if (command === "review-deps") {
+    if (command.kind === "review-deps") {
         reviewDepsCommand();
         return;
     }
-    throw new Error(`Unknown command: ${command}`);
+    installCommand(command.args);
 }
 if (process.argv[1] && realpathSync(fileURLToPath(import.meta.url)) === realpathSync(process.argv[1])) {
     try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gkiely/safe-install",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "Run npm installs with lifecycle scripts disabled, then rebuild explicitly trusted dependencies.",
   "author": "Grant Kiely <grant@youneedawiki.com>",
   "license": "MIT",
@@ -45,6 +45,7 @@
     "build": "tsc -p tsconfig.build.json",
     "prepack": "npm run build",
     "prepublishOnly": "npm run typecheck && npm test",
+    "release": "npm run typecheck && npm test && npm version patch && npm publish --access public && git push --follow-tags",
     "safe-install": "node dist/index.js",
     "test": "node --test",
     "typecheck": "tsc --noEmit"