@knocklabs/cli 0.1.0-rc.3 → 0.1.0-rc.4

package/README.md

@@ -16,7 +16,7 @@ $ npm install -g @knocklabs/cli
 $ knock COMMAND
 running command...
 $ knock (--version)
-@knocklabs/cli/0.1.0-rc.3 linux-x64 node-v16.4.2
+@knocklabs/cli/0.1.0-rc.4 linux-x64 node-v16.4.2
 $ knock --help [COMMAND]
 USAGE
   $ knock COMMAND
@@ -66,7 +66,7 @@ FLAGS
   --service-token=<value>       (required) The service token to authenticate with
 ```
 
-_See code: [dist/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.0-rc.3/dist/commands/commit/index.ts)_
+_See code: [dist/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.0-rc.4/dist/commands/commit/index.ts)_
 
 ## `knock commit promote`
 
@@ -118,7 +118,7 @@ EXAMPLES
   $ knock ping
 ```
 
-_See code: [dist/commands/ping.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.0-rc.3/dist/commands/ping.ts)_
+_See code: [dist/commands/ping.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.0-rc.4/dist/commands/ping.ts)_
 
 ## `knock plugins`
 
@@ -138,7 +138,7 @@ EXAMPLES
   $ knock plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.6/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/index.ts)_
 
 ## `knock plugins:install PLUGIN...`
 

package/dist/commands/translation/pull.js

@@ -76,7 +76,7 @@ class TranslationPull extends _baseCommand.default {
             exists: true
         };
         const targetDirCtx = flags["translations-dir"] || defaultToCwd;
-        const prompt = targetDirCtx.exists ? `Pull latest translations into ${targetDirCtx.abspath}?` : `Create a new translations directory at ${targetDirCtx.abspath}?`;
+        const prompt = targetDirCtx.exists ? `Pull latest translations into ${targetDirCtx.abspath}?\n  This will overwrite the contents of this directory.` : `Create a new translations directory at ${targetDirCtx.abspath}?`;
         const input = flags.force || await (0, _ux.promptToConfirm)(prompt);
         if (!input) return;
         // Fetch all translations then write them to the local file system.

package/dist/commands/workflow/pull.js

@@ -137,7 +137,7 @@ class WorkflowPull extends _baseCommand.default {
             exists: true
         };
         const targetDirCtx = flags["workflows-dir"] || defaultToCwd;
-        const prompt = targetDirCtx.exists ? `Pull latest workflows into ${targetDirCtx.abspath}?` : `Create a new workflows directory at ${targetDirCtx.abspath}?`;
+        const prompt = targetDirCtx.exists ? `Pull latest workflows into ${targetDirCtx.abspath}?\n  This will overwrite the contents of this directory.` : `Create a new workflows directory at ${targetDirCtx.abspath}?`;
         const input = flags.force || await (0, _ux.promptToConfirm)(prompt);
         if (!input) return;
         // Fetch all workflows then write them to the local file system.

package/dist/lib/marshal/translation/writer.js

@@ -58,7 +58,7 @@ const writeTranslationsIndexDir = async (indexDirCtx, translations)=>{
         // before wiping it clean.
         if (indexDirCtx.exists) {
             await _fsExtra.copy(indexDirCtx.abspath, backupDirPath);
-            await _fsExtra.remove(indexDirCtx.abspath);
+            await _fsExtra.emptyDir(indexDirCtx.abspath);
         }
         // Write given remote translations into the given translations directory path.
         const writeTranslationDirPromises = translations.map(async (translation)=>{
@@ -72,9 +72,11 @@ const writeTranslationsIndexDir = async (indexDirCtx, translations)=>{
     } catch (error) {
         // In case of any error, wipe the index directory that is likely in a bad
         // state then restore the backup if one existed before.
-        await _fsExtra.remove(indexDirCtx.abspath);
         if (indexDirCtx.exists) {
+            await _fsExtra.emptyDir(indexDirCtx.abspath);
             await _fsExtra.copy(backupDirPath, indexDirCtx.abspath);
+        } else {
+            await _fsExtra.remove(indexDirCtx.abspath);
         }
         throw error;
     } finally{

package/dist/lib/marshal/workflow/writer.js

@@ -14,6 +14,7 @@ _export(exports, {
     writeWorkflowsIndexDir: ()=>writeWorkflowsIndexDir,
     buildWorkflowDirBundle: ()=>buildWorkflowDirBundle,
     formatExtractedFilePath: ()=>formatExtractedFilePath,
+    pruneWorkflowsIndexDir: ()=>pruneWorkflowsIndexDir,
     toWorkflowJson: ()=>toWorkflowJson
 });
 const _nodePath = /*#__PURE__*/ _interopRequireWildcard(require("node:path"));
@@ -265,10 +266,12 @@ const writeWorkflowDirFromData = async (workflowDirCtx, remoteWorkflow)=>{
     return writeWorkflowDirFromBundle(workflowDirCtx, bundle);
 };
 const writeWorkflowDirFromBundle = async (workflowDirCtx, workflowDirBundle)=>{
+    const backupDirPath = _nodePath.resolve(_const.sandboxDir, (0, _lodash.uniqueId)("backup"));
     try {
-        // TODO(KNO-2794): Just back up the current workflow directory, wipe it,
-        // then write a new directory.
-        await _fsExtra.remove(workflowDirCtx.abspath);
+        if (workflowDirCtx.exists) {
+            await _fsExtra.copy(workflowDirCtx.abspath, backupDirPath);
+            await _fsExtra.emptyDir(workflowDirCtx.abspath);
+        }
         const promises = Object.entries(workflowDirBundle).map(([relpath, fileContent])=>{
             const filePath = _nodePath.resolve(workflowDirCtx.abspath, relpath);
             return relpath === _helpers.WORKFLOW_JSON ? _fsExtra.outputJson(filePath, fileContent, {
@@ -277,10 +280,43 @@ const writeWorkflowDirFromBundle = async (workflowDirCtx, workflowDirBundle)=>{
         });
         await Promise.all(promises);
     } catch (error) {
-        await _fsExtra.remove(workflowDirCtx.abspath);
+        // In case of any error, wipe the target directory that is likely in a bad
+        // state then restore the backup if one existed before.
+        if (workflowDirCtx.exists) {
+            await _fsExtra.emptyDir(workflowDirCtx.abspath);
+            await _fsExtra.copy(backupDirPath, workflowDirCtx.abspath);
+        } else {
+            await _fsExtra.remove(workflowDirCtx.abspath);
+        }
         throw error;
+    } finally{
+        // Always clean up the backup directory in the temp sandbox.
+        await _fsExtra.remove(backupDirPath);
     }
 };
+/*
+ * Prunes the index directory by removing any files, or directories that aren't
+ * workflow dirs found in fetched workflows. We want to preserve any workflow
+ * dirs that are going to be updated with remote workflows, so extracted links
+ * can be respected.
+ */ const pruneWorkflowsIndexDir = async (indexDirCtx, remoteWorkflows)=>{
+    const workflowsByKey = Object.fromEntries(remoteWorkflows.map((w)=>[
+            w.key.toLowerCase(),
+            w
+        ]));
+    const dirents = await _fsExtra.readdir(indexDirCtx.abspath, {
+        withFileTypes: true
+    });
+    const promises = dirents.map(async (dirent)=>{
+        const direntName = dirent.name.toLowerCase();
+        const direntPath = _nodePath.resolve(indexDirCtx.abspath, direntName);
+        if (await (0, _helpers.isWorkflowDir)(direntPath) && workflowsByKey[direntName]) {
+            return;
+        }
+        await _fsExtra.remove(direntPath);
+    });
+    await Promise.all(promises);
+};
 const writeWorkflowsIndexDir = async (indexDirCtx, remoteWorkflows)=>{
     const backupDirPath = _nodePath.resolve(_const.sandboxDir, (0, _lodash.uniqueId)("backup"));
     try {
@@ -288,9 +324,7 @@ const writeWorkflowsIndexDir = async (indexDirCtx, remoteWorkflows)=>{
         // before wiping it clean.
         if (indexDirCtx.exists) {
             await _fsExtra.copy(indexDirCtx.abspath, backupDirPath);
-            // TODO(KNO-2794): Only remove directories that aren't part of the remote
-            // workflows.
-            await _fsExtra.remove(indexDirCtx.abspath);
+            await pruneWorkflowsIndexDir(indexDirCtx, remoteWorkflows);
         }
         // Write given remote workflows into the given workflows directory path.
         const writeWorkflowDirPromises = remoteWorkflows.map(async (workflow)=>{
@@ -307,9 +341,11 @@ const writeWorkflowsIndexDir = async (indexDirCtx, remoteWorkflows)=>{
     } catch (error) {
         // In case of any error, wipe the index directory that is likely in a bad
         // state then restore the backup if one existed before.
-        await _fsExtra.remove(indexDirCtx.abspath);
         if (indexDirCtx.exists) {
+            await _fsExtra.emptyDir(indexDirCtx.abspath);
             await _fsExtra.copy(backupDirPath, indexDirCtx.abspath);
+        } else {
+            await _fsExtra.remove(indexDirCtx.abspath);
         }
         throw error;
     } finally{

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.0-rc.3",
+  "version": "0.1.0-rc.4",
   "commands": {
     "ping": {
       "id": "ping",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/cli",
-  "version": "0.1.0-rc.3",
+  "version": "0.1.0-rc.4",
   "description": "Knock CLI",
   "author": "@knocklabs",
   "bin": {
@@ -19,13 +19,13 @@
   "dependencies": {
     "@oclif/core": "^1.26.2",
     "@oclif/plugin-help": "^5",
-    "@oclif/plugin-plugins": "^2.4.6",
+    "@oclif/plugin-plugins": "^2.4.7",
     "@prantlf/jsonlint": "^11.7.2",
-    "axios": "^1.3.5",
+    "axios": "^1.4.0",
     "date-fns": "^2.29.3",
     "enquirer": "^2.3.6",
     "fs-extra": "^10.1.0",
-    "liquidjs": "^10.7.0",
+    "liquidjs": "^10.7.1",
     "locale-codes": "^1.3.1",
     "lodash": "^4.17.21",
     "yup": "^0.32.11"