gscan 4.24.0 → 4.25.0

package/README.md

@@ -51,8 +51,8 @@ By default, GScan scans themes for the latest Ghost version compatibility. You c
 `--v1` or `-1`  
 `--v2` or `-2`  
 `--v3` or `-3`  
-`--v4` or `-4`
-`--v5` or `-5` or `--canary`
+`--v4` or `-4` or `--canary`
+`--v5` or `-5`  
 
 Use the `--canary` parameter to check for the upcoming Ghost version.
 

package/app/tpl/index.hbs

@@ -22,8 +22,8 @@
                 <span class="gh-input-icon select-arrow">{{> icon-arrow-up}}</span>
                 <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="v5">{{ghostVersions.v5.major}}</option>
+                    <option value="v4" selected>{{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/lib/ast-linter/rules/index.js

@@ -3,6 +3,9 @@ module.exports = {
     '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'),
+    'GS090-NO-PRODUCTS-HELPER': require('./lint-no-products-helper'),
+    'GS090-NO-PRODUCT-DATA-HELPER': require('./lint-no-product-data-helper'),
+    'GS090-NO-PRODUCTS-DATA-HELPER': require('./lint-no-products-data-helper'),
     '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/lint-no-product-data-helper.js

@@ -0,0 +1,24 @@
+const Rule = require('./base');
+const {getNodeName, logNode} = require('../helpers');
+
+module.exports = class NoProductsHelper extends Rule {
+    _checkForHelerInPostContext(node) {
+        const nodeName = getNodeName(node);
+        const isProductsHelper = (nodeName === '@product');
+
+        if (isProductsHelper) {
+            this.log({
+                message: `${logNode(node)} should not be used`,
+                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/ast-linter/rules/lint-no-products-data-helper.js

@@ -0,0 +1,24 @@
+const Rule = require('./base');
+const {getNodeName, logNode} = require('../helpers');
+
+module.exports = class NoProductsHelper extends Rule {
+    _checkForHelerInPostContext(node) {
+        const nodeName = getNodeName(node);
+        const isProductsHelper = (nodeName === '@products');
+
+        if (isProductsHelper) {
+            this.log({
+                message: `${logNode(node)} should not be used`,
+                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/ast-linter/rules/lint-no-products-helper.js

@@ -0,0 +1,24 @@
+const Rule = require('./base');
+const {getNodeName, logNode} = require('../helpers');
+
+module.exports = class NoProductsHelper extends Rule {
+    _checkForHelerInPostContext(node) {
+        const nodeName = getNodeName(node);
+        const isProductsHelper = (nodeName === 'products');
+
+        if (isProductsHelper) {
+            this.log({
+                message: `${logNode(node)} should not be used`,
+                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,8 +27,9 @@ const check = function checkAll(themePath, options = {}) {
     const passedVersion = _.get(options, 'checkVersion', versions.default);
     let version = passedVersion;
 
-    if (passedVersion === 'v5') {
-        version = 'canary';
+    if (passedVersion === 'canary') {
+        version = 'v4';
+        options.checkVersion = 'v4';
     }
 
     _.each(labsEnabledHelpers, (flag, helper) => {

package/lib/specs/canary.js

@@ -3,7 +3,7 @@ const oneLineTrim = require('common-tags/lib/oneLineTrim');
 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.canary.docs}/docs/`;
+const prevDocsBaseUrl = `https://themes.ghost.org/v${ghostVersions.v5.docs}/docs/`;
 const prevDocsBaseUrlRegEx = new RegExp(prevDocsBaseUrl, 'g');
 
 const previousKnownHelpers = previousSpec.knownHelpers;
@@ -28,9 +28,36 @@ let rules = {
         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>.`,
+        Find more information about the <code>{{authors}}</code> property <a href="${docsBaseUrl}helpers/authors/" target=_blank>here</a>.`,
         helper: '{{author}}'
     },
+    'GS090-NO-PRODUCTS-HELPER': {
+        level: 'error',
+        fatal: true,
+        rule: 'The <code>{{products}}</code> helper should be replaces with <code>{{tiers}}</code>',
+        details: oneLineTrim`The <code>{{products}}</code> helper has been deprecated in favor of <code>{{tiers}}</code><br>
+        The <code>{{products}}</code> helper was removed in Ghost v5 and should not be used.
+        Find more information about the <code>{{tiers}}</code> property <a href="${docsBaseUrl}helpers/tiers/" target=_blank>here</a>.`,
+        helper: '{{products}}'
+    },
+    'GS090-NO-PRODUCT-DATA-HELPER': {
+        level: 'error',
+        fatal: true,
+        rule: 'The <code>{{@product}}</code> data helper should be replaces with <code>{{#get "tiers"}}</code>',
+        details: oneLineTrim`The <code>{{@product}}</code> data helper has been deprecated in favor of <code>{{#get "tiers"}}</code><br>
+        The <code>{{@product}}</code> data helper was removed in Ghost v5 and should not be used.
+        Find more information about the <code>{{#get "tiers"}}</code> property <a href="${docsBaseUrl}helpers/tiers/" target=_blank>here</a>.`,
+        helper: '{{@product}}'
+    },
+    'GS090-NO-PRODUCTS-DATA-HELPER': {
+        level: 'error',
+        fatal: true,
+        rule: 'The <code>{{@products}}</code> data helper should be replaces with <code>{{#get "tiers"}}</code>',
+        details: oneLineTrim`The <code>{{@products}}</code> data helper has been deprecated in favor of <code>{{#get "tiers"}}</code><br>
+        The <code>{{@products}}</code> data helper was removed in Ghost v5 and should not be used.
+        Find more information about the <code>{{#get "tiers"}}</code> property <a href="${docsBaseUrl}helpers/tiers/" target=_blank>here</a>.`,
+        helper: '{{@products}}'
+    },
 
     // Updated v1 & v2 rules
     'GS001-DEPR-BLOG': {

package/lib/specs/v4.js

@@ -180,6 +180,31 @@ let rules = {
         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.`
     },
+    'GS090-NO-PRODUCTS-HELPER': {
+        level: 'warning',
+        rule: 'The <code>{{products}}</code> helper should be replaces with <code>{{tiers}}</code>',
+        details: oneLineTrim`The <code>{{products}}</code> helper has been deprecated in favor of <code>{{tiers}}</code><br>
+        The <code>{{products}}</code> helper will be removed in Ghost v5 and should not be used.
+        Find more information about the <code>{{tiers}}</code> property <a href="${docsBaseUrl}helpers/tiers/" target=_blank>here</a>.`,
+        helper: '{{products}}'
+    },
+    'GS090-NO-PRODUCT-DATA-HELPER': {
+        level: 'warning',
+        rule: 'The <code>{{@product}}</code> data helper should be replaces with <code>{{#get "tiers"}}</code>',
+        details: oneLineTrim`The <code>{{@product}}</code> data helper has been deprecated in favor of <code>{{#get "tiers"}}</code><br>
+        The <code>{{@product}}</code> data helper was removed in Ghost v5 and should not be used.
+        Find more information about the <code>{{#get "tiers"}}</code> property <a href="${docsBaseUrl}helpers/tiers/" target=_blank>here</a>.`,
+        helper: '{{@product}}'
+    },
+    'GS090-NO-PRODUCTS-DATA-HELPER': {
+        level: 'warning',
+        rule: 'The <code>{{@products}}</code> data helper should be replaces with <code>{{#get "tiers"}}</code>',
+        details: oneLineTrim`The <code>{{@products}}</code> data helper has been deprecated in favor of <code>{{#get "tiers"}}</code><br>
+        The <code>{{@products}}</code> data helper was removed in Ghost v5 and should not be used.
+        Find more information about the <code>{{#get "tiers"}}</code> property <a href="${docsBaseUrl}helpers/tiers/" target=_blank>here</a>.`,
+        helper: '{{@products}}'
+    },
+
     '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.',

package/lib/utils/versions.json

@@ -15,7 +15,7 @@
     "major": "4.x",
     "docs": "4.0.0"
   },
-  "canary": {
+  "v5": {
     "major": "5.x",
     "docs": "5.0.0"
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gscan",
-  "version": "4.24.0",
+  "version": "4.25.0",
   "description": "Scans Ghost themes looking for errors, deprecations, features and compatibility",
   "keywords": [
     "ghost",
@@ -40,11 +40,11 @@
     "gscan": "./bin/cli.js"
   },
   "dependencies": {
-    "@sentry/node": "6.19.1",
+    "@sentry/node": "6.19.2",
     "@tryghost/config": "0.2.2",
     "@tryghost/debug": "0.1.11",
     "@tryghost/ignition-errors": "0.1.8",
-    "@tryghost/logging": "2.0.4",
+    "@tryghost/logging": "2.1.0",
     "@tryghost/pretty-cli": "1.2.24",
     "@tryghost/server": "0.1.4",
     "@tryghost/zip": "1.1.20",