@hubspot/cli 6.2.2-experimental.0 → 6.3.0

package/LICENSE

@@ -0,0 +1,12 @@
+Copyright 2019  HubSpot, Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,71 @@
+# @hubspot/cli
+
+[![Official Release](https://img.shields.io/npm/v/@hubspot/cli/latest?label=Official%20Release)](https://www.npmjs.com/package/@hubspot/cli) [![Latest Version](https://img.shields.io/github/v/tag/hubspot/hubspot-cli?label=Latest%20Version)](https://www.npmjs.com/package/@hubspot/cli?activeTab=versions)
+
+A CLI for HubSpot developers to enable local development and automation. [Learn more about building on HubSpot](https://developers.hubspot.com).
+
+## Contributing
+
+For more information on developing, see the [Contributing Guide](CONTRIBUTING.md).
+
+## Getting started
+
+For more information on using these tools, see [Local Development Tooling: Getting Started](https://developers.hubspot.com/docs/cms/guides/getting-started-with-local-development)
+
+### Installation
+
+```bash
+npm install -g @hubspot/cli
+```
+
+### Configuring
+
+Once the `@hubspot/cli` has been added to a project, a config file named [hubspot.config.yml](../../docs/HubspotConfigFile.md) will also be needed. It is recommended that the config file is kept in your `$HOME` directory.
+
+```bash
+cd ~
+hs init
+```
+
+#### Auto Completion
+
+You can set up command autocompletion by running
+
+```bash
+hs completion
+```
+
+and copying the output to either your `.bashrc` or `.zshrc`, and then sourcing that file `source ~/.bashrc` `source ~/.zshrc` or restarting your terminal.
+
+## Commands
+
+A full breakdown of the commands can be found on the [local development tools reference page](https://developers.hubspot.com/docs/cms/developer-reference/local-development-cli).
+
+**Note:** When `@hubspot/cli` is installed local to a project, the commands need to be prefixed with either `yarn` if using `yarn` or `npx` if using `npm`.
+
+## Authentication
+
+There are two ways that the tools can authenticate with HubSpot.
+
+### Personal Access Key (recommended)
+
+1. Run `hs init` or `hs auth personalaccesskey` and follow the instructions
+
+### OAuth2
+
+1. [Create a developer app](https://developers.hubspot.com/docs/faq/how-do-i-create-an-app-in-hubspot)
+2. Run `hs auth oauth2`
+3. Select `OAuth2` and follow the steps
+
+_**Note:** The Account ID used should be the Test Account ID (not the developer app ID). Client ID and Client Secret are from the developer app._
+### Exit Codes
+
+The CLI will exit with one of the following exit codes:
+- `0`: A successful run
+- `1`: There was a config problem or an internal error
+- `2`: There are warnings or validation issues
+
+
+## Changelog
+
+The best way to stay up to date is to check out the [Github Releases](https://github.com/HubSpot/hubspot-cli/releases) and also follow our [developer changelog posts](https://developers.hubspot.com/changelog) for an easier to read breakdown of major changes.

package/commands/accounts/clean.d.ts

@@ -1,4 +1 @@
-export const command: "clean";
-export const describe: any;
-export function handler(options: any): Promise<never>;
-export function builder(yargs: any): any;
+export {};

package/commands/accounts/clean.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { accessTokenForPersonalAccessKey, } = require('@hubspot/local-dev-lib/personalAccessKey');
 const { trackCommandUsage } = require('../../lib/usageTracking');

package/commands/accounts/info.d.ts

@@ -1,4 +1 @@
-export const describe: any;
-export const command: "info [--account]";
-export function handler(options: any): Promise<void>;
-export function builder(yargs: any): any;
+export {};

package/commands/accounts/info.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { getAccountConfig } = require('@hubspot/local-dev-lib/config');
 const { getAccessToken } = require('@hubspot/local-dev-lib/personalAccessKey');
@@ -11,7 +13,7 @@ exports.describe = i18n(`${i18nKey}.describe`);
 exports.command = 'info [--account]';
 exports.handler = async (options) => {
     await loadAndValidateOptions(options);
-    let accountId = getAccountId(options);
+    const accountId = getAccountId(options);
     const config = getAccountConfig(accountId);
     // check if the provided account is using a personal access key, if not, show an error
     if (config.authType === 'personalaccesskey') {

package/commands/accounts/list.d.ts

@@ -1,4 +1 @@
-export const command: "list";
-export const describe: any;
-export function handler(options: any): Promise<void>;
-export function builder(yargs: any): any;
+export {};

package/commands/accounts/list.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { getConfig, getConfigPath } = require('@hubspot/local-dev-lib/config');
 const { getTableContents, getTableHeader } = require('../../lib/ui/table');

package/commands/accounts/remove.d.ts

@@ -1,4 +1 @@
-export const command: "remove [--account]";
-export const describe: any;
-export function handler(options: any): Promise<void>;
-export function builder(yargs: any): any;
+export {};

package/commands/accounts/remove.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { getConfig, getConfigPath, deleteAccount, getConfigDefaultAccount, getAccountId: getAccountIdFromConfig, updateDefaultAccount, } = require('@hubspot/local-dev-lib/config');
 const { trackCommandUsage } = require('../../lib/usageTracking');

package/commands/accounts/rename.d.ts

@@ -1,4 +1 @@
-export const command: "rename <accountName> <newName>";
-export const describe: any;
-export function handler(options: any): Promise<void>;
-export function builder(yargs: any): any;
+export {};

package/commands/accounts/rename.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { renameAccount } = require('@hubspot/local-dev-lib/config');
 const { addConfigOptions, addAccountOptions, getAccountId, } = require('../../lib/commonOpts');

package/commands/accounts/use.d.ts

@@ -1,4 +1 @@
-export const command: "use [--account]";
-export const describe: any;
-export function handler(options: any): Promise<void>;
-export function builder(yargs: any): any;
+export {};

package/commands/accounts/use.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { getConfig, getConfigPath, updateDefaultAccount, getAccountId: getAccountIdFromConfig, } = require('@hubspot/local-dev-lib/config');
 const { trackCommandUsage } = require('../../lib/usageTracking');

package/commands/accounts.d.ts

@@ -1,3 +1 @@
-export const command: "accounts";
-export const describe: any;
-export function builder(yargs: any): any;
+export {};

package/commands/accounts.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { addConfigOptions, addAccountOptions } = require('../lib/commonOpts');
 const { i18n } = require('../lib/lang');
 const list = require('./accounts/list');

package/commands/auth.d.ts

@@ -1,4 +1 @@
-export const command: "auth [type] [--account]";
-export const describe: any;
-export function handler(options: any): Promise<never>;
-export function builder(yargs: any): any;
+export {};

package/commands/auth.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { checkAndWarnGitInclusion } = require('../lib/ui/git');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { OAUTH_AUTH_METHOD, PERSONAL_ACCESS_KEY_AUTH_METHOD, } = require('@hubspot/local-dev-lib/constants/auth');
@@ -13,7 +15,6 @@ const { personalAccessKeyPrompt, OAUTH_FLOW, } = require('../lib/prompts/persona
 const { cliAccountNamePrompt } = require('../lib/prompts/accountNamePrompt');
 const { setAsDefaultAccountPrompt, } = require('../lib/prompts/setAsDefaultAccountPrompt');
 const { addConfigOptions, setLogLevel, getAccountId, addTestingOptions, } = require('../lib/commonOpts');
-const { logDebugInfo } = require('../lib/debugInfo');
 const { trackAuthAction, trackCommandUsage } = require('../lib/usageTracking');
 const { authenticateWithOauth } = require('../lib/oauth');
 const { EXIT_CODES } = require('../lib/enums/exitCodes');
@@ -38,7 +39,6 @@ exports.handler = async (options) => {
     const { type, config: c, qa, account } = options;
     const authType = (type && type.toLowerCase()) || PERSONAL_ACCESS_KEY_AUTH_METHOD.value;
     setLogLevel(options);
-    logDebugInfo(options);
     if (!getConfigPath(c)) {
         logger.error(i18n(`${i18nKey}.errors.noConfigFileFound`));
         process.exit(EXIT_CODES.ERROR);

package/commands/cms/convertFields.d.ts

@@ -1,4 +1 @@
-export const command: "convert-fields";
-export const describe: any;
-export function handler(options: any): Promise<void>;
-export function builder(yargs: any): any;
+export {};

package/commands/cms/convertFields.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const path = require('path');
 const fs = require('fs');
 const { createIgnoreFilter } = require('@hubspot/local-dev-lib/ignoreRules');

package/commands/cms/lighthouseScore.d.ts

@@ -1,4 +1 @@
-export const command: "lighthouse-score [--theme]";
-export const describe: false;
-export function handler(options: any): Promise<never>;
-export function builder(yargs: any): any;
+export {};

package/commands/cms/lighthouseScore.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const SpinniesManager = require('../../lib/ui/SpinniesManager');
 const { addAccountOptions, addConfigOptions, addUseEnvironmentOptions, getAccountId, } = require('../../lib/commonOpts');
 const { logger } = require('@hubspot/local-dev-lib/logger');

package/commands/cms/reactModules.d.ts

@@ -1,4 +1 @@
-export const command: "get-react-module [--name] [--dest]";
-export const describe: any;
-export function handler(options: any): Promise<void>;
-export function builder(yargs: any): any;
+export {};

package/commands/cms/reactModules.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const fs = require('fs');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { retrieveDefaultModule } = require('@hubspot/local-dev-lib/cms/modules');

package/commands/cms.d.ts

@@ -1,3 +1 @@
-export const command: "cms";
-export const describe: any;
-export function builder(yargs: any): any;
+export {};

package/commands/cms.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { i18n } = require('../lib/lang');
 const { addConfigOptions, addAccountOptions } = require('../lib/commonOpts');
 const lighthouseScore = require('./cms/lighthouseScore');

package/commands/config/set.d.ts

@@ -1,4 +1 @@
-export const command: "set";
-export const describe: any;
-export function handler(options: any): Promise<never>;
-export function builder(yargs: any): any;
+export {};

package/commands/config/set.js

@@ -1,13 +1,13 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { i18n } = require('../../lib/lang');
 const { getAccountId } = require('../../lib/commonOpts');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 const { promptUser } = require('../../lib/prompts/promptUtils');
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
-const { setDefaultMode } = require('./set/defaultMode');
-const { setHttpTimeout } = require('./set/httpTimeout');
-const { setAllowUsageTracking } = require('./set/allowUsageTracking');
+const { setDefaultMode, setHttpTimeout, setAllowUsageTracking, } = require('../../lib/configOptions');
 const i18nKey = 'commands.config.subcommands.set';
 exports.command = 'set';
 exports.describe = i18n(`${i18nKey}.describe`);

package/commands/config.d.ts

@@ -1,3 +1 @@
-export const command: "config";
-export const describe: any;
-export function builder(yargs: any): any;
+export {};

package/commands/config.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { addConfigOptions, addAccountOptions } = require('../lib/commonOpts');
 const { i18n } = require('../lib/lang');
 const set = require('./config/set');

package/commands/create/api-sample.d.ts

@@ -1,13 +1 @@
-export let hidden: boolean;
-export function dest({ dest }: {
-    dest: any;
-}): any;
-export function validate({ name }: {
-    name: any;
-}): boolean;
-export function execute({ dest, name, assetType, options }: {
-    dest: any;
-    name: any;
-    assetType: any;
-    options: any;
-}): Promise<void>;
+export {};

package/commands/create/api-sample.js

@@ -1,6 +1,8 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { createApiSamplePrompt, } = require('../../lib/prompts/createApiSamplePrompt');
-const { folderOverwritePrompt, } = require('../../lib/prompts/folderOverwritePrompt');
+const { confirmPrompt } = require('../../lib/prompts/promptUtils');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const path = require('path');
 const fs = require('fs-extra');
@@ -20,7 +22,7 @@ module.exports = {
     execute: async ({ dest, name, assetType, options }) => {
         const filePath = path.join(dest, name);
         if (fs.existsSync(filePath)) {
-            const { overwrite } = await folderOverwritePrompt(filePath);
+            const overwrite = await confirmPrompt(i18n(`${i18nKey}.folderOverwritePrompt`, { folderName: filePath }), { defaultAnswer: false });
             if (overwrite) {
                 fs.rmdirSync(filePath, { recursive: true });
             }

package/commands/create/app.d.ts

@@ -1,10 +1 @@
-export let hidden: boolean;
-export function dest({ name, assetType }: {
-    name: any;
-    assetType: any;
-}): any;
-export function execute({ options, dest, assetType }: {
-    options: any;
-    dest: any;
-    assetType: any;
-}): Promise<boolean>;
+export {};

package/commands/create/app.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { cloneGithubRepo } = require('@hubspot/local-dev-lib/github');
 module.exports = {
     hidden: true,

package/commands/create/function.d.ts

@@ -1,6 +1 @@
-export function dest({ name }: {
-    name: any;
-}): any;
-export function execute({ dest }: {
-    dest: any;
-}): Promise<void>;
+export {};

package/commands/create/function.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { createFunction } = require('@hubspot/local-dev-lib/cms/functions');
 const { createFunctionPrompt, } = require('../../lib/prompts/createFunctionPrompt');
 const { logError } = require('../../lib/errorHandlers/index');

package/commands/create/index.d.ts

@@ -1,109 +1 @@
-declare const _exports: {
-    'api-sample': {
-        hidden: boolean;
-        dest: ({ dest }: {
-            dest: any;
-        }) => any;
-        validate: ({ name }: {
-            name: any;
-        }) => boolean;
-        execute: ({ dest, name, assetType, options }: {
-            dest: any;
-            name: any;
-            assetType: any;
-            options: any;
-        }) => Promise<void>;
-    };
-    app: {
-        hidden: boolean;
-        dest: ({ name, assetType }: {
-            name: any;
-            assetType: any;
-        }) => any;
-        execute: ({ options, dest, assetType }: {
-            options: any;
-            dest: any;
-            assetType: any;
-        }) => Promise<boolean>;
-    };
-    function: {
-        dest: ({ name }: {
-            name: any;
-        }) => any;
-        execute: ({ dest }: {
-            dest: any;
-        }) => Promise<void>;
-    };
-    module: {
-        dest: ({ dest }: {
-            dest: any;
-        }) => any;
-        validate: ({ name }: {
-            name: any;
-        }) => boolean;
-        execute: ({ name, dest, getInternalVersion }: {
-            name: any;
-            dest: any;
-            getInternalVersion: any;
-        }) => Promise<void>;
-    };
-    'react-app': {
-        dest: ({ name, assetType }: {
-            name: any;
-            assetType: any;
-        }) => any;
-        execute: ({ options, dest, assetType }: {
-            options: any;
-            dest: any;
-            assetType: any;
-        }) => Promise<boolean>;
-    };
-    template: {
-        dest: ({ dest }: {
-            dest: any;
-        }) => any;
-        validate: ({ name }: {
-            name: any;
-        }) => boolean;
-        execute: ({ name, dest }: {
-            name: any;
-            dest: any;
-        }) => Promise<{
-            templateType: any;
-        }>;
-    };
-    'vue-app': {
-        dest: ({ name, assetType }: {
-            name: any;
-            assetType: any;
-        }) => any;
-        execute: ({ options, dest, assetType }: {
-            options: any;
-            dest: any;
-            assetType: any;
-        }) => Promise<boolean>;
-    };
-    'webpack-serverless': {
-        dest: ({ name, assetType }: {
-            name: any;
-            assetType: any;
-        }) => any;
-        execute: ({ options, dest, assetType }: {
-            options: any;
-            dest: any;
-            assetType: any;
-        }) => Promise<boolean>;
-    };
-    'website-theme': {
-        dest: ({ name, assetType }: {
-            name: any;
-            assetType: any;
-        }) => any;
-        execute: ({ dest, assetType, options }: {
-            dest: any;
-            assetType: any;
-            options: any;
-        }) => Promise<void>;
-    };
-};
-export = _exports;
+export {};

package/commands/create/index.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 module.exports = {
     'api-sample': require('./api-sample'),
     app: require('./app'),

package/commands/create/module.d.ts

@@ -1,11 +1 @@
-export function dest({ dest }: {
-    dest: any;
-}): any;
-export function validate({ name }: {
-    name: any;
-}): boolean;
-export function execute({ name, dest, getInternalVersion }: {
-    name: any;
-    dest: any;
-    getInternalVersion: any;
-}): Promise<void>;
+export {};

package/commands/create/module.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { createModule } = require('@hubspot/local-dev-lib/cms/modules');
 const { i18n } = require('../../lib/lang');

package/commands/create/react-app.d.ts

@@ -1,9 +1 @@
-export function dest({ name, assetType }: {
-    name: any;
-    assetType: any;
-}): any;
-export function execute({ options, dest, assetType }: {
-    options: any;
-    dest: any;
-    assetType: any;
-}): Promise<boolean>;
+export {};

package/commands/create/react-app.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { cloneGithubRepo } = require('@hubspot/local-dev-lib/github');
 module.exports = {
     dest: ({ name, assetType }) => name || assetType,

package/commands/create/template.d.ts

@@ -1,12 +1 @@
-export function dest({ dest }: {
-    dest: any;
-}): any;
-export function validate({ name }: {
-    name: any;
-}): boolean;
-export function execute({ name, dest }: {
-    name: any;
-    dest: any;
-}): Promise<{
-    templateType: any;
-}>;
+export {};

package/commands/create/template.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { createTemplate } = require('@hubspot/local-dev-lib/cms/templates');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { logError } = require('../../lib/errorHandlers/index');

package/commands/create/vue-app.d.ts

@@ -1,9 +1 @@
-export function dest({ name, assetType }: {
-    name: any;
-    assetType: any;
-}): any;
-export function execute({ options, dest, assetType }: {
-    options: any;
-    dest: any;
-    assetType: any;
-}): Promise<boolean>;
+export {};

package/commands/create/vue-app.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { cloneGithubRepo } = require('@hubspot/local-dev-lib/github');
 module.exports = {
     dest: ({ name, assetType }) => name || assetType,

package/commands/create/webpack-serverless.d.ts

@@ -1,9 +1 @@
-export function dest({ name, assetType }: {
-    name: any;
-    assetType: any;
-}): any;
-export function execute({ options, dest, assetType }: {
-    options: any;
-    dest: any;
-    assetType: any;
-}): Promise<boolean>;
+export {};

package/commands/create/webpack-serverless.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { cloneGithubRepo } = require('@hubspot/local-dev-lib/github');
 module.exports = {
     dest: ({ name, assetType }) => name || assetType,

package/commands/create/website-theme.d.ts

@@ -1,9 +1 @@
-export function dest({ name, assetType }: {
-    name: any;
-    assetType: any;
-}): any;
-export function execute({ dest, assetType, options }: {
-    dest: any;
-    assetType: any;
-    options: any;
-}): Promise<void>;
+export {};

package/commands/create/website-theme.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { cloneGithubRepo } = require('@hubspot/local-dev-lib/github');
 const { getIsInProject } = require('../../lib/projects');
 const PROJECT_BOILERPLATE_BRANCH = 'cms-boilerplate-developer-projects';