gscan 4.22.0 → 4.23.0

package/README.md

@@ -18,7 +18,7 @@ In addition, an **error** can be marked as **fatal**. A **fatal error** means, l
 
 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.
 
-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,

package/lib/specs/canary.js

@@ -1,291 +1,46 @@
 const _ = require('lodash');
 const oneLineTrim = require('common-tags/lib/oneLineTrim');
-const previousSpec = require('./v3');
+const previousSpec = require('./v4');
 const ghostVersions = require('../utils').versions;
 const docsBaseUrl = `https://ghost.org/docs/api/handlebars-themes/`;
-const prevDocsBaseUrl = `https://themes.ghost.org/v${ghostVersions.v3.docs}/docs/`;
+const prevDocsBaseUrl = `https://themes.ghost.org/v${ghostVersions.canary.docs}/docs/`;
 const prevDocsBaseUrlRegEx = new RegExp(prevDocsBaseUrl, 'g');
 
 const previousKnownHelpers = previousSpec.knownHelpers;
 const previousTemplates = previousSpec.templates;
 const previousRules = previousSpec.rules;
 
-function cssCardRule(cardName, className) {
-    return {
-        level: 'warning',
-        rule: `The <code>.${className}</code> CSS class is required to appear styled in your theme`,
-        details: oneLineTrim`The <code>.${className}</code> CSS class is required otherwise the ${cardName} card will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/" target=_blank>here</a>.`,
-        regex: new RegExp(`\\.${className}`, 'g'),
-        className: `.${className}`,
-        css: true,
-        cardAsset: cardName
-    };
-}
-
 // assign new or overwrite existing knownHelpers, templates, or rules here:
-let knownHelpers = ['match'];
+let knownHelpers = [];
 let templates = [];
 let rules = {
     // New rules
-    'GS010-PJ-GHOST-API': {
-        level: 'warning',
-        rule: '<code>package.json</code> property <code>"engines.ghost-api"</code> is recommended. Otherwise, it falls back to "v4"',
-        details: oneLineTrim`Add <code>"ghost-api"</code> to your <code>package.json</code>. E.g. <code>{"engines": {"ghost-api": "v4"}}</code>.<br>
-        If no <code>"ghost-api"</code> property is provided, Ghost will use its default setting of "v4" Ghost API.<br>
-        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
-    },
-    'GS010-PJ-GHOST-API-V01': {
-        level: 'error',
-        rule: '<code>package.json</code> property <code>"engines.ghost-api"</code> is incompatible with current version of Ghost API and will fall back to "v4"',
-        details: oneLineTrim`Change <code>"ghost-api"</code> in your <code>package.json</code> to higher version. E.g. <code>{"engines": {"ghost-api": "v4"}}</code>.<br>
-        If <code>"ghost-api"</code> property is left at "v0.1", Ghost will use its default setting of "v4".<br>
-        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
-    },
-    'GS010-PJ-GHOST-API-V2': {
-        level: 'warning',
-        rule: '<code>package.json</code> property <code>"engines.ghost-api"</code> is using a deprecated version of Ghost API',
-        details: oneLineTrim`Change <code>"ghost-api"</code> in your <code>package.json</code> to higher version. E.g. <code>{"engines": {"ghost-api": "v4"}}</code>.<br>
-        If <code>"ghost-api"</code> property is left at "v2", it will stop working with next major version upgrade and default to v5.<br>
-        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
-    },
-    'GS010-PJ-CUST-THEME-TOTAL-SETTINGS': {
-        level: 'error',
-        rule: '<code>package.json</code> property <code>"config.custom"</code> contains too many settings',
-        details: oneLineTrim`Remove key from <code>"config.custom"</code> in your <code>package.json</code> to have less than or exactly 15 settings.<br>
-        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
-    },
-    'GS010-PJ-CUST-THEME-SETTINGS-CASE': {
-        level: 'error',
-        rule: '<code>package.json</code> property <code>"config.custom"</code> contains a property that isn\'t snake-cased',
-        details: oneLineTrim`Rewrite all property in <code>"config.custom"</code> in your <code>package.json</code> in snake case.<br>
-        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
-    },
-    'GS010-PJ-CUST-THEME-SETTINGS-TYPE': {
-        level: 'error',
-        rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> should have a known <code>"type"</code>.',
-        details: oneLineTrim`Only use the following types: <code>"select"</code>, <code>"boolean"</code>, <code>"color"</code>, <code>"image"</code>, <code>"text"</code>.<br>
-        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
-    },
-    'GS010-PJ-CUST-THEME-SETTINGS-GROUP': {
-        level: 'recommendation',
-        rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> should have a known <code>"group"</code>.',
-        details: oneLineTrim`Only use the following groups: <code>"post"</code>, <code>"homepage"</code>.<br>
-        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
-    },
-    'GS010-PJ-CUST-THEME-SETTINGS-SELECT-OPTIONS': {
-        level: 'error',
-        rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> of type <code>"select"</code> need to have at least 2 <code>"options"</code>.',
-        details: oneLineTrim`Make sure there is at least 2 <code>"options"</code> in each <code>"select"</code> custom theme property.<br>
-        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
-    },
-    'GS010-PJ-CUST-THEME-SETTINGS-SELECT-DEFAULT': {
-        level: 'error',
-        rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> of type <code>"select"</code> need to have a valid <code>"default"</code>.',
-        details: oneLineTrim`Make sure the <code>"default"</code> property matches a value in <code>"options"</code> of the same <code>"select"</code>.<br>
-        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
-    },
-    'GS010-PJ-CUST-THEME-SETTINGS-BOOLEAN-DEFAULT': {
-        level: 'error',
-        rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> of type <code>"boolean"</code> need to have a valid <code>"default"</code>.',
-        details: oneLineTrim`Make sure the <code>"default"</code> property is either <code>true</code> or <code>false</code>.<br>
-        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
-    },
-    'GS010-PJ-CUST-THEME-SETTINGS-COLOR-DEFAULT': {
+    'GS010-PJ-GHOST-API-PRESENT': {
         level: 'error',
-        rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> of type <code>"color"</code> need to have a valid <code>"default"</code>.',
-        details: oneLineTrim`Make sure the <code>"default"</code> property is a valid 6-hexadecimal-digit color code like <code>#15171a</code>.<br>
+        rule: '<code>package.json</code> property <code>"engines.ghost-api"</code> is not supported.',
+        details: oneLineTrim`Remove <code>"ghost-api"</code> from your <code>package.json</code>.<br>
+        The <code>ghost-api</code> is not supported starting Ghost v5 and should not be used.
         Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
     },
-    'GS010-PJ-CUST-THEME-SETTINGS-IMAGE-DEFAULT': {
+    'GS001-DEPR-BLOG': {
         level: 'error',
-        rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> of type <code>"image"</code> can\'t have a <code>"default"</code> value.',
-        details: oneLineTrim`Make sure the <code>"default"</code> property is either <code>null</code>, an empty string <code>''</code> or isn't present.<br>
-        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
-    },
-    'GS001-DEPR-LABS-MEMBERS': {
-        level: 'warning',
-        rule: 'The <code>{{@labs.members}}</code> helper should not be used.',
-        details: oneLineTrim`Remove <code>{{@labs.members}}</code> from the theme.<br>
-        The <code>{{@labs.members}}</code> helper will always return <code>true</code> in Ghost v4 and will be removed from Ghost v5, at which point it will return <code>null</code> and evaluate to <code>false</code>.
-        Find more information about the <code>@labs</code> property <a href="${docsBaseUrl}helpers/labs/" target=_blank>here</a>.`,
-        regex: /@labs\.members/g,
-        helper: '{{@labs.members}}'
-    },
-    'GS080-FEACH-POSTS': {
-        level: 'warning',
-        rule: 'The default visibility for posts in <code>{{#foreach}}</code> block helper has changed in v4.',
-        details: oneLineTrim`The default visibility for posts in <code>{{#foreach}}</code> block helper has changed from <code>public</code> to <code>all</code> in Ghost v4.
-        Find more information about the <code>{{foreach}}</code> helper <a href="${docsBaseUrl}helpers/foreach/" target=_blank>here</a>.`,
-        regex: /{{\s*?#foreach\s*?\w*?\s*?}}/g,
-        helper: '{{#foreach}}',
-        validInAPI: ['v3']
-    },
-    'GS080-CARD-LAST4': {
-        level: 'warning',
-        rule: 'The <code>default_payment_card_last4</code> field now coalesces to <code>****</code> in Ghost 4.x instead of null.',
-        details: oneLineTrim`The <code>default_payment_card_last4</code> field no longer outputs a falsy(null) value in case of missing card details starting from Ghost 4.x and instead coalesces to <code>****</code>
-        Find more information about the <code>default_payment_card_last4</code> attribute <a href="${docsBaseUrl}members/#subscription-attributes" target=_blank>here</a>.`,
-        regex: /default_payment_card_last4/g,
-        helper: '{{default_payment_card_last4}}',
-        validInAPI: ['v3']
-    },
-    'GS080-FEACH-PV': {
-        level: 'recommendation',
-        rule: 'The use of <code>visibility="all"</code> is no longer required for posts in <code>{{#foreach}}</code> helper.',
-        details: oneLineTrim`The default visibility in <code>{{#foreach}}</code> helper for posts has changed in v4 from "public" to "all" and is no longer required when looping over posts.
-        Check out the documentation for <code>{{#foreach}}</code> <a href="${docsBaseUrl}helpers/foreach/" target=_blank>here</a>.`,
-        regex: /{{\s*?#foreach\b[\w\s='"]*?visibility=("|')all("|')[\w\s='"]*?}}/g,
-        helper: '{{#foreach}}',
-        validInAPI: ['v3']
-    },
-    'GS001-DEPR-CURR-SYM': {
-        level: 'warning',
-        rule: 'Replace <code>{{[#].currency_symbol}}</code> with <code>{{price currency=currency}}</code>.',
-        details: oneLineTrim`The hardcoded <code>currency_symbol</code> attribute was removed in favour of passing the currency to updated <code>{{price}}</code> helper.
-        Find more information about the updated <code>{{price}}</code> helper <a href="${docsBaseUrl}members/#the-price-helper" target=_blank>here</a>.`,
-        helper: '{{[#].currency_symbol}}',
-        regex: /currency_symbol/g
-    },
-    'GS001-DEPR-SITE-LANG': {
-        level: 'warning',
-        rule: 'The <code>{{@site.lang}}</code> helper should be replaced with <code>{{@site.locale}}</code>',
-        details: oneLineTrim`Replace <code>{{@site.lang}}</code> helper with <code>{{@site.locale}}</code>.<br>
-        The <code>{{@site.lang}}</code> helper will be removed in next version of Ghost and should not be used.
+        fatal: true,
+        rule: 'The <code>{{@blog}}</code> helper should be replaced with <code>{{@site}}</code>',
+        details: oneLineTrim`With the introduction of the Content API <code>{{@blog}}</code> became deprecated in favour of <code>{{@site}}</code>.<br>
+        The <code>{{@blog}}</code> helper was removed in Ghost v5 and should not be used.
         Find more information about the <code>@site</code> property <a href="${docsBaseUrl}helpers/site/" target=_blank>here</a>.`,
-        regex: /@site\.lang/g,
-        helper: '{{@site.lang}}'
-    },
-    'GS070-VALID-TRANSLATIONS': {
-        level: 'error',
-        rule: 'Theme translations must be parsable',
-        fatal: true, // overwritten from v3 to be fatal
-        details: oneLineTrim`Theme translations (located in <code>locales/*.json</code>) need to be readable by the node JSON parser, or they will not be applied.`
-    },
-    'GS090-NO-IMG-URL-IN-CONDITIONALS': {
-        level: 'warning',
-        rule: 'The {{img_url}} helper should not be used as a parameter to {{#if}} or {{#unless}}',
-        fatal: false,
-        details: oneLineTrim`The {{img_url}} helper should not be used as a parameter to {{#if}} or {{#unless}}`
+        regex: /{{\s*?@blog\.[a-zA-Z0-9_]+\s*?}}/g,
+        helper: '{{@blog}}'
     },
-    'GS090-NO-UNKNOWN-CUSTOM-THEME-SETTINGS': {
+    'GS090-NO-AUTHOR-HELPER-IN-POST-CONTEXT': {
         level: 'error',
-        rule: 'An unkown custom theme setting has been used.',
-        fatal: false,
-        details: oneLineTrim`The custom theme setting should all be defined in the package.json <code>config.custom</code> object.`
-    },
-    'GS090-NO-UNKNOWN-CUSTOM-THEME-SELECT-VALUE-IN-MATCH': {
-        level: 'error',
-        rule: 'A custom theme setting of type <code>select</code> has been compared to a value that isn\'t defined.',
-        fatal: false,
-        details: oneLineTrim`Custom theme settings of type <code>select</code> can only be compared to their defined <code>options</code> when used in a <code>match</code> block.`
-    },
-    'GS100-NO-UNUSED-CUSTOM-THEME-SETTING': {
-        level: 'error',
-        rule: 'A custom theme setting defined in <code>package.json</code> hasn\'t been used in any theme file.',
-        details: oneLineTrim`Custom theme settings defined in <code>package.json</code> must be used at least once in the theme templates.`
-    },
-
-    'GS050-CSS-KGCO': cssCardRule('callout', 'kg-callout-card'),
-    'GS050-CSS-KGCOE': cssCardRule('callout', 'kg-callout-card-emoji'),
-    'GS050-CSS-KGCOT': cssCardRule('callout', 'kg-callout-card-text'),
-    'GS050-CSS-KGCOBGGY': cssCardRule('callout', 'kg-callout-card-background-grey'),
-    'GS050-CSS-KGCOBGW': cssCardRule('callout', 'kg-callout-card-background-white'),
-    'GS050-CSS-KGCOBGB': cssCardRule('callout', 'kg-callout-card-background-blue'),
-    'GS050-CSS-KGCOBGGN': cssCardRule('callout', 'kg-callout-card-background-green'),
-    'GS050-CSS-KGCOBGY': cssCardRule('callout', 'kg-callout-card-background-yellow'),
-    'GS050-CSS-KGCOBGR': cssCardRule('callout', 'kg-callout-card-background-red'),
-    'GS050-CSS-KGCOBGPK': cssCardRule('callout', 'kg-callout-card-background-pink'),
-    'GS050-CSS-KGCOBGPE': cssCardRule('callout', 'kg-callout-card-background-purple'),
-    'GS050-CSS-KGCOBGA': cssCardRule('callout', 'kg-callout-card-background-accent'),
-
-    'GS050-CSS-KG-NFT': cssCardRule('nft', 'kg-nft-card'),
-    'GS050-CSS-KG-NFTCO': cssCardRule('nft', 'kg-nft-card-container'),
-    'GS050-CSS-KG-NFTMD': cssCardRule('nft', 'kg-nft-metadata'),
-    'GS050-CSS-KG-NFTIMG': cssCardRule('nft', 'kg-nft-image'),
-    'GS050-CSS-KG-NFTHD': cssCardRule('nft', 'kg-nft-header'),
-    'GS050-CSS-KG-NFTTIT': cssCardRule('nft', 'kg-nft-title'),
-    'GS050-CSS-KG-NFTLG': cssCardRule('nft', 'kg-nft-logo'),
-    'GS050-CSS-KG-NFTCTR': cssCardRule('nft', 'kg-nft-creator'),
-    'GS050-CSS-KG-NFTDSC': cssCardRule('nft', 'kg-nft-description'),
-
-    'GS050-CSS-KGTGL': cssCardRule('toggle', 'kg-toggle-card'),
-    'GS050-CSS-KGTGLH': cssCardRule('toggle', 'kg-toggle-heading'),
-    'GS050-CSS-KGTGLHT': cssCardRule('toggle', 'kg-toggle-heading-text'),
-    'GS050-CSS-KGTGLIC': cssCardRule('toggle', 'kg-toggle-card-icon'),
-    'GS050-CSS-KGTGLC': cssCardRule('toggle', 'kg-toggle-content'),
-
-    'GS050-CSS-KGAUD': cssCardRule('audio', 'kg-audio-card'),
-    'GS050-CSS-KGAUDTHUMB': cssCardRule('audio', 'kg-audio-thumbnail'),
-    'GS050-CSS-KGAUDTHUMBPL': cssCardRule('audio', 'kg-audio-thumbnail.placeholder'),
-    'GS050-CSS-KGAUDPLCNT': cssCardRule('audio', 'kg-audio-player-container'),
-    'GS050-CSS-KGAUDTI': cssCardRule('audio', 'kg-audio-title'),
-    'GS050-CSS-KGAUDPL': cssCardRule('audio', 'kg-audio-player'),
-    'GS050-CSS-KGAUDCURRTM': cssCardRule('audio', 'kg-audio-current-time'),
-    'GS050-CSS-KGAUDTM': cssCardRule('audio', 'kg-audio-time'),
-    'GS050-CSS-KGAUDDUR': cssCardRule('audio', 'kg-audio-duration'),
-    'GS050-CSS-KGAUDPLICO': cssCardRule('audio', 'kg-audio-play-icon'),
-    'GS050-CSS-KGAUDPAUICO': cssCardRule('audio', 'kg-audio-pause-icon'),
-    'GS050-CSS-KGAUDSKSL': cssCardRule('audio', 'kg-audio-seek-slider'),
-    'GS050-CSS-KGAUDPLRT': cssCardRule('audio', 'kg-audio-playback-rate'),
-    'GS050-CSS-KGAUDMTICO': cssCardRule('audio', 'kg-audio-mute-icon'),
-    'GS050-CSS-KGAUDUNMTICO': cssCardRule('audio', 'kg-audio-unmute-icon'),
-    'GS050-CSS-KGAUDVOLSL': cssCardRule('audio', 'kg-audio-volume-slider'),
-
-    'GS050-CSS-KGVID': cssCardRule('video', 'kg-video-card'),
-    'GS050-CSS-KGVIDHD': cssCardRule('video', 'kg-video-hide'),
-    'GS050-CSS-KGVIDCNT': cssCardRule('video', 'kg-video-container'),
-    'GS050-CSS-KGVIDOVL': cssCardRule('video', 'kg-video-overlay'),
-    'GS050-CSS-KGVIDLGPLICO': cssCardRule('video', 'kg-video-large-play-icon'),
-    'GS050-CSS-KGVIDTHUMB': cssCardRule('video', 'kg-video-thumbnail'),
-    'GS050-CSS-KGVIDTHUMBPL': cssCardRule('video', 'kg-video-thumbnail.placeholder'),
-    'GS050-CSS-KGVIDPLCNT': cssCardRule('video', 'kg-video-player-container'),
-    'GS050-CSS-KGVIDTI': cssCardRule('video', 'kg-video-title'),
-    'GS050-CSS-KGVIDPL': cssCardRule('video', 'kg-video-player'),
-    'GS050-CSS-KGVIDCURRTM': cssCardRule('video', 'kg-video-current-time'),
-    'GS050-CSS-KGVIDTM': cssCardRule('video', 'kg-video-time'),
-    'GS050-CSS-KGVIDDUR': cssCardRule('video', 'kg-video-duration'),
-    'GS050-CSS-KGVIDPLICO': cssCardRule('video', 'kg-video-play-icon'),
-    'GS050-CSS-KGVIDPAUICO': cssCardRule('video', 'kg-video-pause-icon'),
-    'GS050-CSS-KGVIDSKSL': cssCardRule('video', 'kg-video-seek-slider'),
-    'GS050-CSS-KGVIDPLRT': cssCardRule('video', 'kg-video-playback-rate'),
-    'GS050-CSS-KGVIDMTICO': cssCardRule('video', 'kg-video-mute-icon'),
-    'GS050-CSS-KGVIDUNMTICO': cssCardRule('video', 'kg-video-unmute-icon'),
-    'GS050-CSS-KGVIDVOLSL': cssCardRule('video', 'kg-video-volume-slider'),
-
-    'GS050-CSS-KGBTN': cssCardRule('button', 'kg-button-card'),
-    'GS050-CSS-KGBTNL': cssCardRule('button', 'kg-button-card.kg-align-left'),
-    'GS050-CSS-KGBTNC': cssCardRule('button', 'kg-button-card.kg-align-center'),
-    'GS050-CSS-KGBTNBTN': cssCardRule('button', 'kg-btn'),
-    'GS050-CSS-KGBTNBTNA': cssCardRule('button', 'kg-btn-accent'),
-
-    'GS050-CSS-KGPR': cssCardRule('product', 'kg-product-card'),
-    'GS050-CSS-KGPRBTNA': cssCardRule('product', 'kg-product-card-btn-accent'),
-    'GS050-CSS-KGPRBTN': cssCardRule('product', 'kg-product-card-button'),
-    'GS050-CSS-KGPRCO': cssCardRule('product', 'kg-product-card-container'),
-    'GS050-CSS-KGPRDE': cssCardRule('product', 'kg-product-card-description'),
-    'GS050-CSS-KGPRIM': cssCardRule('product', 'kg-product-card-image'),
-    'GS050-CSS-KGPRRA': cssCardRule('product', 'kg-product-card-rating'),
-    'GS050-CSS-KGPRRAA': cssCardRule('product', 'kg-product-card-rating-active'),
-    'GS050-CSS-KGPRRAS': cssCardRule('product', 'kg-product-card-rating-star'),
-    'GS050-CSS-KGPRTI': cssCardRule('product', 'kg-product-card-title'),
-    'GS050-CSS-KGPRTICO': cssCardRule('product', 'kg-product-card-title-container'),
-
-    'GS050-CSS-KGBA': cssCardRule('before-after', 'kg-before-after-card'),
-    'GS050-CSS-KGBAIA': cssCardRule('before-after', 'kg-before-after-card-image-before'),
-    'GS050-CSS-KGBAIB': cssCardRule('before-after', 'kg-before-after-card-image-after'),
-
-    'GS050-CSS-KGFL': cssCardRule('file', 'kg-file-card'),
-    'GS050-CSS-KGFLCON': cssCardRule('file', 'kg-file-card-container'),
-    'GS050-CSS-KGFLCNT': cssCardRule('file', 'kg-file-card-contents'),
-    'GS050-CSS-KGFLTTL': cssCardRule('file', 'kg-file-card-title'),
-    'GS050-CSS-KGFLCAP': cssCardRule('file', 'kg-file-card-caption'),
-    'GS050-CSS-KGFLNM': cssCardRule('file', 'kg-file-card-filename'),
-    'GS050-CSS-KGFLSZ': cssCardRule('file', 'kg-file-card-filesize'),
-    'GS050-CSS-KGFLMD': cssCardRule('file', 'kg-file-card-medium'),
-    'GS050-CSS-KGFLSM': cssCardRule('file', 'kg-file-card-small'),
-
-    'GS050-CSS-KGBQALT': cssCardRule('blockquote', 'kg-blockquote-alt')
+        fatal: true,
+        rule: 'The <code>{{author}}</code> helper should be replaces with <code>{{authors}}</code>',
+        details: oneLineTrim`The <code>{{author}}</code> helper has been deprecated since Ghost 1.22.0 in favor of <code>{{<authors>}}</code><br>
+        The <code>{{author}}</code> helper was removed in Ghost v5 and should not be used.
+        Find more information about the <code>@site</code> property <a href="${docsBaseUrl}helpers/site/" target=_blank>here</a>.`,
+        helper: '{{author}}'
+    }
 };
 
 knownHelpers = _.union(previousKnownHelpers, knownHelpers);

package/lib/specs/index.js

@@ -4,7 +4,7 @@ module.exports = {
     get: function get(key) {
         let [version] = key;
 
-        if (version === 'v4') {
+        if (version === 'v5') {
             version = 'canary';
         }
 

package/lib/specs/v4.js

@@ -0,0 +1,306 @@
+const _ = require('lodash');
+const oneLineTrim = require('common-tags/lib/oneLineTrim');
+const previousSpec = require('./v3');
+const ghostVersions = require('../utils').versions;
+const docsBaseUrl = `https://ghost.org/docs/api/handlebars-themes/`;
+const prevDocsBaseUrl = `https://themes.ghost.org/v${ghostVersions.v3.docs}/docs/`;
+const prevDocsBaseUrlRegEx = new RegExp(prevDocsBaseUrl, 'g');
+
+const previousKnownHelpers = previousSpec.knownHelpers;
+const previousTemplates = previousSpec.templates;
+const previousRules = previousSpec.rules;
+
+function cssCardRule(cardName, className) {
+    return {
+        level: 'warning',
+        rule: `The <code>.${className}</code> CSS class is required to appear styled in your theme`,
+        details: oneLineTrim`The <code>.${className}</code> CSS class is required otherwise the ${cardName} card will appear unstyled.
+        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/" target=_blank>here</a>.`,
+        regex: new RegExp(`\\.${className}`, 'g'),
+        className: `.${className}`,
+        css: true,
+        cardAsset: cardName
+    };
+}
+
+// assign new or overwrite existing knownHelpers, templates, or rules here:
+let knownHelpers = ['match'];
+let templates = [];
+let rules = {
+    // New rules
+    'GS010-PJ-GHOST-API-PRESENT': {
+        level: 'warning',
+        rule: '<code>package.json</code> property <code>"engines.ghost-api"</code> is deprecated.',
+        details: oneLineTrim`Remove <code>"ghost-api"</code> from your <code>package.json</code>.<br>
+        The <code>ghost-api</code> support will be removed in next major version of Ghost and should not be used.
+        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
+    },
+    'GS010-PJ-GHOST-API-V01': {
+        level: 'error',
+        rule: '<code>package.json</code> property <code>"engines.ghost-api"</code> is incompatible with current version of Ghost API and will fall back to "v4"',
+        details: oneLineTrim`Change <code>"ghost-api"</code> in your <code>package.json</code> to higher version. E.g. <code>{"engines": {"ghost-api": "v4"}}</code>.<br>
+        If <code>"ghost-api"</code> property is left at "v0.1", Ghost will use its default setting of "v4".<br>
+        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
+    },
+    'GS010-PJ-GHOST-API-V2': {
+        level: 'warning',
+        rule: '<code>package.json</code> property <code>"engines.ghost-api"</code> is using a deprecated version of Ghost API',
+        details: oneLineTrim`Change <code>"ghost-api"</code> in your <code>package.json</code> to higher version. E.g. <code>{"engines": {"ghost-api": "v4"}}</code>.<br>
+        If <code>"ghost-api"</code> property is left at "v2", it will stop working with next major version upgrade and default to v5.<br>
+        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
+    },
+    'GS010-PJ-CUST-THEME-TOTAL-SETTINGS': {
+        level: 'error',
+        rule: '<code>package.json</code> property <code>"config.custom"</code> contains too many settings',
+        details: oneLineTrim`Remove key from <code>"config.custom"</code> in your <code>package.json</code> to have less than or exactly 15 settings.<br>
+        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
+    },
+    'GS010-PJ-CUST-THEME-SETTINGS-CASE': {
+        level: 'error',
+        rule: '<code>package.json</code> property <code>"config.custom"</code> contains a property that isn\'t snake-cased',
+        details: oneLineTrim`Rewrite all property in <code>"config.custom"</code> in your <code>package.json</code> in snake case.<br>
+        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
+    },
+    'GS010-PJ-CUST-THEME-SETTINGS-TYPE': {
+        level: 'error',
+        rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> should have a known <code>"type"</code>.',
+        details: oneLineTrim`Only use the following types: <code>"select"</code>, <code>"boolean"</code>, <code>"color"</code>, <code>"image"</code>, <code>"text"</code>.<br>
+        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
+    },
+    'GS010-PJ-CUST-THEME-SETTINGS-GROUP': {
+        level: 'recommendation',
+        rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> should have a known <code>"group"</code>.',
+        details: oneLineTrim`Only use the following groups: <code>"post"</code>, <code>"homepage"</code>.<br>
+        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
+    },
+    'GS010-PJ-CUST-THEME-SETTINGS-SELECT-OPTIONS': {
+        level: 'error',
+        rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> of type <code>"select"</code> need to have at least 2 <code>"options"</code>.',
+        details: oneLineTrim`Make sure there is at least 2 <code>"options"</code> in each <code>"select"</code> custom theme property.<br>
+        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
+    },
+    'GS010-PJ-CUST-THEME-SETTINGS-SELECT-DEFAULT': {
+        level: 'error',
+        rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> of type <code>"select"</code> need to have a valid <code>"default"</code>.',
+        details: oneLineTrim`Make sure the <code>"default"</code> property matches a value in <code>"options"</code> of the same <code>"select"</code>.<br>
+        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
+    },
+    'GS010-PJ-CUST-THEME-SETTINGS-BOOLEAN-DEFAULT': {
+        level: 'error',
+        rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> of type <code>"boolean"</code> need to have a valid <code>"default"</code>.',
+        details: oneLineTrim`Make sure the <code>"default"</code> property is either <code>true</code> or <code>false</code>.<br>
+        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
+    },
+    'GS010-PJ-CUST-THEME-SETTINGS-COLOR-DEFAULT': {
+        level: 'error',
+        rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> of type <code>"color"</code> need to have a valid <code>"default"</code>.',
+        details: oneLineTrim`Make sure the <code>"default"</code> property is a valid 6-hexadecimal-digit color code like <code>#15171a</code>.<br>
+        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
+    },
+    'GS010-PJ-CUST-THEME-SETTINGS-IMAGE-DEFAULT': {
+        level: 'error',
+        rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> of type <code>"image"</code> can\'t have a <code>"default"</code> value.',
+        details: oneLineTrim`Make sure the <code>"default"</code> property is either <code>null</code>, an empty string <code>''</code> or isn't present.<br>
+        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
+    },
+    'GS001-DEPR-LABS-MEMBERS': {
+        level: 'warning',
+        rule: 'The <code>{{@labs.members}}</code> helper should not be used.',
+        details: oneLineTrim`Remove <code>{{@labs.members}}</code> from the theme.<br>
+        The <code>{{@labs.members}}</code> helper will always return <code>true</code> in Ghost v4 and will be removed from Ghost v5, at which point it will return <code>null</code> and evaluate to <code>false</code>.
+        Find more information about the <code>@labs</code> property <a href="${docsBaseUrl}helpers/labs/" target=_blank>here</a>.`,
+        regex: /@labs\.members/g,
+        helper: '{{@labs.members}}'
+    },
+    'GS080-FEACH-POSTS': {
+        level: 'warning',
+        rule: 'The default visibility for posts in <code>{{#foreach}}</code> block helper has changed in v4.',
+        details: oneLineTrim`The default visibility for posts in <code>{{#foreach}}</code> block helper has changed from <code>public</code> to <code>all</code> in Ghost v4.
+        Find more information about the <code>{{foreach}}</code> helper <a href="${docsBaseUrl}helpers/foreach/" target=_blank>here</a>.`,
+        regex: /{{\s*?#foreach\s*?\w*?\s*?}}/g,
+        helper: '{{#foreach}}',
+        validInAPI: ['v3']
+    },
+    'GS080-CARD-LAST4': {
+        level: 'warning',
+        rule: 'The <code>default_payment_card_last4</code> field now coalesces to <code>****</code> in Ghost 4.x instead of null.',
+        details: oneLineTrim`The <code>default_payment_card_last4</code> field no longer outputs a falsy(null) value in case of missing card details starting from Ghost 4.x and instead coalesces to <code>****</code>
+        Find more information about the <code>default_payment_card_last4</code> attribute <a href="${docsBaseUrl}members/#subscription-attributes" target=_blank>here</a>.`,
+        regex: /default_payment_card_last4/g,
+        helper: '{{default_payment_card_last4}}',
+        validInAPI: ['v3']
+    },
+    'GS080-FEACH-PV': {
+        level: 'recommendation',
+        rule: 'The use of <code>visibility="all"</code> is no longer required for posts in <code>{{#foreach}}</code> helper.',
+        details: oneLineTrim`The default visibility in <code>{{#foreach}}</code> helper for posts has changed in v4 from "public" to "all" and is no longer required when looping over posts.
+        Check out the documentation for <code>{{#foreach}}</code> <a href="${docsBaseUrl}helpers/foreach/" target=_blank>here</a>.`,
+        regex: /{{\s*?#foreach\b[\w\s='"]*?visibility=("|')all("|')[\w\s='"]*?}}/g,
+        helper: '{{#foreach}}',
+        validInAPI: ['v3']
+    },
+    'GS001-DEPR-CURR-SYM': {
+        level: 'warning',
+        rule: 'Replace <code>{{[#].currency_symbol}}</code> with <code>{{price currency=currency}}</code>.',
+        details: oneLineTrim`The hardcoded <code>currency_symbol</code> attribute was removed in favour of passing the currency to updated <code>{{price}}</code> helper.
+        Find more information about the updated <code>{{price}}</code> helper <a href="${docsBaseUrl}members/#the-price-helper" target=_blank>here</a>.`,
+        helper: '{{[#].currency_symbol}}',
+        regex: /currency_symbol/g
+    },
+    'GS001-DEPR-SITE-LANG': {
+        level: 'warning',
+        rule: 'The <code>{{@site.lang}}</code> helper should be replaced with <code>{{@site.locale}}</code>',
+        details: oneLineTrim`Replace <code>{{@site.lang}}</code> helper with <code>{{@site.locale}}</code>.<br>
+        The <code>{{@site.lang}}</code> helper will be removed in next version of Ghost and should not be used.
+        Find more information about the <code>@site</code> property <a href="${docsBaseUrl}helpers/site/" target=_blank>here</a>.`,
+        regex: /@site\.lang/g,
+        helper: '{{@site.lang}}'
+    },
+    'GS070-VALID-TRANSLATIONS': {
+        level: 'error',
+        rule: 'Theme translations must be parsable',
+        fatal: true, // overwritten from v3 to be fatal
+        details: oneLineTrim`Theme translations (located in <code>locales/*.json</code>) need to be readable by the node JSON parser, or they will not be applied.`
+    },
+    'GS090-NO-IMG-URL-IN-CONDITIONALS': {
+        level: 'warning',
+        rule: 'The {{img_url}} helper should not be used as a parameter to {{#if}} or {{#unless}}',
+        fatal: false,
+        details: oneLineTrim`The {{img_url}} helper should not be used as a parameter to {{#if}} or {{#unless}}`
+    },
+    'GS090-NO-UNKNOWN-CUSTOM-THEME-SETTINGS': {
+        level: 'error',
+        rule: 'An unkown custom theme setting has been used.',
+        fatal: false,
+        details: oneLineTrim`The custom theme setting should all be defined in the package.json <code>config.custom</code> object.`
+    },
+    'GS090-NO-UNKNOWN-CUSTOM-THEME-SELECT-VALUE-IN-MATCH': {
+        level: 'error',
+        rule: 'A custom theme setting of type <code>select</code> has been compared to a value that isn\'t defined.',
+        fatal: false,
+        details: oneLineTrim`Custom theme settings of type <code>select</code> can only be compared to their defined <code>options</code> when used in a <code>match</code> block.`
+    },
+    'GS100-NO-UNUSED-CUSTOM-THEME-SETTING': {
+        level: 'error',
+        rule: 'A custom theme setting defined in <code>package.json</code> hasn\'t been used in any theme file.',
+        details: oneLineTrim`Custom theme settings defined in <code>package.json</code> must be used at least once in the theme templates.`
+    },
+
+    'GS050-CSS-KGCO': cssCardRule('callout', 'kg-callout-card'),
+    'GS050-CSS-KGCOE': cssCardRule('callout', 'kg-callout-card-emoji'),
+    'GS050-CSS-KGCOT': cssCardRule('callout', 'kg-callout-card-text'),
+    'GS050-CSS-KGCOBGGY': cssCardRule('callout', 'kg-callout-card-background-grey'),
+    'GS050-CSS-KGCOBGW': cssCardRule('callout', 'kg-callout-card-background-white'),
+    'GS050-CSS-KGCOBGB': cssCardRule('callout', 'kg-callout-card-background-blue'),
+    'GS050-CSS-KGCOBGGN': cssCardRule('callout', 'kg-callout-card-background-green'),
+    'GS050-CSS-KGCOBGY': cssCardRule('callout', 'kg-callout-card-background-yellow'),
+    'GS050-CSS-KGCOBGR': cssCardRule('callout', 'kg-callout-card-background-red'),
+    'GS050-CSS-KGCOBGPK': cssCardRule('callout', 'kg-callout-card-background-pink'),
+    'GS050-CSS-KGCOBGPE': cssCardRule('callout', 'kg-callout-card-background-purple'),
+    'GS050-CSS-KGCOBGA': cssCardRule('callout', 'kg-callout-card-background-accent'),
+
+    'GS050-CSS-KG-NFT': cssCardRule('nft', 'kg-nft-card'),
+    'GS050-CSS-KG-NFTCO': cssCardRule('nft', 'kg-nft-card-container'),
+    'GS050-CSS-KG-NFTMD': cssCardRule('nft', 'kg-nft-metadata'),
+    'GS050-CSS-KG-NFTIMG': cssCardRule('nft', 'kg-nft-image'),
+    'GS050-CSS-KG-NFTHD': cssCardRule('nft', 'kg-nft-header'),
+    'GS050-CSS-KG-NFTTIT': cssCardRule('nft', 'kg-nft-title'),
+    'GS050-CSS-KG-NFTLG': cssCardRule('nft', 'kg-nft-logo'),
+    'GS050-CSS-KG-NFTCTR': cssCardRule('nft', 'kg-nft-creator'),
+    'GS050-CSS-KG-NFTDSC': cssCardRule('nft', 'kg-nft-description'),
+
+    'GS050-CSS-KGTGL': cssCardRule('toggle', 'kg-toggle-card'),
+    'GS050-CSS-KGTGLH': cssCardRule('toggle', 'kg-toggle-heading'),
+    'GS050-CSS-KGTGLHT': cssCardRule('toggle', 'kg-toggle-heading-text'),
+    'GS050-CSS-KGTGLIC': cssCardRule('toggle', 'kg-toggle-card-icon'),
+    'GS050-CSS-KGTGLC': cssCardRule('toggle', 'kg-toggle-content'),
+
+    'GS050-CSS-KGAUD': cssCardRule('audio', 'kg-audio-card'),
+    'GS050-CSS-KGAUDTHUMB': cssCardRule('audio', 'kg-audio-thumbnail'),
+    'GS050-CSS-KGAUDTHUMBPL': cssCardRule('audio', 'kg-audio-thumbnail.placeholder'),
+    'GS050-CSS-KGAUDPLCNT': cssCardRule('audio', 'kg-audio-player-container'),
+    'GS050-CSS-KGAUDTI': cssCardRule('audio', 'kg-audio-title'),
+    'GS050-CSS-KGAUDPL': cssCardRule('audio', 'kg-audio-player'),
+    'GS050-CSS-KGAUDCURRTM': cssCardRule('audio', 'kg-audio-current-time'),
+    'GS050-CSS-KGAUDTM': cssCardRule('audio', 'kg-audio-time'),
+    'GS050-CSS-KGAUDDUR': cssCardRule('audio', 'kg-audio-duration'),
+    'GS050-CSS-KGAUDPLICO': cssCardRule('audio', 'kg-audio-play-icon'),
+    'GS050-CSS-KGAUDPAUICO': cssCardRule('audio', 'kg-audio-pause-icon'),
+    'GS050-CSS-KGAUDSKSL': cssCardRule('audio', 'kg-audio-seek-slider'),
+    'GS050-CSS-KGAUDPLRT': cssCardRule('audio', 'kg-audio-playback-rate'),
+    'GS050-CSS-KGAUDMTICO': cssCardRule('audio', 'kg-audio-mute-icon'),
+    'GS050-CSS-KGAUDUNMTICO': cssCardRule('audio', 'kg-audio-unmute-icon'),
+    'GS050-CSS-KGAUDVOLSL': cssCardRule('audio', 'kg-audio-volume-slider'),
+
+    'GS050-CSS-KGVID': cssCardRule('video', 'kg-video-card'),
+    'GS050-CSS-KGVIDHD': cssCardRule('video', 'kg-video-hide'),
+    'GS050-CSS-KGVIDCNT': cssCardRule('video', 'kg-video-container'),
+    'GS050-CSS-KGVIDOVL': cssCardRule('video', 'kg-video-overlay'),
+    'GS050-CSS-KGVIDLGPLICO': cssCardRule('video', 'kg-video-large-play-icon'),
+    'GS050-CSS-KGVIDTHUMB': cssCardRule('video', 'kg-video-thumbnail'),
+    'GS050-CSS-KGVIDTHUMBPL': cssCardRule('video', 'kg-video-thumbnail.placeholder'),
+    'GS050-CSS-KGVIDPLCNT': cssCardRule('video', 'kg-video-player-container'),
+    'GS050-CSS-KGVIDTI': cssCardRule('video', 'kg-video-title'),
+    'GS050-CSS-KGVIDPL': cssCardRule('video', 'kg-video-player'),
+    'GS050-CSS-KGVIDCURRTM': cssCardRule('video', 'kg-video-current-time'),
+    'GS050-CSS-KGVIDTM': cssCardRule('video', 'kg-video-time'),
+    'GS050-CSS-KGVIDDUR': cssCardRule('video', 'kg-video-duration'),
+    'GS050-CSS-KGVIDPLICO': cssCardRule('video', 'kg-video-play-icon'),
+    'GS050-CSS-KGVIDPAUICO': cssCardRule('video', 'kg-video-pause-icon'),
+    'GS050-CSS-KGVIDSKSL': cssCardRule('video', 'kg-video-seek-slider'),
+    'GS050-CSS-KGVIDPLRT': cssCardRule('video', 'kg-video-playback-rate'),
+    'GS050-CSS-KGVIDMTICO': cssCardRule('video', 'kg-video-mute-icon'),
+    'GS050-CSS-KGVIDUNMTICO': cssCardRule('video', 'kg-video-unmute-icon'),
+    'GS050-CSS-KGVIDVOLSL': cssCardRule('video', 'kg-video-volume-slider'),
+
+    'GS050-CSS-KGBTN': cssCardRule('button', 'kg-button-card'),
+    'GS050-CSS-KGBTNL': cssCardRule('button', 'kg-button-card.kg-align-left'),
+    'GS050-CSS-KGBTNC': cssCardRule('button', 'kg-button-card.kg-align-center'),
+    'GS050-CSS-KGBTNBTN': cssCardRule('button', 'kg-btn'),
+    'GS050-CSS-KGBTNBTNA': cssCardRule('button', 'kg-btn-accent'),
+
+    'GS050-CSS-KGPR': cssCardRule('product', 'kg-product-card'),
+    'GS050-CSS-KGPRBTNA': cssCardRule('product', 'kg-product-card-btn-accent'),
+    'GS050-CSS-KGPRBTN': cssCardRule('product', 'kg-product-card-button'),
+    'GS050-CSS-KGPRCO': cssCardRule('product', 'kg-product-card-container'),
+    'GS050-CSS-KGPRDE': cssCardRule('product', 'kg-product-card-description'),
+    'GS050-CSS-KGPRIM': cssCardRule('product', 'kg-product-card-image'),
+    'GS050-CSS-KGPRRA': cssCardRule('product', 'kg-product-card-rating'),
+    'GS050-CSS-KGPRRAA': cssCardRule('product', 'kg-product-card-rating-active'),
+    'GS050-CSS-KGPRRAS': cssCardRule('product', 'kg-product-card-rating-star'),
+    'GS050-CSS-KGPRTI': cssCardRule('product', 'kg-product-card-title'),
+    'GS050-CSS-KGPRTICO': cssCardRule('product', 'kg-product-card-title-container'),
+
+    'GS050-CSS-KGBA': cssCardRule('before-after', 'kg-before-after-card'),
+    'GS050-CSS-KGBAIA': cssCardRule('before-after', 'kg-before-after-card-image-before'),
+    'GS050-CSS-KGBAIB': cssCardRule('before-after', 'kg-before-after-card-image-after'),
+
+    'GS050-CSS-KGFL': cssCardRule('file', 'kg-file-card'),
+    'GS050-CSS-KGFLCON': cssCardRule('file', 'kg-file-card-container'),
+    'GS050-CSS-KGFLCNT': cssCardRule('file', 'kg-file-card-contents'),
+    'GS050-CSS-KGFLTTL': cssCardRule('file', 'kg-file-card-title'),
+    'GS050-CSS-KGFLCAP': cssCardRule('file', 'kg-file-card-caption'),
+    'GS050-CSS-KGFLNM': cssCardRule('file', 'kg-file-card-filename'),
+    'GS050-CSS-KGFLSZ': cssCardRule('file', 'kg-file-card-filesize'),
+    'GS050-CSS-KGFLMD': cssCardRule('file', 'kg-file-card-medium'),
+    'GS050-CSS-KGFLSM': cssCardRule('file', 'kg-file-card-small'),
+
+    'GS050-CSS-KGBQALT': cssCardRule('blockquote', 'kg-blockquote-alt')
+};
+
+knownHelpers = _.union(previousKnownHelpers, knownHelpers);
+templates = _.union(previousTemplates, templates);
+
+// Merge the previous rules into the new rules, but overwrite any specified property,
+// as well as adding any new rule to the spec.
+// Furthermore, replace the usage of the old doc URLs that we're linking to, with the
+// new version.
+rules = _.each(_.merge({}, previousRules, rules), function replaceDocsUrl(value) {
+    value.details = value.details.replace(prevDocsBaseUrlRegEx, docsBaseUrl);
+});
+
+module.exports = {
+    knownHelpers: knownHelpers,
+    templates: templates,
+    rules: rules
+};

package/lib/utils/index.js

@@ -2,7 +2,7 @@
  * Makes sure the paths are forward-slash-separated `/`
  * This is needed because the partial are only referenced with forward-slashes
  * in Handlebars templates.
- * @param {string} path filesytem path
+ * @param {string} path filesystem path
  * @returns {string} the linux-normalized path
  */
 function normalizePath(path) {

package/lib/utils/versions.json

@@ -11,9 +11,13 @@
     "major": "3.x",
     "docs": "3.0.0"
   },
-  "canary": {
+  "v4": {
     "major": "4.x",
     "docs": "4.0.0"
   },
-  "default": "canary"
+  "canary": {
+    "major": "5.x",
+    "docs": "5.0.0"
+  },
+  "default": "v4"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gscan",
-  "version": "4.22.0",
+  "version": "4.23.0",
   "description": "Scans Ghost themes looking for errors, deprecations, features and compatibility",
   "keywords": [
     "ghost",
@@ -29,31 +29,31 @@
   "scripts": {
     "start": "node app/index.js",
     "dev": "NODE_ENV=development DEBUG=gscan:* nodemon",
-    "lint": "eslint . --ext .js --cache",
+    "lint": "eslint ./app --ext .js --cache",
     "test": "NODE_ENV=testing mocha -- $(find test -name '*.test.js')",
     "posttest": "yarn lint",
     "coverage": "NODE_ENV=testing istanbul cover --dir test/coverage _mocha -- $(find test -name '*.test.js')",
     "preship": "yarn test",
-    "ship": "STATUS=$(git status --porcelain); echo $STATUS; if [ -z \"$STATUS\" ]; then yarn publish && git push ${GHOST_UPSTREAM:-upstream} main --follow-tags; fi"
+    "ship": "yarn publish && git push ${GHOST_UPSTREAM:-upstream} main --follow-tags"
   },
   "bin": {
     "gscan": "./bin/cli.js"
   },
   "dependencies": {
-    "@sentry/node": "6.16.1",
+    "@sentry/node": "6.18.2",
     "@tryghost/config": "0.2.2",
-    "@tryghost/debug": "0.1.10",
+    "@tryghost/debug": "0.1.11",
     "@tryghost/ignition-errors": "0.1.8",
-    "@tryghost/logging": "2.0.1",
-    "@tryghost/pretty-cli": "1.2.22",
+    "@tryghost/logging": "2.0.4",
+    "@tryghost/pretty-cli": "1.2.24",
     "@tryghost/server": "0.1.4",
-    "@tryghost/zip": "1.1.18",
+    "@tryghost/zip": "1.1.20",
     "bluebird": "3.7.2",
     "chalk": "4.1.2",
     "common-tags": "1.8.2",
-    "express": "4.17.2",
+    "express": "4.17.3",
     "express-hbs": "2.4.0",
-    "fs-extra": "9.1.0",
+    "fs-extra": "10.0.1",
     "glob": "7.2.0",
     "lodash": "4.17.21",
     "multer": "1.4.4",
@@ -71,7 +71,7 @@
     "nodemon": "2.0.7",
     "rewire": "6.0.0",
     "should": "13.2.3",
-    "sinon": "12.0.0"
+    "sinon": "13.0.0"
   },
   "files": [
     "lib",