gscan 4.36.3 → 4.37.1

package/lib/checker.js

@@ -1,6 +1,8 @@
 const Promise = require('bluebird');
 const _ = require('lodash');
 const requireDir = require('require-dir');
+const debug = require('@tryghost/debug')('checker');
+
 const errors = require('@tryghost/errors');
 const versions = require('./utils').versions;
 
@@ -48,8 +50,11 @@ const check = function checkAll(themePath, options = {}) {
             // set the major version to check
             theme.checkedVersion = versions[version].major;
 
-            return Promise.reduce(_.values(checks), function (themeToCheck, checkFunction) {
-                return checkFunction(themeToCheck, options, themePath);
+            return Promise.reduce(_.values(checks), async function (themeToCheck, checkFunction) {
+                const now = Date.now();
+                const result = await checkFunction(themeToCheck, options, themePath);
+                debug(checkFunction.name, 'took', Date.now() - now, 'ms');
+                return result;
             }, theme);
         })
         .catch((error) => {

package/lib/checks/010-package-json.js

@@ -57,6 +57,7 @@ const v4PackageJSONValidationRules = _.extend({},
 const canaryPackageJSONConditionalRules = {};
 const canaryPackageJSONValidationRules = _.extend({},
     {isNotPresentCardAssets: 'GS010-PJ-GHOST-CARD-ASSETS-NOT-PRESENT'},
+    {invalidCustomThemeSettingDescriptionLength: 'GS010-PJ-CUST-THEME-SETTINGS-DESCRIPTION-LENGTH'},
     canaryPackageJSONConditionalRules
 );
 
@@ -103,7 +104,7 @@ _private.validatePackageJSONFields = function validatePackageJSONFields(packageJ
         markFailed('nameIsLowerCase');
     }
 
-    if (packageJSON.name && !packageJSON.name.match(/^[a-z0-9]+(-?[a-z0-9]+)*$/gi)) {
+    if (packageJSON.name && !packageJSON.name.match(/^([a-z0-9]+-)*[a-z0-9]+$/gi)) {
         markFailed('nameIsHyphenated');
     }
 
@@ -197,6 +198,10 @@ _private.validatePackageJSONFields = function validatePackageJSONFields(packageJ
             default:
                 //do nothing here
             }
+
+            if (entry.description && entry.description.length > 100) {
+                markFailed('invalidCustomThemeSettingDescriptionLength');
+            }
         }
     }
 

package/lib/checks/090-template-syntax.js

@@ -48,7 +48,7 @@ function getCustomThemeSettings(theme) {
     return customThemeSettingsConfig;
 }
 
-const checkTemplatesCompile = function checkTemplatesCompile(theme, options) {
+const checkTemplateSyntax = function checkTemplateSyntax(theme, options) {
     const checkVersion = _.get(options, 'checkVersion', versions.default);
     const ruleSet = spec.get([checkVersion]);
     const customThemeSettings = getCustomThemeSettings(theme);
@@ -95,4 +95,4 @@ const checkTemplatesCompile = function checkTemplatesCompile(theme, options) {
     return theme;
 };
 
-module.exports = checkTemplatesCompile;
+module.exports = checkTemplateSyntax;

package/lib/specs/canary.js

@@ -706,6 +706,12 @@ let rules = {
         Find more information about the updated <code>{{price}}</code> helper <a href="${docsBaseUrl}helpers/price/" target=_blank>here</a>.`,
         helper: '{{[#].currency_symbol}}',
         regex: /currency_symbol/g
+    },
+    'GS010-PJ-CUST-THEME-SETTINGS-DESCRIPTION-LENGTH': {
+        level: 'warning',
+        rule: '<code>package.json</code> property <code>config.custom</code> contains an entry with a <code>description</code> that is too long',
+        details: oneLineTrim`<code>config.custom</code> entry <code>description</code> should be less than <code>100</code> characters so that it is displayed correctly.<br />
+        Check the <a href="${docsBaseUrl}custom-settings" target=_blank><code>config.custom</code> documentation</a> for further information.`
     }
 };
 

package/lib/specs/index.js

@@ -8,7 +8,7 @@ module.exports = {
             version = 'canary';
         }
 
-        debug('Checking against version: ', version);
+        debug('Checking against version:', version);
 
         return require(`./${[version]}`);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gscan",
-  "version": "4.36.3",
+  "version": "4.37.1",
   "description": "Scans Ghost themes looking for errors, deprecations, features and compatibility",
   "keywords": [
     "ghost",
@@ -40,9 +40,9 @@
     "gscan": "./bin/cli.js"
   },
   "dependencies": {
-    "@sentry/node": "7.51.2",
+    "@sentry/node": "7.56.0",
     "@tryghost/config": "0.2.17",
-    "@tryghost/debug": "0.1.21",
+    "@tryghost/debug": "0.1.25",
     "@tryghost/errors": "1.2.25",
     "@tryghost/logging": "2.4.5",
     "@tryghost/pretty-cli": "1.2.37",
@@ -59,7 +59,7 @@
     "multer": "1.4.4",
     "pluralize": "8.0.0",
     "require-dir": "1.2.0",
-    "semver": "7.5.0",
+    "semver": "7.5.3",
     "uuid": "9.0.0",
     "validator": "13.0.0"
   },