Use constant for max description length for register command

zapier · Feb 14, 2023 · 3b57747 · 3b57747
1 parent 4610f36
commit 3b57747
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 10 deletions.
diff --git a/packages/cli/src/constants.js b/packages/cli/src/constants.js
@@ -57,6 +57,8 @@ const IS_TESTING =
   argvStr.includes('jest') ||
   (process.env.NODE_ENV || '').toLowerCase().startsWith('test');
 
+const MAX_DESCRIPTION_LENGTH = 140;
+
 module.exports = {
   ANALYTICS_KEY,
   ANALYTICS_MODES,
@@ -76,6 +78,7 @@ module.exports = {
   ISSUES_URL,
   LAMBDA_VERSION,
   LEGACY_RUNNER_PACKAGE,
+  MAX_DESCRIPTION_LENGTH,
   NODE_VERSION,
   NODE_VERSION_CLI_REQUIRES,
   PACKAGE_NAME,

diff --git a/packages/cli/src/oclif/commands/register.js b/packages/cli/src/oclif/commands/register.js
@@ -1,5 +1,5 @@
 const ZapierBaseCommand = require('../ZapierBaseCommand');
-const { CURRENT_APP_FILE } = require('../../constants');
+const { CURRENT_APP_FILE, MAX_DESCRIPTION_LENGTH } = require('../../constants');
 const { buildFlags } = require('../buildFlags');
 const { callAPI, writeLinkedAppConfig } = require('../../utils/api');
 
@@ -9,9 +9,12 @@ class RegisterCommand extends ZapierBaseCommand {
   async perform() {
     // Flag validation
     this._validateEnumFlags();
-    if ('desc' in this.flags && this.flags.desc.length >= 140) {
+    if (
+      'desc' in this.flags &&
+      this.flags.desc.length >= MAX_DESCRIPTION_LENGTH
+    ) {
       throw new Error(
-        'Please provide a description that is 140 characters or less.'
+        `Please provide a description that is ${MAX_DESCRIPTION_LENGTH} characters or less.`
       );
     }
 
@@ -75,8 +78,8 @@ class RegisterCommand extends ZapierBaseCommand {
     appMeta.description = this.flags.desc?.trim();
     if (!appMeta.description) {
       appMeta.description = await this.prompt(
-        'Please provide a sentence describing your app in 140 characters or less.',
-        { required: true, charLimit: 140 }
+        `Please provide a sentence describing your app in ${MAX_DESCRIPTION_LENGTH} characters or less.`,
+        { required: true, charLimit: MAX_DESCRIPTION_LENGTH }
       );
     }
 
@@ -150,8 +153,7 @@ RegisterCommand.flags = buildFlags({
   commandFlags: {
     desc: flags.string({
       char: 'D',
-      description:
-        'A sentence describing your app in 140 characters or less, e.g. "Trello is a team collaboration tool to organize tasks and keep projects on track."',
+      description: `A sentence describing your app in ${MAX_DESCRIPTION_LENGTH} characters or less, e.g. "Trello is a team collaboration tool to organize tasks and keep projects on track."`,
     }),
     url: flags.string({
       char: 'u',

diff --git a/packages/cli/src/tests/register.test.js b/packages/cli/src/tests/register.test.js
@@ -1,5 +1,5 @@
 const oclif = require('@oclif/test');
-const constants = require('../constants');
+const { BASE_ENDPOINT, MAX_DESCRIPTION_LENGTH } = require('../constants');
 const registerFieldChoices = require('./fixtures/registerFieldChoices');
 
 describe('RegisterCommand', () => {
@@ -14,15 +14,15 @@ describe('RegisterCommand', () => {
         oclif
           .expect(ctx.message)
           .to.contain(
-            'Please provide a description that is 140 characters or less.'
+            `Please provide a description that is ${MAX_DESCRIPTION_LENGTH} characters or less.`
           );
       })
       .it('zapier register should enforce character limit on desc flag');
   });
 
   describe('zapier register should validate enum fields that are passed in as flags', function () {
     function getTestObj() {
-      return oclif.test.nock(constants.BASE_ENDPOINT, (mockApi) =>
+      return oclif.test.nock(BASE_ENDPOINT, (mockApi) =>
         mockApi
           .get('/api/platform/cli/apps/fields-choices')
           .reply(200, registerFieldChoices)