Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add template utils #534

Merged
merged 8 commits into from
Sep 13, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 7 additions & 21 deletions packages/cli-lib/templates.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
const fs = require('fs');
const { logger } = require('./logger');

// Matches the .html file extension, excluding module.html
const TEMPLATE_EXTENSION_REGEX = new RegExp(/(?<!module)\.html$/);

Expand All @@ -16,28 +13,18 @@ const ANNOTATION_KEYS = {
screenshotPath: 'screenshotPath',
};

const getFileAnnotations = filePath => {
try {
const data = fs.readFileSync(filePath, 'utf8');
return getAnnotationsFromSource(data);
} catch (err) {
logger.debug(err);
return '';
}
};

const getAnnotationsFromSource = source => {
const match = source.match(ANNOTATIONS_REGEX);
const annotation = match && match[1] ? match[1] : '';
return annotation;
};

const getAnnotationValue = (annotations, key) => {
const valueRegex = new RegExp(`${key}${ANNOTATION_VALUE_REGEX}`);
const match = annotations.match(valueRegex);
return match ? match[1].trim() : null;
};

const buildAnnotationValueGetter = source => {
const match = source.match(ANNOTATIONS_REGEX);
const annotation = match && match[1] ? match[1] : '';
return annotationKey => getAnnotationValue(annotation, annotationKey);
};

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works as expected here https://github.com/HubSpot/hubspot-cms-vscode/pull/117/files#diff-dfcd8afcb372a75a1eb1bdc0af57d36a5e0a727dbca99350779abb21333a298fR65

and also tested the marketplace-validate command out and that works as expected

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! This pattern looks cleaner 🙌

/*
* Returns true if:
* .html extension (ignoring module.html)
Expand All @@ -47,7 +34,6 @@ const isCodedFile = filePath => TEMPLATE_EXTENSION_REGEX.test(filePath);
module.exports = {
ANNOTATION_KEYS,
getAnnotationValue,
getAnnotationsFromSource,
getFileAnnotations,
buildAnnotationValueGetter,
isCodedFile,
};
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
const fs = require('fs');
const {
ANNOTATION_KEYS,
getAnnotationValue,
getFileAnnotations,
buildAnnotationValueGetter,
isCodedFile,
} = require('@hubspot/cli-lib/templates');
const BaseValidator = require('../BaseValidator');
const { VALIDATOR_KEYS } = require('../../constants');
const { logger } = require('@hubspot/cli-lib/logger');

const TEMPLATE_LIMIT = 50;
const TEMPLATE_COUNT_IGNORE_LIST = ['global_partial', 'none'];
Expand Down Expand Up @@ -99,24 +100,23 @@ class TemplateValidator extends BaseValidator {

files.forEach(file => {
if (isCodedFile(file)) {
const annotations = getFileAnnotations(file);
let data;
try {
data = fs.readFileSync(file, 'utf8');
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moves the file reading step from cli-lib to cli which I don't think has any negative impact

} catch (e) {
logger.error(`Error reading file ${file}`);
}
const getAnnotationValue = buildAnnotationValueGetter(data);

const isAvailableForNewContent = getAnnotationValue(
annotations,
ANNOTATION_KEYS.isAvailableForNewContent
);

if (isAvailableForNewContent !== 'false') {
const templateType = getAnnotationValue(
annotations,
ANNOTATION_KEYS.templateType
);
const templateType = getAnnotationValue(ANNOTATION_KEYS.templateType);
if (templateType) {
const label = getAnnotationValue(
annotations,
ANNOTATION_KEYS.label
);
const label = getAnnotationValue(ANNOTATION_KEYS.label);
const screenshotPath = getAnnotationValue(
annotations,
ANNOTATION_KEYS.screenshotPath
);

Expand Down