feat(cli): on update process add flag to opt-out from publishing (#415)

* feat(CLI): on update process add flag to opt-out from publishing * feat(CLI): comment * feat(CLI): update help comment * Update packages/cli/src/main.ts Co-authored-by: Demetrius Feijóo <[email protected]> * feat(CLI): remove --publish * feat(CLI): test fix * feat(CLI): test regrouping + --no-publish test --------- Co-authored-by: Demetrius Feijóo <[email protected]>
storyblok · Oct 3, 2024 · a90d0b5 · a90d0b5
1 parent da3abc4
commit a90d0b5
Show file tree

Hide file tree

Showing 4 changed files with 100 additions and 42 deletions.
diff --git a/packages/cli/src/__tests__/main.test.ts b/packages/cli/src/__tests__/main.test.ts
@@ -1,34 +1,53 @@
 import { createCLI } from '../main'
 import { create, add, deploy } from '../commands'
-import { vi } from 'vitest'
+import { describe, vi } from 'vitest'
 
 vi.mock('../commands')
 
 const DEFAULT_ARGS = ['node', 'main.ts'] // cli.parse() should receive the executable and its arget as its first two arguments.
 
 describe('main', () => {
-  describe('default arguments', () => {
-    it('create command', () => {
-      const cli = createCLI()
-      cli.parse([...DEFAULT_ARGS, 'create'])
-      expect(create).toHaveBeenCalledWith({ dir: '.' })
-    })
-
-    it('add command', () => {
+  describe('add command', () => {
+    it('default arguments', () => {
       const cli = createCLI()
       cli.parse([...DEFAULT_ARGS, 'add'])
       expect(add).toHaveBeenCalledWith({ dir: '.' })
     })
 
-    it('deploy command', () => {
+    it('full arguments', () => {
       const cli = createCLI()
-      cli.parse([...DEFAULT_ARGS, 'deploy'])
-      expect(deploy).toHaveBeenCalledWith({ dir: '.', skipPrompts: false })
+      cli.parse([
+        ...DEFAULT_ARGS,
+        'add',
+        '--template',
+        'react',
+        '--name',
+        'my-test-plugin',
+        '--dir',
+        'my-directory',
+        '--structure',
+        'standalone',
+        '--packageManager',
+        'npm',
+      ])
+      expect(add).toHaveBeenCalledWith({
+        template: 'react',
+        name: 'my-test-plugin',
+        dir: 'my-directory',
+        structure: 'standalone',
+        packageManager: 'npm',
+      })
     })
   })
 
-  describe('full arguments', () => {
-    it('create command', () => {
+  describe('create command', () => {
+    it('default arguments', () => {
+      const cli = createCLI()
+      cli.parse([...DEFAULT_ARGS, 'create'])
+      expect(create).toHaveBeenCalledWith({ dir: '.' })
+    })
+
+    it('full arguments', () => {
       const cli = createCLI()
       cli.parse([
         ...DEFAULT_ARGS,
@@ -49,33 +68,30 @@ describe('main', () => {
         repoName: 'my-test-repo',
       })
     })
+  })
 
-    it('add command', () => {
+  describe('deploy command', () => {
+    it('--no-publish', () => {
       const cli = createCLI()
-      cli.parse([
-        ...DEFAULT_ARGS,
-        'add',
-        '--template',
-        'react',
-        '--name',
-        'my-test-plugin',
-        '--dir',
-        'my-directory',
-        '--structure',
-        'standalone',
-        '--packageManager',
-        'npm',
-      ])
-      expect(add).toHaveBeenCalledWith({
-        template: 'react',
-        name: 'my-test-plugin',
-        dir: 'my-directory',
-        structure: 'standalone',
-        packageManager: 'npm',
+      cli.parse([...DEFAULT_ARGS, 'deploy', '--no-publish'])
+      expect(deploy).toHaveBeenCalledWith({
+        dir: '.',
+        publish: false,
+        skipPrompts: false,
+      })
+    })
+
+    it('default options', () => {
+      const cli = createCLI()
+      cli.parse([...DEFAULT_ARGS, 'deploy'])
+      expect(deploy).toHaveBeenCalledWith({
+        dir: '.',
+        skipPrompts: false,
+        publish: true,
       })
     })
 
-    it('deploy command', () => {
+    it('full arguments', () => {
       const cli = createCLI()
       cli.parse([
         ...DEFAULT_ARGS,
@@ -100,6 +116,7 @@ describe('main', () => {
         name: 'my-test-plugin',
         output: './dist/index.js',
         dir: 'my-directory',
+        publish: true,
         dotEnvPath: '.',
         scope: 'my-plugins',
       })

diff --git a/packages/cli/src/commands/deploy/helper.ts b/packages/cli/src/commands/deploy/helper.ts
@@ -26,12 +26,13 @@ const packageNameMessage =
   'How would you like to call the deployed field-plugin?\n  (Lowercase alphanumeric and dash are allowed.)'
 
 type UpsertFieldPluginFunc = (args: {
+  scope: Scope
+  token: string
   dir: string
   packageName: string
-  skipPrompts?: boolean
-  token: string
   output: string
-  scope: Scope
+  skipPrompts: undefined | boolean
+  publish: boolean
 }) => Promise<{ id: number }>
 
 type GetPackageName = (params: {
@@ -42,7 +43,7 @@ type GetPackageName = (params: {
 
 // TODO: move all side effects to the deploy function
 export const upsertFieldPlugin: UpsertFieldPluginFunc = async (args) => {
-  const { packageName, skipPrompts, token, output, dir, scope } = args
+  const { packageName, skipPrompts, token, output, dir, scope, publish } = args
 
   const manifest = loadManifest()
 
@@ -78,9 +79,11 @@ export const upsertFieldPlugin: UpsertFieldPluginFunc = async (args) => {
       await confirmOptionsUpdate(manifest?.options)
     }
 
+    const shouldPublish = await checkPublish({ publish, skipPrompts })
+
     await storyblokClient.updateFieldType({
       id: fieldPluginFound.id,
-      publish: true,
+      publish: shouldPublish,
       field_type: {
         body: output,
         options: manifest?.options,
@@ -378,6 +381,7 @@ export const createFieldPlugin = async (
     //we need to force an update call right after the creation.
     //If no options is found, it's not going to be sent to the API since undefined
     //properties are not encoded.
+    //NOTE: The `publish` property is set to true here because it is a part of the creation process and should provide a consistent flow.
     await client.updateFieldType({
       id: fieldPlugin.id,
       publish: true,
@@ -414,3 +418,33 @@ export const createFieldPlugin = async (
     )
   }
 }
+
+// Publish Logic
+
+type CheckPublish = (params: {
+  publish: boolean
+  skipPrompts: undefined | boolean
+}) => Promise<boolean>
+
+export const checkPublish: CheckPublish = async ({ publish, skipPrompts }) => {
+  if (skipPrompts === true || publish === false) {
+    return publish
+  }
+
+  //NOTE: In interactive mode where --no-publish is not provided, the user is asked to confirm the publish action.
+  const publishConfirmation = await confirmPublish()
+  return publishConfirmation
+}
+
+const confirmPublish = async (): Promise<boolean> => {
+  const { publish } = await betterPrompts<{
+    publish: boolean
+  }>({
+    type: 'confirm',
+    name: 'publish',
+    message: 'Do you want to publish a new version of the field plugin?',
+    initial: false,
+  })
+
+  return publish
+}
diff --git a/packages/cli/src/commands/deploy/index.ts b/packages/cli/src/commands/deploy/index.ts
@@ -15,6 +15,7 @@ import { Scope } from '../../storyblok/storyblok-client'
 export type DeployArgs = {
   skipPrompts: boolean
   dir: string
+  publish: boolean
   name: undefined | string
   token: undefined | string
   output: undefined | string
@@ -25,7 +26,8 @@ export type DeployArgs = {
 type DeployFunc = (args: DeployArgs) => Promise<void>
 
 export const deploy: DeployFunc = async (params) => {
-  const { skipPrompts, token, name, dir, output, dotEnvPath, scope } = params
+  const { skipPrompts, token, name, dir, output, publish, dotEnvPath, scope } =
+    params
 
   console.log(bold(cyan('\nWelcome!')))
   console.log("Let's deploy a field-plugin.\n")
@@ -106,6 +108,7 @@ export const deploy: DeployFunc = async (params) => {
     token: personalAccessTokenResult.token,
     output: outputFile,
     scope: apiScope,
+    publish,
   })
 
   console.log(

diff --git a/packages/cli/src/main.ts b/packages/cli/src/main.ts
@@ -60,6 +60,10 @@ export const createCLI = () => {
       '--name <value>',
       'name of plugin (Lowercase alphanumeric and dash)',
     )
+    .option(
+      '--no-publish',
+      'This flag is only applied when a plugin is being updated! Uploads field plugin but does not publish a new version.',
+    )
     .addOption(
       new Option(
         '--output <value>',