Adding module count, module label, and theme screenshot marketplace validators

[brandenrodgers]

Description and Context

Adding two new validator types for the marketplace theme validation command. This is a continuation of #449

Screenshots

Example console output (I set max # modules to 3 in this example):

TODO

• I am going to look into DRY-ing this up a bit because there is some repeated code for parsing out unique modules

Who to Notify

[brandenrodgers]

@KatzMitch I'm open to suggestions for better error messaging in all of these. I haven't gotten any design input on any of it, and I'm sure there's better phrasing that I could be using.

[KatzMitch]

Pulled in Amanda for feedback

[brandenrodgers]

This parses the file path list and picks out all of the unique modules in it. It returns an object that looks like this:

const uniqueModules = {
  '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module.module': {
    'fields.json': '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module.module/fields.json',
    'meta.json': '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module.module/meta.json',
    'module.html': '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module.module/module.html'
  },
  '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module_1.module': {
    'fields.json': '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module_1.module/fields.json',
    'meta.json': '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module_1.module/meta.json',
    'module.css': '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module_1.module/module.css',
    'module.html': '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module_1.module/module.html',
    'module.js': '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module_1.module/module.js'
  },
  '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module_2.module': {
    'fields.json': '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module_2.module/fields.json',
    'meta.json': '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module_2.module/meta.json',
    'module.css': '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module_2.module/module.css',
    'module.html': '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module_2.module/module.html',
    'module.js': '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module_2.module/module.js'
  }
}

[drewjenkins]

Very cool!

[miketalley]

Would it be easier to store this as an array of the relative paths of the files? It looks like we are manipulating these to be that anyway later.

const uniqueModules = {
  '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module.module': [
    'fields.json',
    'meta.json',
    'module.html'
  ],
  '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module_1.module': [
    'fields.json',
    'meta.json',
    'module.css',
    'module.html',
    'module.js'
  ],
  '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module_2.module': [
    'fields.json',
    'meta.json',
    'module.css',
    'module.html',
    'module.js'
  ]
}

[brandenrodgers]

To make the code a little DRY-er, I combined some of the validators that were doing similar things. For example, the ModuleCountValidator and ModuleLabelValidator both needed to parse the file path list to pick out the unique modules. Rather than doing that twice, I just combined them into one single ModuleValidator.

[KatzMitch]

Is this invalid JSON syntax, or includes invalid fields (or has fields that aren't a thing)

[brandenrodgers]

This is invalid JSON syntax

[miketalley]

Would it be easier to store this as an array of the relative paths of the files? It looks like we are manipulating these to be that anyway later.

const uniqueModules = {
  '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module.module': [
    'fields.json',
    'meta.json',
    'module.html'
  ],
  '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module_1.module': [
    'fields.json',
    'meta.json',
    'module.css',
    'module.html',
    'module.js'
  ],
  '/Users/brodgers/src/cms-devex-super-repo/hubspot-cli/tmp/my_module_2.module': [
    'fields.json',
    'meta.json',
    'module.css',
    'module.html',
    'module.js'
  ]
}

[miketalley]

If we stored the uniqueModules as an array of the relative filepaths, this could be a bit easier.

[brandenrodgers]

Let me know if I'm misunderstanding what you're suggesting, but I think what I have in place now is simpler than that.

I posted an example of the current shape of uniqueModules here.

Right now I'm using this object for two things. The first thing I need is to find the total number of modules, which I can do by counting the number of keys in the uniqueModules object (which should each correspond to a module in the theme). The second thing I need to do is find the path to the meta.json file for each module. Storing the files as an array would mean that I'd need to parse the array of files for each module to find the meta.json file. As it is now, I can look up the meta.json file by doing something like this uniqueModules[<module path>]['meta.json']

[brandenrodgers]

I'm going to merge this and address any remaining comments/concerns in my follow up PR here.