gscan 4.26.0 → 4.28.0

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

@@ -6,6 +6,8 @@ module.exports = {
     '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'),
+    'GS090-NO-MEMBER-PRODUCTS-DATA-HELPER': require('./lint-no-member-products-data-helper'),
+    'GS090-NO-PRICE-DATA-HELPER': require('./lint-no-price-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-member-products-data-helper.js

@@ -0,0 +1,24 @@
+const Rule = require('./base');
+const {getNodeName, logNode} = require('../helpers');
+
+module.exports = class NoMemberProductsHelper extends Rule {
+    _checkForHelperName(node) {
+        const nodeName = getNodeName(node);
+        const isMatchingHelper = (nodeName === '@member.products');
+
+        if (isMatchingHelper) {
+            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._checkForHelperName.bind(this)
+        };
+    }
+};

package/lib/ast-linter/rules/lint-no-price-data-helper.js

@@ -0,0 +1,24 @@
+const Rule = require('./base');
+const {getNodeName, logNode} = require('../helpers');
+
+module.exports = class NoPriceDataHelper extends Rule {
+    _checkForHelperName(node) {
+        const nodeName = getNodeName(node);
+        const isMatchingHelper = (nodeName.startsWith('@price.'));
+
+        if (isMatchingHelper) {
+            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._checkForHelperName.bind(this)
+        };
+    }
+};

package/lib/ast-linter/rules/lint-no-product-data-helper.js

@@ -2,7 +2,7 @@ const Rule = require('./base');
 const {getNodeName, logNode} = require('../helpers');
 
 module.exports = class NoProductsHelper extends Rule {
-    _checkForHelerInPostContext(node) {
+    _checkForHelperName(node) {
         const nodeName = getNodeName(node);
         const isProductsHelper = (nodeName === '@product');
 
@@ -18,7 +18,7 @@ module.exports = class NoProductsHelper extends Rule {
 
     visitor() {
         return {
-            MustacheStatement: this._checkForHelerInPostContext.bind(this)
+            MustacheStatement: this._checkForHelperName.bind(this)
         };
     }
 };

package/lib/ast-linter/rules/lint-no-products-data-helper.js

@@ -2,7 +2,7 @@ const Rule = require('./base');
 const {getNodeName, logNode} = require('../helpers');
 
 module.exports = class NoProductsHelper extends Rule {
-    _checkForHelerInPostContext(node) {
+    _checkForHelperName(node) {
         const nodeName = getNodeName(node);
         const isProductsHelper = (nodeName === '@products');
 
@@ -18,7 +18,7 @@ module.exports = class NoProductsHelper extends Rule {
 
     visitor() {
         return {
-            MustacheStatement: this._checkForHelerInPostContext.bind(this)
+            MustacheStatement: this._checkForHelperName.bind(this)
         };
     }
 };

package/lib/ast-linter/rules/lint-no-products-helper.js

@@ -2,7 +2,7 @@ const Rule = require('./base');
 const {getNodeName, logNode} = require('../helpers');
 
 module.exports = class NoProductsHelper extends Rule {
-    _checkForHelerInPostContext(node) {
+    _checkForHelperName(node) {
         const nodeName = getNodeName(node);
         const isProductsHelper = (nodeName === 'products');
 
@@ -18,7 +18,7 @@ module.exports = class NoProductsHelper extends Rule {
 
     visitor() {
         return {
-            MustacheStatement: this._checkForHelerInPostContext.bind(this)
+            MustacheStatement: this._checkForHelperName.bind(this)
         };
     }
 };

package/lib/specs/canary.js

@@ -58,6 +58,23 @@ let rules = {
         Find more information about the <code>{{#get "tiers"}}</code> property <a href="${docsBaseUrl}helpers/tiers/" target=_blank>here</a>.`,
         helper: '{{@products}}'
     },
+    'GS090-NO-MEMBER-PRODUCTS-DATA-HELPER': {
+        level: 'error',
+        rule: 'The <code>{{@member.products}}</code> helper should be replaces with <code>{{@member.subscriptions}}</code>',
+        details: oneLineTrim`The <code>{{@member.products}}</code> helper has been deprecated in favor of <code>{{@member.subscriptions}}</code><br>
+        The <code>{{@member.products}}</code> helper was removed in Ghost v5 and should not be used.
+        Find more information about the <code>{{@member.subscriptions}}</code> property <a href="${docsBaseUrl}members/#member-subscriptions" target=_blank>here</a>.`,
+        helper: '{{@member.products}}'
+    },
+    'GS090-NO-PRICE-DATA-HELPER': {
+        level: 'error',
+        fatal: true,
+        rule: 'The <code>{{@price}}</code> data helper should be replaces with <code>{{price}}</code> and <code>{{@member.subscriptions}}</code>',
+        details: oneLineTrim`The <code>{{@price}}</code> data helper has been deprecated in favor of <code>{{price}}</code> and <code>{{@member.subscriptions}}</code><br>
+        The <code>{{@price}}</code> helper was removed in Ghost v5 and should not be used.
+        Find more information about the <code>{{price}}</code> helper <a href="${docsBaseUrl}members/#the-price-helper" target=_blank>here</a>.`,
+        helper: '{{@price}}'
+    },
 
     // Updated v1 & v2 rules
     'GS001-DEPR-BLOG': {
@@ -545,6 +562,15 @@ let rules = {
         regex: /{{\s*?#if\s*?post\.author\.image\s*?}}/g,
         helper: '{{#if post.author.image}}'
     },
+    'GS001-DEPR-LABS-MEMBERS': {
+        level: 'error',
+        rule: 'Replace the <code>{{@labs.members}}</code> helper with <code>{{@site.members_enabled}}</code>',
+        details: oneLineTrim`The <code>{{@labs.members}}</code> helper was replaced with <code>{{@site.members_enabled}}</code><br>
+        The <code>{{@labs.members}}</code> helper will always 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}}'
+    },
     'GS001-DEPR-SPL': {
         level: 'error',
         fatal: true,
@@ -597,7 +623,7 @@ let rules = {
     },
     'GS001-DEPR-SITE-LANG': {
         level: 'error',
-        fatal: true,
+        fatal: false,
         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 is removed in v5 version of Ghost and should not be used.
@@ -613,6 +639,25 @@ let rules = {
         Find more information about the <code>{{get}}</code> helper <a href="${docsBaseUrl}helpers/get/" target=_blank>here</a>.`,
         regex: /{{\s*?#get ("|')\s*users("|')\s*/g,
         helper: '{{#get "users"}}'
+    },
+    'GS001-DEPR-ESC': {
+        level: 'error',
+        fatal: true,
+        rule: 'Replace <code>{{error.code}}</code> with <code>{{error.statusCode}}</code>',
+        details: oneLineTrim`The usage of <code>{{error.code}}</code> is deprecated and should be replaced with <code>{{error.statusCode}}</code>.<br>
+        When in <code>error</code> context, e. g. in the <code>error.hbs</code> template, replace <code>{{code}}</code> with <code>{{statusCode}}</code>.<br>
+        Find more information about the <code>error.hbs</code> template <a href="${docsBaseUrl}structure/#errorhbs" target=_blank>here</a>.`,
+        regex: /{{\s*?(?:error\.)?(code)\s*?}}/g,
+        helper: '{{error.code}}'
+    },
+    'GS001-DEPR-CURR-SYM': {
+        level: 'error',
+        fatal: true,
+        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
     }
 };
 
@@ -623,6 +668,8 @@ templates = _.union(previousTemplates, templates);
 // 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.
+delete previousRules['GS010-PJ-GHOST-API-V01'];
+
 rules = _.each(_.merge({}, previousRules, rules), function replaceDocsUrl(value) {
     value.details = value.details.replace(prevDocsBaseUrlRegEx, docsBaseUrl);
 });

package/lib/specs/v4.js

@@ -24,7 +24,7 @@ function cssCardRule(cardName, className) {
 }
 
 // assign new or overwrite existing knownHelpers, templates, or rules here:
-let knownHelpers = ['match'];
+let knownHelpers = ['match', 'tiers'];
 let templates = [];
 let rules = {
     // New rules

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gscan",
-  "version": "4.26.0",
+  "version": "4.28.0",
   "description": "Scans Ghost themes looking for errors, deprecations, features and compatibility",
   "keywords": [
     "ghost",
@@ -14,7 +14,7 @@
     "url": "git@github.com:TryGhost/gscan.git"
   },
   "engines": {
-    "node": "^12.22.1 || ^14.17.0 || ^16.13.0"
+    "node": "^14.17.0 || ^16.13.0"
   },
   "bugs": {
     "url": "https://github.com/TryGhost/gscan/issues"
@@ -40,26 +40,26 @@
     "gscan": "./bin/cli.js"
   },
   "dependencies": {
-    "@sentry/node": "6.19.3",
+    "@sentry/node": "6.19.7",
     "@tryghost/config": "0.2.2",
     "@tryghost/debug": "0.1.11",
-    "@tryghost/errors": "1.2.7",
-    "@tryghost/logging": "2.1.1",
-    "@tryghost/pretty-cli": "1.2.24",
+    "@tryghost/errors": "1.2.12",
+    "@tryghost/logging": "2.1.8",
+    "@tryghost/pretty-cli": "1.2.27",
     "@tryghost/server": "0.1.4",
-    "@tryghost/zip": "1.1.22",
+    "@tryghost/zip": "1.1.25",
     "bluebird": "3.7.2",
     "chalk": "4.1.2",
     "common-tags": "1.8.2",
-    "express": "4.17.3",
+    "express": "4.18.1",
     "express-hbs": "2.4.0",
-    "fs-extra": "10.0.1",
-    "glob": "7.2.0",
+    "fs-extra": "10.1.0",
+    "glob": "7.2.2",
     "lodash": "4.17.21",
     "multer": "1.4.4",
     "pluralize": "8.0.0",
     "require-dir": "1.2.0",
-    "semver": "7.3.5",
+    "semver": "7.3.7",
     "uuid": "8.3.2",
     "validator": "13.0.0"
   },
@@ -67,11 +67,11 @@
     "eslint": "8.1.0",
     "eslint-plugin-ghost": "2.1.0",
     "istanbul": "0.4.5",
-    "mocha": "9.0.2",
+    "mocha": "10.0.0",
     "nodemon": "2.0.7",
     "rewire": "6.0.0",
     "should": "13.2.3",
-    "sinon": "13.0.0"
+    "sinon": "14.0.0"
   },
   "files": [
     "lib",