@hubspot/cli 4.0.2-beta.6 → 4.1.0

package/lib/validators/marketplaceValidators/theme/ThemeConfigValidator.js

@@ -1,106 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const { isRelativePath } = require('@hubspot/cli-lib/path');
-const AbsoluteValidator = require('../AbsoluteValidator');
-const { VALIDATOR_KEYS } = require('../../constants');
-
-class ThemeValidator extends AbsoluteValidator {
-  constructor(options) {
-    super(options);
-
-    this.errors = {
-      MISSING_THEME_JSON: {
-        key: 'missingThemeJSON',
-        getCopy: () =>
-          'Missing the theme.json file. This file is required in all themes',
-      },
-      INVALID_THEME_JSON: {
-        key: 'invalidThemeJSON',
-        getCopy: ({ filePath }) => `Invalid json in the ${filePath} file`,
-      },
-      MISSING_LABEL: {
-        key: 'missingLabel',
-        getCopy: ({ filePath }) =>
-          `Missing required field in ${filePath}. The "label" field is required`,
-      },
-      MISSING_SCREENSHOT_PATH: {
-        key: 'missingScreenshotPath',
-        getCopy: ({ filePath }) =>
-          `Missing required field in ${filePath}. The "screenshot_path" field is required`,
-      },
-      ABSOLUTE_SCREENSHOT_PATH: {
-        key: 'absoluteScreenshotPath',
-        getCopy: ({ fieldPath }) =>
-          `Relative path required. The path for "screenshot_path" in ${fieldPath} must be relative`,
-      },
-      MISSING_SCREENSHOT: {
-        key: 'missingScreenshot',
-        getCopy: ({ fieldPath }) =>
-          `File not found. No file exists for the provided "screenshot_path" in ${fieldPath}`,
-      },
-    };
-  }
-
-  // Validates:
-  // - Theme contains a theme.json file at the theme root dir
-  // - theme.json file contains valid json
-  // - theme.json file has a "label" field
-  // - theme.json file has a relative path for "screenshot" field that resolves
-  validate(files) {
-    let validationErrors = [];
-    const themeJSONFile = files.find(filePath => {
-      // Check for theme.json at the theme root
-      const fileName = this.getRelativePath(filePath);
-      return fileName === 'theme.json';
-    });
-
-    if (!themeJSONFile) {
-      validationErrors.push(this.getError(this.errors.MISSING_THEME_JSON));
-    } else {
-      let themeJSON;
-
-      try {
-        themeJSON = JSON.parse(fs.readFileSync(themeJSONFile));
-      } catch (err) {
-        validationErrors.push(
-          this.getError(this.errors.INVALID_THEME_JSON, themeJSONFile)
-        );
-      }
-
-      if (themeJSON) {
-        if (!themeJSON.label) {
-          validationErrors.push(
-            this.getError(this.errors.MISSING_LABEL, themeJSONFile)
-          );
-        }
-        if (!themeJSON.screenshot_path) {
-          validationErrors.push(
-            this.getError(this.errors.MISSING_SCREENSHOT_PATH, themeJSONFile)
-          );
-        } else if (!isRelativePath(themeJSON.screenshot_path)) {
-          validationErrors.push(
-            this.getError(this.errors.ABSOLUTE_SCREENSHOT_PATH, themeJSONFile)
-          );
-        } else {
-          const absoluteScreenshotPath = path.resolve(
-            this._absolutePath,
-            themeJSON.screenshot_path
-          );
-          if (!fs.existsSync(absoluteScreenshotPath)) {
-            validationErrors.push(
-              this.getError(this.errors.MISSING_SCREENSHOT, themeJSONFile)
-            );
-          }
-        }
-      }
-    }
-
-    return validationErrors;
-  }
-}
-
-module.exports = new ThemeValidator({
-  name: 'Theme config',
-  key: VALIDATOR_KEYS.themeConfig,
-});

package/lib/validators/marketplaceValidators/theme/ThemeDependencyValidator.js

@@ -1,126 +0,0 @@
-const fs = require('fs-extra');
-const path = require('path');
-
-const { logger } = require('@hubspot/cli-lib/logger');
-const {
-  HUBL_EXTENSIONS,
-  HUBSPOT_FOLDER,
-} = require('@hubspot/cli-lib/lib/constants');
-const {
-  fetchTemplateDependencies,
-} = require('@hubspot/cli-lib/api/marketplace');
-const { getExt, isRelativePath } = require('@hubspot/cli-lib/path');
-
-const AbsoluteValidator = require('../AbsoluteValidator');
-const { VALIDATOR_KEYS } = require('../../constants');
-
-class ThemeDependencyValidator extends AbsoluteValidator {
-  constructor(options) {
-    super(options);
-
-    this.errors = {
-      FAILED_TO_FETCH_DEPS: {
-        key: 'failedDepFetch',
-        getCopy: ({ filePath }) =>
-          `Internal Error. Failed to fetch dependencies for ${filePath}. Please try again`,
-      },
-      EXTERNAL_DEPENDENCY: {
-        key: 'externalDependency',
-        getCopy: ({ filePath, referencedFilePath }) =>
-          `External dependency. ${filePath} references a file (${referencedFilePath}) that is outside of the theme`,
-      },
-      ABSOLUTE_DEPENDENCY_PATH: {
-        key: 'absoluteDependencyPath',
-        getCopy: ({ filePath, referencedFilePath }) =>
-          `Relative path required. ${filePath} references a file (${referencedFilePath}) using an absolute path`,
-      },
-    };
-  }
-
-  failedToFetchDependencies(err, file, validationErrors) {
-    logger.debug(`Failed to fetch dependencies for ${file}: `, err.error);
-
-    validationErrors.push(
-      this.getError(this.errors.FAILED_TO_FETCH_DEPS, file)
-    );
-  }
-
-  async getAllDependenciesByFile(files, accountId, validationErrors) {
-    return Promise.all(
-      files
-        .filter(file => HUBL_EXTENSIONS.has(getExt(file)))
-        .map(async file => {
-          const source = await fs.readFile(file, { encoding: 'utf8' });
-          let deps = [];
-          if (!(source && source.trim())) {
-            return { file, deps };
-          }
-          const file_deps = await fetchTemplateDependencies(
-            accountId,
-            source
-          ).catch(err => {
-            this.failedToFetchDependencies(err, file, validationErrors);
-            return null;
-          });
-          if (file_deps) {
-            deps = file_deps.dependencies || [];
-          }
-          return { file, deps };
-        })
-    );
-  }
-
-  isExternalDep(file, relativeDepPath) {
-    // Get dir of file that references the dep
-    const { dir } = path.parse(file);
-    // Use dir to get the dep's absolute path
-    const absoluteDepPath = path.resolve(dir, relativeDepPath);
-    // Get relative path to dep using theme absolute path and dep absolute path
-    const relativePath = this.getRelativePath(absoluteDepPath);
-    // Check that dep is not within the theme
-    return relativePath && relativePath.startsWith('..');
-  }
-
-  // Validates:
-  // - Theme does not contain external dependencies
-  // - All paths are either @hubspot or relative
-  async validate(files, accountId) {
-    let validationErrors = [];
-
-    const dependencyData = await this.getAllDependenciesByFile(
-      files,
-      accountId,
-      validationErrors
-    );
-
-    dependencyData.forEach(depData => {
-      const { file, deps } = depData;
-      deps.forEach(dependency => {
-        // Ignore:
-        // - Hubspot modules
-        if (!dependency.startsWith(HUBSPOT_FOLDER)) {
-          if (!isRelativePath(dependency)) {
-            validationErrors.push(
-              this.getError(this.errors.ABSOLUTE_DEPENDENCY_PATH, file, {
-                referencedFilePath: dependency,
-              })
-            );
-          } else if (this.isExternalDep(file, dependency)) {
-            validationErrors.push(
-              this.getError(this.errors.EXTERNAL_DEPENDENCY, file, {
-                referencedFilePath: dependency,
-              })
-            );
-          }
-        }
-      });
-    });
-
-    return validationErrors;
-  }
-}
-
-module.exports = new ThemeDependencyValidator({
-  name: 'Theme dependency',
-  key: VALIDATOR_KEYS.themeDependency,
-});

package/lib/validators/marketplaceValidators/theme/ThemeModuleValidator.js

@@ -1,117 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const { isModuleFolderChild } = require('@hubspot/cli-lib/modules');
-const AbsoluteValidator = require('../AbsoluteValidator');
-const { VALIDATOR_KEYS } = require('../../constants');
-
-const MODULE_LIMIT = 50;
-
-class ThemeModuleValidator extends AbsoluteValidator {
-  constructor(options) {
-    super(options);
-
-    this.errors = {
-      LIMIT_EXCEEDED: {
-        key: 'limitExceeded',
-        getCopy: ({ limit, total }) =>
-          `Module limit exceeded. Themes can only have ${limit} modules, but this theme has ${total}`,
-      },
-      MISSING_META_JSON: {
-        key: 'missingMetaJSON',
-        getCopy: ({ filePath }) =>
-          `Module ${filePath} is missing the meta.json file`,
-      },
-      INVALID_META_JSON: {
-        key: 'invalidMetaJSON',
-        getCopy: ({ filePath }) =>
-          `Module ${filePath} has invalid json in the meta.json file`,
-      },
-      MISSING_LABEL: {
-        key: 'missingLabel',
-        getCopy: ({ filePath }) =>
-          `Missing required property for ${filePath}. The meta.json file is missing the "label" property`,
-      },
-      MISSING_ICON: {
-        key: 'missingIcon',
-        getCopy: ({ filePath }) =>
-          `Missing required property for ${filePath}. The meta.json file is missing the "icon" property`,
-      },
-    };
-  }
-
-  getUniqueModulesFromFiles(files) {
-    const uniqueModules = {};
-
-    files.forEach(file => {
-      if (isModuleFolderChild({ isLocal: true, path: file }, true)) {
-        const { base, dir } = path.parse(file);
-        if (!uniqueModules[dir]) {
-          uniqueModules[dir] = {};
-        }
-        uniqueModules[dir][base] = file;
-      }
-    });
-    return uniqueModules;
-  }
-
-  // Validates:
-  // - Theme does not have more than MODULE_LIMIT modules
-  // - Each module folder contains a meta.json file
-  // - Each module meta.json file contains valid json
-  // - Each module meta.json file has a "label" field
-  // - Each module meta.json file has an "icon" field
-  validate(files) {
-    let validationErrors = [];
-    const uniqueModules = this.getUniqueModulesFromFiles(files);
-    const numModules = Object.keys(uniqueModules).length;
-
-    if (numModules > MODULE_LIMIT) {
-      validationErrors.push(
-        this.getError(this.errors.LIMIT_EXCEEDED, null, {
-          limit: MODULE_LIMIT,
-          total: numModules,
-        })
-      );
-    }
-
-    Object.keys(uniqueModules).forEach(modulePath => {
-      const metaJSONFile = uniqueModules[modulePath]['meta.json'];
-
-      if (!metaJSONFile) {
-        validationErrors.push(
-          this.getError(this.errors.MISSING_META_JSON, modulePath)
-        );
-      } else {
-        let metaJSON;
-        try {
-          metaJSON = JSON.parse(fs.readFileSync(metaJSONFile));
-        } catch (err) {
-          validationErrors.push(
-            this.getError(this.errors.INVALID_META_JSON, modulePath)
-          );
-        }
-
-        if (metaJSON) {
-          if (!metaJSON.label) {
-            validationErrors.push(
-              this.getError(this.errors.MISSING_LABEL, modulePath)
-            );
-          }
-          if (!metaJSON.icon) {
-            validationErrors.push(
-              this.getError(this.errors.MISSING_ICON, modulePath)
-            );
-          }
-        }
-      }
-    });
-
-    return validationErrors;
-  }
-}
-
-module.exports = new ThemeModuleValidator({
-  name: 'Theme modules',
-  key: VALIDATOR_KEYS.themeModule,
-});