Merge pull request #39 from HubSpot/br-add-deprecation-comments

Add deprecation annotations to ported utils

Author: brandenrodgers

README.md

@@ -1,3 +1,7 @@
+## Deprecated
+
+This library is deprecated and is currently being replaced by the new [local-dev-lib](https://github.com/HubSpot/hubspot-local-dev-lib) library. This library will remain available for use, but no new functionality will be added to it
+
 ## Table of Contents
 
 - [Overview](#what-is-cli-lib-for)

api/fileMapper.js

@@ -169,6 +169,10 @@ async function deleteFolder(accountId, folderPath, options = {}) {
 }
 
 /**
+ * @deprecated
+ * Use the corresponding export from local-dev-lib (@hubspot/local-dev-lib/trackUsage)
+ * https://github.com/HubSpot/hubspot-local-dev-lib
+ *
  * Track CMS CLI usage
  *
  * @async

archive.js

@@ -117,6 +117,11 @@ function cleanupTempDir(tmpDir) {
   }
 }
 
+/**
+ * @deprecated
+ * Use the corresponding export from local-dev-lib
+ * https://github.com/HubSpot/hubspot-local-dev-lib
+ */
 async function extractZipArchive(
   zip,
   name,

ignoreRules.js

@@ -33,6 +33,12 @@ const ignoreRules = ignore().add(ignoreList);
 
 let searchDomain = null;
 let loaded = false;
+
+/**
+ * @deprecated
+ * Use the corresponding export from local-dev-lib
+ * https://github.com/HubSpot/hubspot-local-dev-lib
+ */
 function loadIgnoreConfig(isInProject = false) {
   if (loaded) {
     return;
@@ -54,6 +60,11 @@ function loadIgnoreConfig(isInProject = false) {
   loaded = true;
 }
 
+/**
+ * @deprecated
+ * Use the corresponding export from local-dev-lib
+ * https://github.com/HubSpot/hubspot-local-dev-lib
+ */
 function shouldIgnoreFile(file, isInProject) {
   loadIgnoreConfig(isInProject);
   const relativeTo = searchDomain || '/';
@@ -62,11 +73,21 @@ function shouldIgnoreFile(file, isInProject) {
   return !!relativePath && ignoreRules.ignores(relativePath);
 }
 
+/**
+ * @deprecated
+ * Use the corresponding export from local-dev-lib
+ * https://github.com/HubSpot/hubspot-local-dev-lib
+ */
 function createIgnoreFilter(isInProject) {
   loadIgnoreConfig(isInProject);
   return file => !shouldIgnoreFile(file);
 }
 
+/**
+ * @deprecated
+ * Use the corresponding export from local-dev-lib
+ * https://github.com/HubSpot/hubspot-local-dev-lib
+ */
 function ignoreFile(filePath) {
   ignoreRules.add(filePath);
 }

lib/environment.js

@@ -1,6 +1,9 @@
 const { ENVIRONMENTS } = require('./constants');
 
 /**
+ * @deprecated
+ * Use the corresponding export from local-dev-lib
+ * https://github.com/HubSpot/hubspot-local-dev-lib
  * Returns environment constant for QA and PROD or optional masked value for PROD
  * @param {string} env Environment string, can be any case
  * @param {(boolean|object)} shouldMaskProduction Returning alternate value for PROD

lib/files.js

@@ -4,6 +4,11 @@ const { getEnv } = require('@hubspot/local-dev-lib/config');
 const { getHubSpotWebsiteOrigin } = require('./urls');
 const { ENVIRONMENTS } = require('./constants');
 
+/**
+ * @deprecated
+ * Use the corresponding export from local-dev-lib (renamed to @hubspot/local-dev-lib/cms/themes)
+ * https://github.com/HubSpot/hubspot-local-dev-lib
+ */
 const getThemeJSONPath = path =>
   findup('theme.json', {
     cwd: path,
@@ -18,6 +23,11 @@ const getThemeNameFromPath = filePath => {
   return pathParts[pathParts.length - 2];
 };
 
+/**
+ * @deprecated
+ * Use the corresponding export from local-dev-lib (renamed to @hubspot/local-dev-lib/cms/themes)
+ * https://github.com/HubSpot/hubspot-local-dev-lib
+ */
 const getThemePreviewUrl = (filePath, accountId) => {
   const themeName = getThemeNameFromPath(filePath);
   if (!themeName) return;

lib/git.js

@@ -104,6 +104,11 @@ const checkAndWarnGitInclusion = configPath => {
   }
 };
 
+/**
+ * @deprecated
+ * Use the corresponding export from local-dev-lib (renamed to @hubspot/local-dev-lib/gitignore)
+ * https://github.com/HubSpot/hubspot-local-dev-lib
+ */
 const checkAndUpdateGitignore = configPath => {
   try {
     const { configIgnored, gitignoreFiles } = checkGitInclusion(configPath);

lib/table.js

@@ -33,12 +33,22 @@ const tableConfigDefaults = {
   },
 };
 
+/**
+ * @deprecated
+ * Use the corresponding export from local-dev-lib
+ * https://github.com/HubSpot/hubspot-local-dev-lib
+ */
 const getTableContents = (tableData = [], tableConfig = {}) => {
   const mergedConfig = mergeDeep({}, tableConfigDefaults, tableConfig);
 
   return table(tableData, mergedConfig);
 };
 
+/**
+ * @deprecated
+ * Use the corresponding export from local-dev-lib
+ * https://github.com/HubSpot/hubspot-local-dev-lib
+ */
 const getTableHeader = headerItems => {
   return headerItems.map(headerItem => chalk.bold(headerItem));
 };

lib/text.js

@@ -1,3 +1,8 @@
+/**
+ * @deprecated
+ * Use the corresponding export from local-dev-lib
+ * https://github.com/HubSpot/hubspot-local-dev-lib
+ */
 const commaSeparatedValues = (arr, conjunction = 'and', ifempty = '') => {
   let l = arr.length;
   if (!l) return ifempty;

lib/urls.js

@@ -8,10 +8,20 @@ const getEnvUrlString = env => {
   return env.toLowerCase() === ENVIRONMENTS.QA ? ENVIRONMENTS.QA : '';
 };
 
+/**
+ * @deprecated
+ * Use the corresponding export from local-dev-lib
+ * https://github.com/HubSpot/hubspot-local-dev-lib
+ */
 const getHubSpotWebsiteOrigin = env => {
   return `https://app.hubspot${getEnvUrlString(env)}.com`;
 };
 
+/**
+ * @deprecated
+ * Use the corresponding export from local-dev-lib
+ * https://github.com/HubSpot/hubspot-local-dev-lib
+ */
 const getHubSpotApiOrigin = (env, useLocalHost) => {
   let domain = process.env.HUBAPI_DOMAIN_OVERRIDE;