@knocklabs/cli 0.2.1 → 0.2.3

package/dist/commands/workflow/generate-types.js

@@ -11,6 +11,7 @@ Object.defineProperty(exports, "default", {
 const _core = require("@oclif/core");
 const _fsextra = /*#__PURE__*/ _interop_require_wildcard(require("fs-extra"));
 const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _command = require("../../lib/helpers/command");
 const _const = require("../../lib/helpers/const");
 const _error = require("../../lib/helpers/error");
 const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
@@ -101,7 +102,8 @@ class WorkflowGenerateTypes extends _basecommand.default {
         }
         // 3. Write the generated types to the output file.
         await _fsextra.writeFile(flags["output-file"].abspath, result.lines.join("\n"));
-        this.log(`‣ Successfully generated types for ${workflowsWithValidTypes.length} workflow(s) and wrote them to ${flags["output-file"].abspath}`);
+        const scope = (0, _command.formatCommandScope)(flags);
+        this.log(`‣ Successfully generated types for ${workflowsWithValidTypes.length} workflow(s) using ${scope} and wrote them to ${flags["output-file"].abspath}`);
     }
     async listAllWorkflows(pageParams = {}, workflowsFetchedSoFar = []) {
         const props = (0, _objectisomorphic.merge)(this.props, {
@@ -132,6 +134,7 @@ _define_property(WorkflowGenerateTypes, "flags", {
         summary: "Select the environment to generate types for.",
         default: _const.KnockEnv.Development
     }),
+    branch: _flag.branch,
     "output-file": _flag.filePath({
         summary: "The output file to write the generated types to. We currently support .ts, .rb, .go, .py files only. Your file extension will determine the target language for the generated types.",
         required: true

package/dist/commands/workflow/get.js

@@ -10,13 +10,16 @@ Object.defineProperty(exports, "default", {
 });
 const _core = require("@oclif/core");
 const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _command = require("../../lib/helpers/command");
 const _date = require("../../lib/helpers/date");
 const _error = require("../../lib/helpers/error");
+const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
 const _request = require("../../lib/helpers/request");
 const _string = require("../../lib/helpers/string");
 const _ux = require("../../lib/helpers/ux");
 const _conditions = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/marshal/conditions"));
 const _workflow = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/marshal/workflow"));
+const _urls = require("../../lib/urls");
 function _define_property(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
@@ -103,9 +106,10 @@ class WorkflowGet extends _basecommand.default {
     }
     render(workflow, whoami) {
         const { workflowKey } = this.props.args;
-        const { environment: env, "hide-uncommitted-changes": commitedOnly } = this.props.flags;
+        const { environment: env, branch, "hide-uncommitted-changes": commitedOnly } = this.props.flags;
         const qualifier = env === "development" && !commitedOnly ? "(including uncommitted)" : "";
-        this.log(`‣ Showing workflow \`${workflowKey}\` in \`${env}\` environment ${qualifier}\n`);
+        const scope = (0, _command.formatCommandScope)(this.props.flags);
+        this.log(`‣ Showing workflow \`${workflowKey}\` in ${scope} ${qualifier}\n`);
         /*
      * Workflow table
      */ const rows = [
@@ -191,9 +195,9 @@ class WorkflowGet extends _basecommand.default {
         });
         const hasTopLevelBranchStep = workflow.steps.some((step)=>step.type === _workflow.StepType.Branch);
         const dashboardLinkMessage = hasTopLevelBranchStep ? `\n‣ This workflow has branches with nested steps, view the full workflow tree in the Knock Dashboard:` : `\n‣ View the full workflow in the Knock Dashboard:`;
-        const viewWorkflowUrl = `https://dashboard.knock.app/${whoami.account_slug}/${env.toLowerCase()}/workflows/${workflow.key}`;
+        const url = (0, _urls.viewWorkflowUrl)(this.sessionContext.dashboardOrigin, whoami.account_slug, branch !== null && branch !== void 0 ? branch : env, workflow.key);
         this.log(dashboardLinkMessage);
-        this.log((0, _string.indentString)(viewWorkflowUrl, 2));
+        this.log((0, _string.indentString)(url, 2));
     }
 }
 _define_property(WorkflowGet, "summary", "Display a single workflow from an environment.");
@@ -202,6 +206,7 @@ _define_property(WorkflowGet, "flags", {
         default: "development",
         summary: "The environment to use."
     }),
+    branch: _flag.branch,
     "hide-uncommitted-changes": _core.Flags.boolean({
         summary: "Hide any uncommitted changes."
     })

package/dist/commands/workflow/list.js

@@ -10,7 +10,9 @@ Object.defineProperty(exports, "default", {
 });
 const _core = require("@oclif/core");
 const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _command = require("../../lib/helpers/command");
 const _date = require("../../lib/helpers/date");
+const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
 const _objectisomorphic = require("../../lib/helpers/object.isomorphic");
 const _page = require("../../lib/helpers/page");
 const _request = require("../../lib/helpers/request");
@@ -93,7 +95,8 @@ class WorkflowList extends _basecommand.default {
         const { entries } = data;
         const { environment: env, "hide-uncommitted-changes": commitedOnly } = this.props.flags;
         const qualifier = env === "development" && !commitedOnly ? "(including uncommitted)" : "";
-        this.log(`‣ Showing ${entries.length} workflows in \`${env}\` environment ${qualifier}\n`);
+        const scope = (0, _command.formatCommandScope)(this.props.flags);
+        this.log(`‣ Showing ${entries.length} workflows in ${scope} ${qualifier}\n`);
         /*
      * Workflows list table
      */ _core.ux.table(entries, {
@@ -144,6 +147,7 @@ _define_property(WorkflowList, "flags", {
         default: "development",
         summary: "The environment to use."
     }),
+    branch: _flag.branch,
     "hide-uncommitted-changes": _core.Flags.boolean({
         summary: "Hide any uncommitted changes."
     }),

package/dist/commands/workflow/pull.js

@@ -11,6 +11,7 @@ Object.defineProperty(exports, "default", {
 const _nodepath = /*#__PURE__*/ _interop_require_wildcard(require("node:path"));
 const _core = require("@oclif/core");
 const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _command = require("../../lib/helpers/command");
 const _error = require("../../lib/helpers/error");
 const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
 const _objectisomorphic = require("../../lib/helpers/object.isomorphic");
@@ -114,7 +115,8 @@ class WorkflowPull extends _basecommand.default {
         // 3. Write the fetched workflow to create or update the workflow directory.
         await _workflow.writeWorkflowDirFromData(dirContext, resp.data);
         const action = dirContext.exists ? "updated" : "created";
-        this.log(`‣ Successfully ${action} \`${dirContext.key}\` at ${dirContext.abspath}`);
+        const scope = (0, _command.formatCommandScope)(flags);
+        this.log(`‣ Successfully ${action} \`${dirContext.key}\` at ${dirContext.abspath} using ${scope}`);
     }
     async getWorkflowDirContext() {
         const { workflowKey } = this.props.args;
@@ -163,7 +165,8 @@ class WorkflowPull extends _basecommand.default {
         await _workflow.writeWorkflowsIndexDir(targetDirCtx, workflows);
         _ux.spinner.stop();
         const action = targetDirCtx.exists ? "updated" : "created";
-        this.log(`‣ Successfully ${action} the workflows directory at ${targetDirCtx.abspath}`);
+        const scope = (0, _command.formatCommandScope)(flags);
+        this.log(`‣ Successfully ${action} the workflows directory at ${targetDirCtx.abspath} using ${scope}`);
     }
     async listAllWorkflows(pageParams = {}, workflowsFetchedSoFar = []) {
         const props = (0, _objectisomorphic.merge)(this.props, {
@@ -194,6 +197,7 @@ _define_property(WorkflowPull, "flags", {
         default: "development",
         summary: "The environment to use."
     }),
+    branch: _flag.branch,
     all: _core.Flags.boolean({
         summary: "Whether to pull all workflows from the specified environment."
     }),

package/dist/commands/workflow/push.js

@@ -10,6 +10,7 @@ Object.defineProperty(exports, "default", {
 });
 const _core = require("@oclif/core");
 const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _command = require("../../lib/helpers/command");
 const _const = require("../../lib/helpers/const");
 const _error = require("../../lib/helpers/error");
 const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
@@ -130,7 +131,8 @@ class WorkflowPush extends _basecommand.default {
         // 4. Display a success message.
         const workflowKeys = workflows.map((w)=>w.key);
         const actioned = flags.commit ? "pushed and committed" : "pushed";
-        this.log(`‣ Successfully ${actioned} ${workflows.length} workflow(s):\n` + (0, _string.indentString)(workflowKeys.join("\n"), 4));
+        const scope = (0, _command.formatCommandScope)(flags);
+        this.log(`‣ Successfully ${actioned} ${workflows.length} workflow(s) to ${scope}:\n` + (0, _string.indentString)(workflowKeys.join("\n"), 4));
     }
 }
 _define_property(WorkflowPush, "summary", "Push one or more workflows from a local file system to Knock.");
@@ -142,6 +144,7 @@ _define_property(WorkflowPush, "flags", {
             _const.KnockEnv.Development
         ]
     }),
+    branch: _flag.branch,
     all: _core.Flags.boolean({
         summary: "Whether to push all workflows from the target directory."
     }),

package/dist/commands/workflow/run.js

@@ -10,7 +10,8 @@ Object.defineProperty(exports, "default", {
 });
 const _core = require("@oclif/core");
 const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
-const _flag = require("../../lib/helpers/flag");
+const _command = require("../../lib/helpers/command");
+const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
 const _request = require("../../lib/helpers/request");
 const _string = require("../../lib/helpers/string");
 function _define_property(obj, key, value) {
@@ -31,13 +32,55 @@ function _interop_require_default(obj) {
         default: obj
     };
 }
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interop_require_wildcard(obj, nodeInterop) {
+    if (!nodeInterop && obj && obj.__esModule) {
+        return obj;
+    }
+    if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
+        return {
+            default: obj
+        };
+    }
+    var cache = _getRequireWildcardCache(nodeInterop);
+    if (cache && cache.has(obj)) {
+        return cache.get(obj);
+    }
+    var newObj = {
+        __proto__: null
+    };
+    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
+    for(var key in obj){
+        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
+            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
+            if (desc && (desc.get || desc.set)) {
+                Object.defineProperty(newObj, key, desc);
+            } else {
+                newObj[key] = obj[key];
+            }
+        }
+    }
+    newObj.default = obj;
+    if (cache) {
+        cache.set(obj, newObj);
+    }
+    return newObj;
+}
 class WorkflowRun extends _basecommand.default {
     async run() {
         const { args, flags } = this.props;
         const resp = await (0, _request.withSpinner)(()=>this.apiV1.runWorkflow(this.props), {
             action: "‣ Running"
         });
-        this.log(`‣ Successfully ran \`${args.workflowKey}\` workflow in \`${flags.environment}\` environment`);
+        const scope = (0, _command.formatCommandScope)(flags);
+        this.log(`‣ Successfully ran \`${args.workflowKey}\` workflow in ${scope}`);
         this.log((0, _string.indentString)(`Workflow run id: ${resp.data.workflow_run_id}`, 4));
     }
 }
@@ -47,6 +90,7 @@ _define_property(WorkflowRun, "flags", {
         default: "development",
         summary: "The environment in which to run the workflow"
     }),
+    branch: _flag.branch,
     recipients: (0, _flag.maybeJsonStrAsList)({
         required: true,
         aliases: [

package/dist/commands/workflow/validate.js

@@ -10,6 +10,7 @@ Object.defineProperty(exports, "default", {
 });
 const _core = require("@oclif/core");
 const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _command = require("../../lib/helpers/command");
 const _const = require("../../lib/helpers/const");
 const _error = require("../../lib/helpers/error");
 const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
@@ -102,7 +103,8 @@ class WorkflowValidate extends _basecommand.default {
         _ux.spinner.stop();
         // 3. Display a success message.
         const workflowKeys = workflows.map((w)=>w.key);
-        this.log(`‣ Successfully validated ${workflows.length} workflow(s):\n` + (0, _string.indentString)(workflowKeys.join("\n"), 4));
+        const scope = (0, _command.formatCommandScope)(this.props.flags);
+        this.log(`‣ Successfully validated ${workflows.length} workflow(s) using ${scope}:\n` + (0, _string.indentString)(workflowKeys.join("\n"), 4));
     }
     static async validateAll(api, props, workflows) {
         // TODO: Throw an error if a non validation error (e.g. authentication error)
@@ -129,6 +131,7 @@ _define_property(WorkflowValidate, "flags", {
             _const.KnockEnv.Development
         ]
     }),
+    branch: _flag.branch,
     all: _core.Flags.boolean({
         summary: "Whether to validate all workflows from the target directory."
     }),

package/dist/lib/api-v1.js

@@ -40,9 +40,6 @@ class ApiV1 {
     getToken(sessionContext) {
         return sessionContext.session ? sessionContext.session.accessToken : sessionContext.token;
     }
-    async ping() {
-        return this.get("/ping");
-    }
     async whoami() {
         return this.get("/whoami");
     }
@@ -50,6 +47,7 @@ class ApiV1 {
     async listWorkflows({ flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"],
             ...(0, _page.toPageParams)(flags)
@@ -61,6 +59,7 @@ class ApiV1 {
     async getWorkflow({ args, flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"]
         });
@@ -71,6 +70,7 @@ class ApiV1 {
     async upsertWorkflow({ flags }, workflow) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             commit: flags.commit,
             commit_message: flags["commit-message"]
@@ -84,7 +84,8 @@ class ApiV1 {
     }
     async validateWorkflow({ flags }, workflow) {
         const params = (0, _objectisomorphic.prune)({
-            environment: flags.environment
+            environment: flags.environment,
+            branch: flags.branch
         });
         const data = {
             workflow
@@ -96,6 +97,7 @@ class ApiV1 {
     async activateWorkflow({ args, flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             status: flags.status
         });
         return this.put(`/workflows/${args.workflowKey}/activate`, {}, {
@@ -104,7 +106,8 @@ class ApiV1 {
     }
     async runWorkflow({ args, flags }) {
         const params = (0, _objectisomorphic.prune)({
-            environment: flags.environment
+            environment: flags.environment,
+            branch: flags.branch
         });
         const data = (0, _objectisomorphic.prune)({
             recipients: flags.recipients,
@@ -120,6 +123,7 @@ class ApiV1 {
     async listCommits({ flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             promoted: flags.promoted,
             resource_type: flags["resource-type"],
             resource_id: flags["resource-id"],
@@ -129,12 +133,10 @@ class ApiV1 {
             params
         });
     }
-    async getCommit({ args }) {
-        return this.get(`/commits/${args.id}`);
-    }
     async commitAllChanges({ flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             commit_message: flags["commit-message"]
         });
         return this.put(`/commits`, {}, {
@@ -156,6 +158,7 @@ class ApiV1 {
     async listTranslations({ flags }, filters = {}) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"],
             locale_code: filters.localeCode,
             namespace: filters.namespace,
@@ -169,6 +172,7 @@ class ApiV1 {
     async getTranslation({ flags }, translation) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"],
             namespace: translation.namespace,
             format: flags.format
@@ -180,6 +184,7 @@ class ApiV1 {
     async upsertTranslation({ flags }, translation) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             commit: flags.commit,
             commit_message: flags["commit-message"],
             namespace: translation.namespace
@@ -193,6 +198,7 @@ class ApiV1 {
     async validateTranslation({ flags }, translation) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             namespace: translation.namespace
         });
         const data = {
@@ -206,6 +212,7 @@ class ApiV1 {
     async listEmailLayouts({ flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"],
             ...(0, _page.toPageParams)(flags)
@@ -217,6 +224,7 @@ class ApiV1 {
     async getEmailLayout({ args, flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"]
         });
@@ -227,6 +235,7 @@ class ApiV1 {
     async upsertEmailLayout({ flags }, layout) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             commit: flags.commit,
             commit_message: flags["commit-message"]
@@ -240,7 +249,8 @@ class ApiV1 {
     }
     async validateEmailLayout({ flags }, layout) {
         const params = (0, _objectisomorphic.prune)({
-            environment: flags.environment
+            environment: flags.environment,
+            branch: flags.branch
         });
         const data = {
             email_layout: layout
@@ -253,6 +263,7 @@ class ApiV1 {
     async listPartials({ flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"],
             annotate: flags.annotate,
             ...(0, _page.toPageParams)(flags)
@@ -264,6 +275,7 @@ class ApiV1 {
     async getPartial({ args, flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"]
         });
@@ -274,6 +286,7 @@ class ApiV1 {
     async upsertPartial({ flags }, partial) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             commit: flags.commit,
             commit_message: flags["commit-message"]
@@ -287,7 +300,8 @@ class ApiV1 {
     }
     async validatePartial({ flags }, partial) {
         const params = (0, _objectisomorphic.prune)({
-            environment: flags.environment
+            environment: flags.environment,
+            branch: flags.branch
         });
         const data = {
             partial
@@ -300,6 +314,7 @@ class ApiV1 {
     async listMessageTypes({ flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"],
             annotate: flags.annotate,
             ...(0, _page.toPageParams)(flags)
@@ -311,6 +326,7 @@ class ApiV1 {
     async getMessageType({ args, flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"]
         });
@@ -321,6 +337,7 @@ class ApiV1 {
     async upsertMessageType({ flags }, messageType) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             commit: flags.commit,
             commit_message: flags["commit-message"]
@@ -334,7 +351,8 @@ class ApiV1 {
     }
     async validateMessageType({ flags }, messageType) {
         const params = (0, _objectisomorphic.prune)({
-            environment: flags.environment
+            environment: flags.environment,
+            branch: flags.branch
         });
         const data = {
             message_type: messageType
@@ -347,6 +365,7 @@ class ApiV1 {
     async listGuides({ flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"],
             include_json_schema: flags["include-json-schema"],
@@ -359,6 +378,7 @@ class ApiV1 {
     async getGuide({ args, flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             hide_uncommitted_changes: flags["hide-uncommitted-changes"]
         });
@@ -368,7 +388,8 @@ class ApiV1 {
     }
     async validateGuide({ flags }, guide) {
         const params = (0, _objectisomorphic.prune)({
-            environment: flags.environment
+            environment: flags.environment,
+            branch: flags.branch
         });
         const data = {
             guide
@@ -380,6 +401,7 @@ class ApiV1 {
     async upsertGuide({ flags }, guide) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             annotate: flags.annotate,
             commit: flags.commit,
             commit_message: flags["commit-message"]
@@ -394,6 +416,7 @@ class ApiV1 {
     async activateGuide({ args, flags }) {
         const params = (0, _objectisomorphic.prune)({
             environment: flags.environment,
+            branch: flags.branch,
             status: flags.status,
             from: flags.from,
             until: flags.until

package/dist/lib/helpers/arg.js

@@ -9,15 +9,16 @@ Object.defineProperty(exports, "CustomArgs", {
     }
 });
 const _core = require("@oclif/core");
-const slugArg = _core.Args.custom({
+const _string = require("./string");
+const slug = _core.Args.custom({
     parse: async (str)=>{
-        const slug = str.toLowerCase().trim().replace(/\s+/g, "-");
-        if (!slug) {
+        const slugifiedInput = (0, _string.slugify)(str);
+        if (!slugifiedInput) {
             throw new Error("Invalid slug provided");
         }
-        return slug;
+        return slugifiedInput;
     }
 });
 const CustomArgs = {
-    slugArg
+    slug
 };

package/dist/lib/helpers/branch.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get BRANCH_FILE_NAME () {
+        return BRANCH_FILE_NAME;
+    },
+    get appendBranchFileToGitIgnore () {
+        return appendBranchFileToGitIgnore;
+    },
+    get clearBranchFile () {
+        return clearBranchFile;
+    },
+    get findProjectRoot () {
+        return findProjectRoot;
+    },
+    get parseSlugFromBranchFile () {
+        return parseSlugFromBranchFile;
+    },
+    get readSlugFromBranchFile () {
+        return readSlugFromBranchFile;
+    },
+    get writeSlugToBranchFile () {
+        return writeSlugToBranchFile;
+    }
+});
+const _nodepath = /*#__PURE__*/ _interop_require_default(require("node:path"));
+const _findup = /*#__PURE__*/ _interop_require_default(require("find-up"));
+const _fsextra = /*#__PURE__*/ _interop_require_wildcard(require("fs-extra"));
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interop_require_wildcard(obj, nodeInterop) {
+    if (!nodeInterop && obj && obj.__esModule) {
+        return obj;
+    }
+    if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
+        return {
+            default: obj
+        };
+    }
+    var cache = _getRequireWildcardCache(nodeInterop);
+    if (cache && cache.has(obj)) {
+        return cache.get(obj);
+    }
+    var newObj = {
+        __proto__: null
+    };
+    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
+    for(var key in obj){
+        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
+            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
+            if (desc && (desc.get || desc.set)) {
+                Object.defineProperty(newObj, key, desc);
+            } else {
+                newObj[key] = obj[key];
+            }
+        }
+    }
+    newObj.default = obj;
+    if (cache) {
+        cache.set(obj, newObj);
+    }
+    return newObj;
+}
+const BRANCH_FILE_NAME = ".knockbranch";
+/**
+ * A comment written to the `.gitignore` file when it's updated.
+ */ const GITIGNORE_COMMENT = "# Knock CLI config files\n";
+const readSlugFromBranchFile = async ()=>{
+    const branchFilePath = await (0, _findup.default)(BRANCH_FILE_NAME);
+    const slug = branchFilePath ? await parseSlugFromBranchFile(branchFilePath) : undefined;
+    return slug;
+};
+const parseSlugFromBranchFile = async (branchFilePath)=>{
+    const input = (await _fsextra.readFile(branchFilePath, "utf-8")).trim();
+    return /^[\w-]+$/.test(input) ? input : undefined;
+};
+const clearBranchFile = async (branchFilePath)=>{
+    // The empty string indicates that no branch is currently active
+    await _fsextra.writeFile(branchFilePath, "");
+};
+const writeSlugToBranchFile = async (branchFilePath, branchSlug)=>{
+    await _fsextra.writeFile(branchFilePath, `${branchSlug}\n`);
+};
+const findProjectRoot = async ()=>{
+    const currDir = process.cwd();
+    const gitIgnoreFilePath = await (0, _findup.default)(async (directory)=>{
+        const filePath = _nodepath.default.join(directory, ".gitignore");
+        const gitIgnoreFileExists = await _fsextra.exists(filePath);
+        if (gitIgnoreFileExists) {
+            return filePath;
+        }
+        // Stop search when we find a .git directory
+        const gitDirExists = await _fsextra.exists(_nodepath.default.join(directory, ".git"));
+        if (gitDirExists) {
+            return _findup.default.stop;
+        }
+    }, {
+        cwd: currDir
+    });
+    return gitIgnoreFilePath ? _nodepath.default.dirname(gitIgnoreFilePath) : currDir;
+};
+const appendBranchFileToGitIgnore = async (gitIgnoreFilePath, addLeadingNewline = true)=>{
+    const appendedContent = (addLeadingNewline ? "\n" : "") + GITIGNORE_COMMENT + BRANCH_FILE_NAME + "\n";
+    await _fsextra.appendFile(gitIgnoreFilePath, appendedContent);
+};