@aikidosec/safe-chain 1.0.11 → 1.0.12

package/README.md

@@ -14,7 +14,7 @@ Installing the Aikido Safe Chain is easy. You just need 3 simple steps:
    ```
 2. **Setup the shell integration** by running:
    ```shell
-   safe-chain setup-shell
+   safe-chain setup
    ```
 3. **Restart your terminal** to start using the Aikido Safe Chain.
 
@@ -26,7 +26,7 @@ The Aikido Safe Chain will setup aliases in your shell for the commands **npm**,
 
 ### Creating shell aliases
 
-The `setup-shell` command will detect which shells are installed and add the aliases for **npm**, **npx**, and **yarn** to your shell startup scripts.
+The `setup` command will detect which shells are installed and add the aliases for **npm**, **npx**, and **yarn** to your shell startup scripts.
 
 Supported shells include:
 
@@ -40,7 +40,7 @@ After adding the alias, **the shell needs to restart in order to load the alias*
 
 ### Removing shell aliases
 
-The `remove-shell` command will remove the aliases for **npm**, **npx**, and **yarn** from your shell startup scripts. This is useful if you want to stop using the Aikido Safe Chain or if you want to switch to a different package manager.
+The `teardown` command will remove the aliases for **npm**, **npx**, and **yarn** from your shell startup scripts. This is useful if you want to stop using the Aikido Safe Chain or if you want to switch to a different package manager.
 
 ## Uninstallation
 
@@ -48,7 +48,7 @@ To uninstall the Aikido Safe Chain, you can run the following command:
 
 1. **Remove all aliases from your shell** by running:
    ```shell
-   safe-chain remove-shell
+   safe-chain teardown
    ```
 2. **Uninstall the Aikido Safe Chain package** using npm:
    ```shell

package/bin/safe-chain.js

@@ -2,8 +2,8 @@
 
 import chalk from "chalk";
 import { ui } from "../src/environment/userInteraction.js";
-import { setupShell } from "../src/shell-integration/setupShell.js";
-import { removeShell } from "../src/shell-integration/removeShell.js";
+import { setup } from "../src/shell-integration/setup.js";
+import { teardown } from "../src/shell-integration/teardown.js";
 
 if (process.argv.length < 3) {
   ui.writeError("No command provided. Please provide a command to execute.");
@@ -19,10 +19,10 @@ if (command === "help" || command === "--help" || command === "-h") {
   process.exit(0);
 }
 
-if (command === "setup-shell") {
-  setupShell();
-} else if (command === "remove-shell") {
-  removeShell();
+if (command === "setup") {
+  setup();
+} else if (command === "teardown") {
+  teardown();
 } else {
   ui.writeError(`Unknown command: ${command}.`);
   ui.emptyLine();
@@ -38,19 +38,19 @@ function writeHelp() {
   );
   ui.emptyLine();
   ui.writeInformation(
-    `Available commands: ${chalk.cyan("setup-shell")}, ${chalk.cyan(
-      "remove-shell"
+    `Available commands: ${chalk.cyan("setup")}, ${chalk.cyan(
+      "teardown"
     )}, ${chalk.cyan("help")}`
   );
   ui.emptyLine();
   ui.writeInformation(
     `- ${chalk.cyan(
-      "safe-chain setup-shell"
+      "safe-chain setup"
     )}: This will setup your shell to wrap safe-chain around npm, npx and yarn.`
   );
   ui.writeInformation(
     `- ${chalk.cyan(
-      "safe-chain remove-shell"
+      "safe-chain teardown"
     )}: This will remove safe-chain aliases from your shell configuration.`
   );
   ui.emptyLine();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aikidosec/safe-chain",
-  "version": "1.0.11",
+  "version": "1.0.12",
   "scripts": {
     "test": "node --test --experimental-test-module-mocks **/*.spec.js",
     "test:watch": "node --test --watch --experimental-test-module-mocks **/*.spec.js",

package/src/shell-integration/{setupShell.js → setup.js}

@@ -5,7 +5,7 @@ import { getAliases } from "./helpers.js";
 import fs from "fs";
 import { EOL } from "os";
 
-export async function setupShell() {
+export async function setup() {
   ui.writeInformation(
     chalk.bold("Setting up shell aliases.") +
       " This will wrap safe-chain around npm, npx, and yarn commands."

package/src/shell-integration/{setupShell.spec.js → setup.spec.js}

@@ -3,7 +3,7 @@ import assert from "node:assert";
 import { EOL, tmpdir } from "node:os";
 import fs from "node:fs";
 import { getAliases } from "./helpers.js";
-import { readOrCreateStartupFile, appendAliasesToFile } from "./setupShell.js";
+import { readOrCreateStartupFile, appendAliasesToFile } from "./setup.js";
 
 describe("setupShell", () => {
   function runSetupTestsForEnvironment(shell, startupExtension, expectedAliases) {

package/src/shell-integration/{removeShell.js → teardown.js}

@@ -5,7 +5,7 @@ import { getAliases } from "./helpers.js";
 import fs from "fs";
 import { EOL } from "os";
 
-export async function removeShell() {
+export async function teardown() {
   ui.writeInformation(
     chalk.bold("Removing shell aliases.") +
       " This will remove safe-chain aliases for npm, npx, and yarn commands."

package/src/shell-integration/{removeShell.spec.js → teardown.spec.js}

@@ -3,9 +3,9 @@ import assert from "node:assert";
 import { EOL, tmpdir } from "node:os";
 import fs from "node:fs";
 import { getAliases } from "./helpers.js";
-import { removeAliasesFromFile } from "./removeShell.js";
+import { removeAliasesFromFile } from "./teardown.js";
 
-describe("removeShell", () => {
+describe("teardown", () => {
   function runRemovalTestsForEnvironment(shell, startupExtension, expectedAliases) {
     describe(`${shell} shell removal`, () => {
       it(`should remove aliases from ${shell} file`, () => {