gscan 4.22.0 → 4.24.0

package/README.md

@@ -16,9 +16,9 @@ GScan works on a system of rules. Each rule has a way to check whether it passes
 
 In addition, an **error** can be marked as **fatal**. A **fatal error** means, left unchecked a Ghost publication would throw 500 errors on certain pages because of the detected out-of-date or erroneous code.
 
-In Ghost, we call GScan on boot. If any fatal errors are detected, the blog will not boot. In Ghost(Pro) and in Ghost-CLI we call GScan as part of major upgrades. The upgrade will not be allowed to continue if any fatal errors are detected.
+In Ghost, we call GScan on boot. If any fatal errors are detected in Ghost(Pro) and in Ghost-CLI we call GScan as part of major upgrades. The upgrade will not be allowed to continue if any fatal errors are detected.
 
-Errors are only be marked as **fatal errors** if they would cause errors, and therefore should block a boot or an upgrade.
+Errors are only marked as **fatal errors** if they would cause errors, and therefore should block a boot or an upgrade.
 
 ### Tooling
 When developing new rules or testing gscan following tools are great to have in the toolbelt:
@@ -46,12 +46,13 @@ To run a local zip file through the checks:
 
 `gscan /path/to/theme.zip -z`
 
-By default, GScan scans themes for the latest Ghost version compatibility. You can also specify a Ghost version by using the following parameters (for Ghost 1.0, 2.0, 3.0 and 4.0):
+By default, GScan scans themes for the latest Ghost version compatibility. You can also specify a Ghost version by using the following parameters (for Ghost 1.0, 2.0, 3.0, 4.0 and 5.0):
 
 `--v1` or `-1`  
 `--v2` or `-2`  
 `--v3` or `-3`  
-`--v4` or `-4` or `--canary`
+`--v4` or `-4`
+`--v5` or `-5` or `--canary`
 
 Use the `--canary` parameter to check for the upcoming Ghost version.
 
@@ -72,9 +73,9 @@ gscan.checkZip({
     path: 'path-to-zip',
     // if you need to check the theme for a different
     // major Ghost version, you can pass it. Currently
-    // v1, v2, v3 and canary are supported. Default is
-    // the latest Ghost version 3.0:
-    // checkVersion: 'v3',
+    // v1, v2, v3, v4 and canary (v5) are supported. Default is
+    // the latest Ghost version 4.0:
+    // checkVersion: 'v4',
     name: 'my-theme'
 }).then(function (result) {
     console.log(result);

package/app/tpl/index.hbs

@@ -23,6 +23,7 @@
                 <span class="gh-input-icon select-arrow active">{{> icon-arrow-down}}</span>
                 <select class="gh-input gh-select" name="version" id="version">
                     <option value="canary" selected>{{ghostVersions.canary.major}}</option>
+                    <option value="v4">{{ghostVersions.v4.major}}</option>
                     <option value="v3">{{ghostVersions.v3.major}}</option>
                     <option value="v2">{{ghostVersions.v2.major}}</option>
                     <option value="v1">{{ghostVersions.v1.major}}</option>

package/bin/cli.js

@@ -53,6 +53,9 @@ prettyCLI
     .boolean('-4, --v4', {
         desc: 'Check theme for Ghost 4.0 compatibility'
     })
+    .boolean('-5, --v5', {
+        desc: 'Check theme for Ghost 4.0 compatibility'
+    })
     .boolean('-c, --canary', {
         desc: 'Check theme for upcoming Ghost version compatibility'
     })
@@ -75,6 +78,8 @@ prettyCLI
             cliOptions.checkVersion = 'v3';
         } else if (argv.v4) {
             cliOptions.checkVersion = 'v4';
+        } else if (argv.v5) {
+            cliOptions.checkVersion = 'v5';
         } else if (argv.canary) {
             cliOptions.checkVersion = 'canary';
         } else {

package/lib/ast-linter/rules/index.js

@@ -2,6 +2,7 @@ module.exports = {
     'GS090-NO-IMG-URL-IN-CONDITIONALS': require('./lint-no-img-url-in-conditionals'),
     'GS090-NO-UNKNOWN-CUSTOM-THEME-SETTINGS': require('./lint-no-unknown-custom-theme-settings'),
     'GS090-NO-UNKNOWN-CUSTOM-THEME-SELECT-VALUE-IN-MATCH': require('./lint-no-unknown-custom-theme-select-value-in-match'),
+    'GS090-NO-AUTHOR-HELPER-IN-POST-CONTEXT': require('./lint-no-author-helper-in-post-page-context'),
     'no-multi-param-conditionals': require('./lint-no-multi-param-conditionals'),
     'no-nested-async-helpers': require('./lint-no-nested-async-helpers'),
     'no-prev-next-post-outside-post-context': require('./lint-no-prev-next-post-outside-post-context'),

package/lib/ast-linter/rules/internal/scope.js

@@ -190,6 +190,20 @@ class Scope {
         return this.currentFrame && this.currentFrame.context === context || false;
     }
 
+    hasParentContext(context) {
+        let found = false;
+
+        if (this.frames && this.frames.length) {
+            this.frames.forEach((frame) => {
+                if (frame.nodeName === context) {
+                    found = true;
+                }
+            });
+        }
+
+        return found;
+    }
+
     isLocal(node) {
         // @foo MustacheStatements are referencing globals rather than locals
         if (node.type === 'MustacheStatement' && node.path.data) {

package/lib/ast-linter/rules/lint-no-author-helper-in-post-page-context.js

@@ -0,0 +1,25 @@
+const Rule = require('./base');
+const {getNodeName, logNode} = require('../helpers');
+
+module.exports = class NoAuthorHelperInPostContext extends Rule {
+    _checkForHelerInPostContext(node) {
+        const nodeName = getNodeName(node);
+        const isAuthorHelper = (nodeName === 'author');
+        const isPostContext = this.scope.hasParentContext('post');
+
+        if (isAuthorHelper && isPostContext) {
+            this.log({
+                message: `${logNode(node)} should not be used in ${this.scope.currentFrame.context} context`,
+                line: node.loc && node.loc.start.line,
+                column: node.loc && node.loc.start.column,
+                source: this.sourceForNode(node)
+            });
+        }
+    }
+
+    visitor() {
+        return {
+            MustacheStatement: this._checkForHelerInPostContext.bind(this)
+        };
+    }
+};

package/lib/checker.js

@@ -27,7 +27,7 @@ const check = function checkAll(themePath, options = {}) {
     const passedVersion = _.get(options, 'checkVersion', versions.default);
     let version = passedVersion;
 
-    if (passedVersion === 'v4') {
+    if (passedVersion === 'v5') {
         version = 'canary';
     }
 

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

@@ -33,14 +33,15 @@ const v2PackageJSONValidationRules = _.extend({},
 
 const v3PackageJSONConditionalRules = {};
 const v3PackageJSONValidationRules = _.extend({},
-    {isPresentEngineGhostAPI: 'GS010-PJ-GHOST-API'},
+    {isNotPresentEngineGhostAPI: 'GS010-PJ-GHOST-API'},
     {isv01EngineGhostAPI: 'GS010-PJ-GHOST-API-V01'},
     v3PackageJSONConditionalRules
 );
 
-const canaryPackageJSONConditionalRules = {};
-const canaryPackageJSONValidationRules = _.extend({},
+const v4PackageJSONConditionalRules = {};
+const v4PackageJSONValidationRules = _.extend({},
     {isv2EngineGhostAPI: 'GS010-PJ-GHOST-API-V2'},
+    {isPresentEngineGhostAPI: 'GS010-PJ-GHOST-API-PRESENT'},
     {hasTooManyCustomThemeSettings: 'GS010-PJ-CUST-THEME-TOTAL-SETTINGS'},
     {customThemeSettingsMustBeSnakecased: 'GS010-PJ-CUST-THEME-SETTINGS-CASE'},
     {unkownCustomThemeSettingsType: 'GS010-PJ-CUST-THEME-SETTINGS-TYPE'},
@@ -50,9 +51,12 @@ const canaryPackageJSONValidationRules = _.extend({},
     {invalidCustomThemeSetingBooleanDefault: 'GS010-PJ-CUST-THEME-SETTINGS-BOOLEAN-DEFAULT'},
     {invalidCustomThemeSetingColorDefault: 'GS010-PJ-CUST-THEME-SETTINGS-COLOR-DEFAULT'},
     {invalidCustomThemeSetingImageDefault: 'GS010-PJ-CUST-THEME-SETTINGS-IMAGE-DEFAULT'},
-    canaryPackageJSONConditionalRules
+    v4PackageJSONConditionalRules
 );
 
+const canaryPackageJSONConditionalRules = {};
+const canaryPackageJSONValidationRules = _.extend({});
+
 _private.validatePackageJSONFields = function validatePackageJSONFields(packageJSON, theme, packageJSONValidationRules) {
     let failed = [];
     const passedRulesToOmit = [];
@@ -109,6 +113,10 @@ _private.validatePackageJSONFields = function validatePackageJSONFields(packageJ
     }
 
     if (!packageJSON.engines || !packageJSON.engines['ghost-api']) {
+        markFailed('isNotPresentEngineGhostAPI');
+    }
+
+    if (packageJSON.engines && packageJSON.engines['ghost-api']) {
         markFailed('isPresentEngineGhostAPI');
     }
 
@@ -221,15 +229,66 @@ module.exports = function checkPackageJSON(theme, options) {
         packageJSONValidationRules = v1PackageJSONValidationRules;
         packageJSONConditionalRules = v1PackageJSONConditionalRules;
     } else if (checkVersion === 'v2') {
-        packageJSONValidationRules = _.merge({}, v1PackageJSONValidationRules, v2PackageJSONValidationRules);
-        packageJSONConditionalRules = _.merge({}, v1PackageJSONConditionalRules, v2PackageJSONConditionalRules);
+        packageJSONValidationRules = _.merge(
+            {},
+            v1PackageJSONValidationRules,
+            v2PackageJSONValidationRules
+        );
+        packageJSONConditionalRules = _.merge(
+            {},
+            v1PackageJSONConditionalRules,
+            v2PackageJSONConditionalRules
+        );
     } else if (checkVersion === 'v3') {
-        packageJSONValidationRules = _.merge({}, v1PackageJSONValidationRules, v2PackageJSONValidationRules, v3PackageJSONValidationRules);
-        packageJSONConditionalRules = _.merge({}, v1PackageJSONConditionalRules, v2PackageJSONConditionalRules, v3PackageJSONConditionalRules);
+        packageJSONValidationRules = _.merge(
+            {},
+            v1PackageJSONValidationRules,
+            v2PackageJSONValidationRules,
+            v3PackageJSONValidationRules
+        );
+        packageJSONConditionalRules = _.merge(
+            {},
+            v1PackageJSONConditionalRules,
+            v2PackageJSONConditionalRules,
+            v3PackageJSONConditionalRules
+        );
+    } else if (checkVersion === 'v5') {
+        packageJSONValidationRules = _.merge(
+            {},
+            v1PackageJSONValidationRules,
+            v2PackageJSONValidationRules,
+            v3PackageJSONValidationRules,
+            v4PackageJSONValidationRules,
+            canaryPackageJSONValidationRules
+        );
+        delete packageJSONValidationRules.isNotPresentEngineGhostAPI;
+
+        packageJSONConditionalRules = _.merge(
+            {},
+            v1PackageJSONConditionalRules,
+            v2PackageJSONConditionalRules,
+            v3PackageJSONConditionalRules,
+            v4PackageJSONConditionalRules,
+            canaryPackageJSONConditionalRules
+        );
     } else {
-        // default check for current version 'v4'/'canary' rules
-        packageJSONValidationRules = _.merge({}, v1PackageJSONValidationRules, v2PackageJSONValidationRules, v3PackageJSONValidationRules, canaryPackageJSONValidationRules);
-        packageJSONConditionalRules = _.merge({}, v1PackageJSONConditionalRules, v2PackageJSONConditionalRules, v3PackageJSONConditionalRules, canaryPackageJSONConditionalRules);
+        // default check for current version 'v4' rules
+        packageJSONValidationRules = _.merge(
+            {},
+            v1PackageJSONValidationRules,
+            v2PackageJSONValidationRules,
+            v3PackageJSONValidationRules,
+            v4PackageJSONValidationRules
+        );
+        delete packageJSONValidationRules.isNotPresentEngineGhostAPI;
+
+        packageJSONConditionalRules = _.merge(
+            {},
+            v1PackageJSONConditionalRules,
+            v2PackageJSONConditionalRules,
+            v3PackageJSONConditionalRules,
+            v4PackageJSONConditionalRules
+        );
     }
 
     let [packageJSON] = _.filter(theme.files, {file: packageJSONFileName});

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

@@ -49,7 +49,6 @@ function getCustomThemeSettings(theme) {
 }
 
 const checkTemplatesCompile = function checkTemplatesCompile(theme, options) {
-    const failures = [];
     const checkVersion = _.get(options, 'checkVersion', versions.default);
     const ruleSet = spec.get([checkVersion]);
     const customThemeSettings = getCustomThemeSettings(theme);
@@ -63,6 +62,7 @@ const checkTemplatesCompile = function checkTemplatesCompile(theme, options) {
     });
 
     _.each(rulesToCheck, function (check, ruleCode) {
+        const failures = [];
         const processFile = processFileFunction(
             theme.files,
             failures,