@knocklabs/cli 0.3.1 → 1.0.0-rc.1

package/dist/commands/partial/new.js

@@ -0,0 +1,274 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return PartialNew;
+    }
+});
+const _nodepath = /*#__PURE__*/ _interop_require_wildcard(require("node:path"));
+const _core = require("@oclif/core");
+const _enquirer = require("enquirer");
+const _basecommand = /*#__PURE__*/ _interop_require_default(require("../../lib/base-command"));
+const _const = require("../../lib/helpers/const");
+const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
+const _projectconfig = require("../../lib/helpers/project-config");
+const _string = require("../../lib/helpers/string");
+const _ux = require("../../lib/helpers/ux");
+const _partial = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/marshal/partial"));
+const _runcontext = require("../../lib/run-context");
+const _push = /*#__PURE__*/ _interop_require_default(require("./push"));
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+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 PARTIAL_TYPE_CHOICES = [
+    {
+        name: _partial.PartialType.Html,
+        message: "HTML"
+    },
+    {
+        name: _partial.PartialType.Json,
+        message: "JSON"
+    },
+    {
+        name: _partial.PartialType.Markdown,
+        message: "Markdown"
+    },
+    {
+        name: _partial.PartialType.Text,
+        message: "Text"
+    }
+];
+class PartialNew extends _basecommand.default {
+    async run() {
+        const { flags } = this.props;
+        const { resourceDir } = this.runContext;
+        // 1. Ensure we aren't in any existing resource directory already.
+        if (resourceDir) {
+            return this.error(`Cannot create a new partial inside an existing ${resourceDir.type} directory`);
+        }
+        // 2. Prompt for name and key if not provided
+        let name = flags.name;
+        let key = flags.key;
+        if (!name) {
+            const nameResponse = await (0, _enquirer.prompt)({
+                type: "input",
+                name: "name",
+                message: "Partial name",
+                validate: (value)=>{
+                    if (!value || value.trim().length === 0) {
+                        return "Partial name is required";
+                    }
+                    return true;
+                }
+            });
+            name = nameResponse.name;
+        }
+        if (!key) {
+            const keyResponse = await (0, _enquirer.prompt)({
+                type: "input",
+                name: "key",
+                message: "Partial key (immutable slug)",
+                initial: (0, _string.slugify)(name),
+                validate: (value)=>{
+                    if (!value || value.trim().length === 0) {
+                        return "Partial key is required";
+                    }
+                    const keyError = _partial.validatePartialKey(value);
+                    if (keyError) {
+                        return `Invalid partial key: ${keyError}`;
+                    }
+                    return true;
+                }
+            });
+            key = keyResponse.key;
+        }
+        // Validate the partial key
+        const partialKeyError = _partial.validatePartialKey(key);
+        if (partialKeyError) {
+            return this.error(`Invalid partial key \`${key}\` (${partialKeyError})`);
+        }
+        const partialDirCtx = await this.getPartialDirContext(key);
+        const promptMessage = partialDirCtx.exists ? `Found \`${partialDirCtx.key}\` at ${partialDirCtx.abspath}, overwrite?` : `Create a new partial directory \`${partialDirCtx.key}\` at ${partialDirCtx.abspath}?`;
+        // Check if the partial directory already exists, and prompt to confirm if not.
+        const input = flags.force || await (0, _ux.promptToConfirm)(promptMessage);
+        if (!input) return;
+        // Generate the partial either from a template or from scratch
+        await (flags.template ? this.fromTemplate(partialDirCtx, name, flags.template) : this.fromType(partialDirCtx, name, flags.type));
+        if (flags.push) {
+            _ux.spinner.start("‣ Pushing partial to Knock");
+            try {
+                await _push.default.run([
+                    key
+                ]);
+            } catch (error) {
+                this.error(`Failed to push partial to Knock: ${error}`);
+            } finally{
+                _ux.spinner.stop();
+            }
+        }
+        this.log(`‣ Successfully created partial \`${key}\``);
+    }
+    async fromTemplate(partialDirCtx, name, templateString) {
+        // When being called from the template string, we want to try and generate
+        // the partial from the provided template.
+        _ux.spinner.start(`‣ Generating partial from template \`${templateString}\``);
+        try {
+            await _partial.generatePartialFromTemplate(partialDirCtx, templateString, {
+                name
+            });
+        } catch (error) {
+            this.error(`Failed to generate partial from template: ${error}`);
+        } finally{
+            _ux.spinner.stop();
+        }
+        _ux.spinner.stop();
+    }
+    async fromType(partialDirCtx, name, type) {
+        let partialType;
+        if (type) {
+            partialType = type;
+        } else {
+            // Prompt for type with select
+            const typeResponse = await (0, _enquirer.prompt)({
+                type: "select",
+                name: "type",
+                message: "Select partial type",
+                choices: PARTIAL_TYPE_CHOICES.map((choice)=>({
+                        name: choice.name,
+                        message: choice.message
+                    }))
+            });
+            partialType = typeResponse.type;
+        }
+        // Generate the partial directory with scaffolded content
+        await _partial.generatePartialDir(partialDirCtx, {
+            name,
+            type: partialType
+        });
+    }
+    async getPartialDirContext(partialKey) {
+        const { resourceDir, cwd: runCwd } = this.runContext;
+        // Inside an existing resource dir, use it if valid for the target partial.
+        if (resourceDir) {
+            const target = {
+                commandId: _basecommand.default.id,
+                type: "partial",
+                key: partialKey
+            };
+            return (0, _runcontext.ensureResourceDirForTarget)(resourceDir, target);
+        }
+        // Default to knock project config first if present, otherwise cwd.
+        const dirCtx = await (0, _projectconfig.resolveResourceDir)(this.projectConfig, "partial", runCwd);
+        // Not inside any existing partial directory, which means either create a
+        // new partial directory in the cwd, or update it if there is one already.
+        if (partialKey) {
+            const dirPath = _nodepath.resolve(dirCtx.abspath, partialKey);
+            const exists = await _partial.isPartialDir(dirPath);
+            return {
+                type: "partial",
+                key: partialKey,
+                abspath: dirPath,
+                exists
+            };
+        }
+        // Not in any partial directory, nor a partial key arg was given so error.
+        return this.error("Missing 1 required arg:\npartialKey");
+    }
+}
+_define_property(PartialNew, "summary", "Create a new partial with a minimal configuration.");
+_define_property(PartialNew, "flags", {
+    name: _core.Flags.string({
+        summary: "The name of the partial",
+        char: "n"
+    }),
+    key: _core.Flags.string({
+        summary: "The key of the partial",
+        char: "k"
+    }),
+    type: _core.Flags.string({
+        summary: "The type of the partial (html, json, markdown, text). You cannot use this flag with --template.",
+        char: "t",
+        options: [
+            _partial.PartialType.Html,
+            _partial.PartialType.Json,
+            _partial.PartialType.Markdown,
+            _partial.PartialType.Text
+        ]
+    }),
+    environment: _core.Flags.string({
+        summary: "The environment to create the partial in. Defaults to development.",
+        default: _const.KnockEnv.Development
+    }),
+    branch: _flag.branch,
+    force: _core.Flags.boolean({
+        summary: "Force the creation of the partial directory without confirmation."
+    }),
+    push: _core.Flags.boolean({
+        summary: "Whether or not to push the partial to Knock after creation.",
+        default: false,
+        char: "p"
+    }),
+    template: _core.Flags.string({
+        summary: "The template to use for the partial. Should be `partials/{key}`. You cannot use this flag with --type."
+    })
+});
+_define_property(PartialNew, "args", {});

package/dist/commands/partial/pull.js

@@ -16,6 +16,7 @@ const _error = require("../../lib/helpers/error");
 const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/helpers/flag"));
 const _objectisomorphic = require("../../lib/helpers/object.isomorphic");
 const _page = require("../../lib/helpers/page");
+const _projectconfig = require("../../lib/helpers/project-config");
 const _request = require("../../lib/helpers/request");
 const _ux = require("../../lib/helpers/ux");
 const _partial = /*#__PURE__*/ _interop_require_wildcard(require("../../lib/marshal/partial"));
@@ -119,11 +120,8 @@ class PartialPull extends _basecommand.default {
     // Pull all partials
     async pullAllPartials() {
         const { flags } = this.props;
-        const defaultToCwd = {
-            abspath: this.runContext.cwd,
-            exists: true
-        };
-        const targetDirCtx = flags["partials-dir"] || defaultToCwd;
+        const partialsIndexDirCtx = await (0, _projectconfig.resolveResourceDir)(this.projectConfig, "partial", this.runContext.cwd);
+        const targetDirCtx = flags["partials-dir"] || partialsIndexDirCtx;
         const prompt = targetDirCtx.exists ? `Pull latest partials into ${targetDirCtx.abspath}?\n  This will overwrite the contents of this directory.` : `Create a new partials directory at ${targetDirCtx.abspath}?`;
         const input = flags.force || await (0, _ux.promptToConfirm)(prompt);
         if (!input) return;
@@ -171,10 +169,11 @@ class PartialPull extends _basecommand.default {
             };
             return (0, _runcontext.ensureResourceDirForTarget)(resourceDir, target);
         }
+        const partialsIndexDirCtx = await (0, _projectconfig.resolveResourceDir)(this.projectConfig, "partial", runCwd);
         // Not inside any existing partial directory, which means either create a
         // new partial directory in the cwd, or update it if there is one already.
         if (partialKey) {
-            const dirPath = _nodepath.resolve(runCwd, partialKey);
+            const dirPath = _nodepath.resolve(partialsIndexDirCtx.abspath, partialKey);
             const exists = await _partial.isPartialDir(dirPath);
             return {
                 type: "partial",

package/dist/commands/partial/push.js

@@ -83,7 +83,7 @@ class PartialPush extends _basecommand.default {
     async run() {
         const { flags } = this.props;
         // 1. First read all partial directories found for the given command.
-        const target = await _partial.ensureValidCommandTarget(this.props, this.runContext);
+        const target = await _partial.ensureValidCommandTarget(this.props, this.runContext, this.projectConfig);
         const [partials, readErrors] = await _partial.readAllForCommandTarget(target, {
             withExtractedFiles: true
         });

package/dist/commands/partial/validate.js

@@ -80,7 +80,7 @@ function _interop_require_wildcard(obj, nodeInterop) {
 class PartialValidate extends _basecommand.default {
     async run() {
         // 1. Read all partial directories found for the given command.
-        const target = await _partial.ensureValidCommandTarget(this.props, this.runContext);
+        const target = await _partial.ensureValidCommandTarget(this.props, this.runContext, this.projectConfig);
         const [partials, readErrors] = await _partial.readAllForCommandTarget(target, {
             withExtractedFiles: true
         });

package/dist/commands/pull.js

@@ -12,6 +12,7 @@ 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 _flag = /*#__PURE__*/ _interop_require_wildcard(require("../lib/helpers/flag"));
+const _projectconfig = require("../lib/helpers/project-config");
 const _ux = require("../lib/helpers/ux");
 const _resources = require("../lib/resources");
 const _pull = /*#__PURE__*/ _interop_require_default(require("./guide/pull"));
@@ -82,7 +83,11 @@ function _interop_require_wildcard(obj, nodeInterop) {
 class Pull extends _basecommand.default {
     async run() {
         const { flags } = this.props;
-        const targetDirCtx = flags["knock-dir"];
+        // Resolve knock directory: flag takes precedence, otherwise use knock.json
+        const targetDirCtx = await (0, _projectconfig.resolveKnockDir)(flags["knock-dir"], this.projectConfig);
+        if (!targetDirCtx) {
+            this.error("No knock directory specified. Either provide --knock-dir flag or run `knock init` to create a knock.json configuration file.");
+        }
         const prompt = targetDirCtx.exists ? `Pull latest resources into ${targetDirCtx.abspath}?\n  This will overwrite the contents of this directory.` : `Create a new resources directory at ${targetDirCtx.abspath}?`;
         const input = flags.force || await (0, _ux.promptToConfirm)(prompt);
         if (!input) return;
@@ -123,7 +128,7 @@ _define_property(Pull, "flags", {
     branch: _flag.branch,
     "knock-dir": _flag.dirPath({
         summary: "The target directory path to pull all resources into.",
-        required: true
+        required: false
     }),
     "hide-uncommitted-changes": _core.Flags.boolean({
         summary: "Hide any uncommitted changes."

package/dist/commands/push.js

@@ -14,6 +14,7 @@ const _fsextra = /*#__PURE__*/ _interop_require_wildcard(require("fs-extra"));
 const _basecommand = /*#__PURE__*/ _interop_require_default(require("../lib/base-command"));
 const _const = require("../lib/helpers/const");
 const _flag = /*#__PURE__*/ _interop_require_wildcard(require("../lib/helpers/flag"));
+const _projectconfig = require("../lib/helpers/project-config");
 const _resources = require("../lib/resources");
 const _push = /*#__PURE__*/ _interop_require_default(require("./guide/push"));
 const _push1 = /*#__PURE__*/ _interop_require_default(require("./layout/push"));
@@ -83,9 +84,10 @@ function _interop_require_wildcard(obj, nodeInterop) {
 class Push extends _basecommand.default {
     async run() {
         const { flags } = this.props;
-        const targetDirCtx = flags["knock-dir"];
-        if (!targetDirCtx.exists) {
-            this.error(`Directory ${targetDirCtx.abspath} does not exist`);
+        // Resolve knock directory: flag takes precedence, otherwise use knock.json
+        const targetDirCtx = await (0, _projectconfig.resolveKnockDir)(flags["knock-dir"], this.projectConfig);
+        if (!targetDirCtx) {
+            this.error("No knock directory specified. Either provide --knock-dir flag or run `knock init` to create a knock.json configuration file.");
         }
         const args = [
             "--all",
@@ -133,7 +135,7 @@ _define_property(Push, "flags", {
     branch: _flag.branch,
     "knock-dir": _flag.dirPath({
         summary: "The target directory path to find all resources to push.",
-        required: true
+        required: false
     }),
     commit: _core.Flags.boolean({
         summary: "Push and commit the resource(s) at the same time"

package/dist/commands/translation/pull.js

@@ -79,7 +79,7 @@ function _interop_require_wildcard(obj, nodeInterop) {
 }
 class TranslationPull extends _basecommand.default {
     async run() {
-        const target = await _translation.ensureValidCommandTarget(this.props, this.runContext);
+        const target = await _translation.ensureValidCommandTarget(this.props, this.runContext, this.projectConfig);
         switch(target.type){
             case "translationFile":
                 return this.pullOneTranslation(target.context);

package/dist/commands/translation/push.js

@@ -82,7 +82,7 @@ class TranslationPush extends _basecommand.default {
     async run() {
         const { flags } = this.props;
         // 1. First read all translation files found for the given command.
-        const target = await _translation.ensureValidCommandTarget(this.props, this.runContext);
+        const target = await _translation.ensureValidCommandTarget(this.props, this.runContext, this.projectConfig);
         const [translations, readErrors] = await _translation.readAllForCommandTarget(target);
         if (readErrors.length > 0) {
             this.error((0, _error.formatErrors)(readErrors, {

package/dist/commands/translation/validate.js

@@ -79,7 +79,7 @@ function _interop_require_wildcard(obj, nodeInterop) {
 }
 class TranslationValidate extends _basecommand.default {
     async run() {
-        const target = await _translation.ensureValidCommandTarget(this.props, this.runContext);
+        const target = await _translation.ensureValidCommandTarget(this.props, this.runContext, this.projectConfig);
         const [translations, readErrors] = await _translation.readAllForCommandTarget(target);
         if (readErrors.length > 0) {
             this.error((0, _error.formatErrors)(readErrors, {