gscan 4.41.0 → 4.42.1

package/README.md

@@ -10,29 +10,26 @@ It is actively capable of dealing with the current and last major versions of Gh
 
 GScan works on a system of rules. Each rule has a way to check whether it passes or fails and has help content which describes how to fix it. Each rule is also marked with an error level:
 
-- **recommendation** = these are things the dev might want to know about
-- **warning** = usually used for deprecations, things that will be errors in the next version
-- **error** = anything that makes the theme invalid or incompatible with the current version of Ghost
+- Errors: issues that will cause your theme to not work properly. These must be fixed.
+- Warnings: these are usually related to deprecated features. These should be fixed.
+- Recommendations: these are advisories about best practice. Fixing these will improve your theme.
+- Features: detected features which may impact on compatibility. Nothing to do!
 
 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 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 marked as **fatal errors** if they would cause errors, and therefore should block a boot or an upgrade.
+## Usage
 
-### Tooling
-When developing new rules or testing gscan following tools are great to have in the toolbelt:
-- [astexplorer](https://astexplorer.net) - absolutely awesome Handlebars AST fiddler, helpful when testing out new ideas and exploring what's possible through AST parser;
+There are 4 ways to use gscan to validate your theme:
 
-## Usage
+### 1. Inside Ghost
 
-There are 3 ways to use gscan to validate your theme:
+Gscan is pre-installed in Ghost. If there are theme errors, Ghost will show them on boot in the console logs and in the UI (Ghost Admin).
 
-### 1. Web usage
+### 2. Web usage
 
 Visit https://gscan.ghost.org and upload your zip to our online version of Gscan.
 
-### 2. CLI usage
+### 3. CLI usage
 
 Install using yarn / npm:
 
@@ -48,21 +45,21 @@ To run a local zip file through the checks:
 
 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`  
+`--v1` or `-1`
+`--v2` or `-2`
+`--v3` or `-3`
 `--v4` or `-4` or `--canary`
-`--v5` or `-5`  
+`--v5` or `-5`
 
 Use the `--canary` parameter to check for the upcoming Ghost version.
 
 Examples:
 
-`gscan /path/to/theme.zip -z1` - scan a theme in a zip file for Ghost 1.0 compatibility  
-`gscan /path/to/theme/directory --v2` - can a theme in a directory for Ghost 2.0 compatibility  
-`gscan /path/to/theme/directory --canary` - scan a theme for the upcoming version of Ghost  
+`gscan /path/to/theme.zip -z1` - scan a theme in a zip file for Ghost 1.0 compatibility
+`gscan /path/to/theme/directory --v2` - can a theme in a directory for Ghost 2.0 compatibility
+`gscan /path/to/theme/directory --canary` - scan a theme for the upcoming version of Ghost
 
-### 3. Lib usage
+### 4. Lib usage
 
 Install using yarn/npm and then:
 
@@ -98,14 +95,11 @@ gscan.checkZip({
 
 - `yarn ship`
 
-## Result types:
-
-- Errors: these are issues which will cause your theme to not work properly. These must be fixed.
-- Warnings: these are usually related to deprecated features. These should be fixed.
-- Recommendations: these are advisories about best practice. Fixing these will improve your theme.
-- Features: detected features which may impact on compatibility. Nothing to do :)
+### Tools
+When developing new rules or testing gscan following tools are great to have in the toolbelt:
+- [astexplorer](https://astexplorer.net) - absolutely awesome Handlebars AST fiddler, helpful when testing out new ideas and exploring what's possible through AST parser;
 
-## Still To Do:
+## To Do
 
 - Support for running the checks against a GitHub repository
 - Many, many more checks

package/lib/ast-linter/rules/mark-used-partials.js

@@ -1,5 +1,6 @@
 const Rule = require('./base');
 const {getPartialName} = require('../helpers');
+const {normalizePath} = require('../../utils');
 
 module.exports = class MarkUsedPartials extends Rule {
     _markUsedPartials(node) {
@@ -8,6 +9,7 @@ module.exports = class MarkUsedPartials extends Rule {
         if (nodeName) {
             this.scanner.context.partials.push({
                 node: nodeName,
+                normalizedName: normalizePath(nodeName),
                 type: node.type,
                 loc: node.loc,
                 parameters: node.params ? node.params.map(p => p.original) : null

package/lib/checker.js

@@ -22,7 +22,7 @@ const labsEnabledHelpers = {
  * @param {Object=} [options.labs] object containing boolean flags for enabled labs features
  * @returns {Promise<Object>}
  */
-const check = function checkAll(themePath, options = {}) {
+const check = async function checkAll(themePath, options = {}) {
     // Require checks late to avoid loading all until used
     const checks = requireDir('./checks');
     const passedVersion = _.get(options, 'checkVersion', versions.default);
@@ -44,27 +44,33 @@ const check = function checkAll(themePath, options = {}) {
 
     // Require readTheme late to avoid loading entire AST parser until used
     const readTheme = require('./read-theme');
-    return readTheme(themePath)
-        .then(function (theme) {
-            // set the major version to check
-            theme.checkedVersion = versions[version].major;
-
-            return Promise.all(_.values(checks).map(async (checkFunction) => {
-                const now = Date.now();
-                const result = await checkFunction(theme, options, themePath);
-                debug(checkFunction.name, 'took', Date.now() - now, 'ms');
-                return result;
-            })).then(() => theme);
-        })
-        .catch((error) => {
-            throw new errors.ValidationError({
-                message: 'Failed theme files check',
-                help: 'Your theme file structure is corrupted or contains errors',
-                errorDetails: error.message,
-                context: options.themeName,
-                err: error
-            });
+
+    try {
+        const theme = await readTheme(themePath);
+
+        // set the major version to check
+        theme.checkedVersion = versions[version].major;
+
+        const timeBeforeChecks = Date.now();
+
+        for (const checkName in checks) {
+            const now = Date.now();
+            await checks[checkName](theme, options, themePath);
+            debug(checkName, 'took', Date.now() - now, 'ms');
+        }
+
+        debug('All checks took', Date.now() - timeBeforeChecks, 'ms');
+
+        return theme;
+    } catch (err) {
+        throw new errors.ValidationError({
+            message: 'Failed theme files check',
+            help: 'Your theme file structure is corrupted or contains errors',
+            errorDetails: err.message,
+            context: options.themeName,
+            err
         });
+    }
 };
 
 const checkZip = async function checkZip(path, options) {

package/lib/checks/005-template-compile.js

@@ -2,7 +2,6 @@ const _ = require('lodash');
 const spec = require('../specs');
 const versions = require('../utils').versions;
 const ASTLinter = require('../ast-linter');
-const {normalizePath} = require('../utils');
 
 function processFileFunction(files, failures, theme, partialsFound) {
     const processedFiles = [];
@@ -61,7 +60,8 @@ function processFileFunction(files, failures, theme, partialsFound) {
         linter.partials.forEach((partial) => {
             const partialName = partial.node;
             partialsFound[partialName] = true;
-            const file = files.find(f => normalizePath(f.file) === `partials/${normalizePath(partialName)}.hbs`);
+
+            const file = files.find(f => f.normalizedFile === `partials/${partial.normalizedName}.hbs`);
             if (file) {
                 // Find all inline partial declaration that were within the partial usage block
                 const childrenInlinePartials = [...parentInlinePartials];

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

@@ -1,6 +1,6 @@
 const _ = require('lodash');
 const spec = require('../specs');
-const {versions, normalizePath, getPackageJSON} = require('../utils');
+const {versions, getPackageJSON} = require('../utils');
 const ASTLinter = require('../ast-linter');
 
 function processFileFunction(files, failures, rules) {
@@ -30,8 +30,8 @@ function processFileFunction(files, failures, rules) {
             });
         }
 
-        linter.partials.forEach(({node: partial}) => {
-            const file = files.find(f => normalizePath(f.file) === `partials/${normalizePath(partial)}.hbs`);
+        linter.partials.forEach(({normalizedName}) => {
+            const file = files.find(f => f.normalizedFile === `partials/${normalizedName}.hbs`);
             if (file) {
                 processFile(linter, file);
             }

package/lib/checks/100-custom-template-settings-usage.js

@@ -1,6 +1,6 @@
 const _ = require('lodash');
 const spec = require('../specs');
-const {versions, normalizePath} = require('../utils');
+const {versions} = require('../utils');
 const ASTLinter = require('../ast-linter');
 
 function getRules(id, options) {
@@ -103,8 +103,8 @@ function parseWithAST({theme, log, file, rules, callback}){
             callback(linter);
         }
 
-        linter.partials.forEach(({node: partial}) => {
-            const partialFile = theme.files.find(f => normalizePath(f.file) === `partials/${normalizePath(partial)}.hbs`);
+        linter.partials.forEach(({normalizedName}) => {
+            const partialFile = theme.files.find(f => f.normalizedFile === `partials/${normalizedName}.hbs`);
             if (partialFile) {
                 processFile(partialFile);
             }

package/lib/checks/110-page-builder-usage.js

@@ -1,6 +1,6 @@
 const _ = require('lodash');
 const spec = require('../specs');
-const {versions, normalizePath} = require('../utils');
+const {versions} = require('../utils');
 const ASTLinter = require('../ast-linter');
 
 function getRules(id, options) {
@@ -104,8 +104,8 @@ function parseWithAST({theme, log, file, rules, callback}) {
             callback(linter);
         }
 
-        linter.partials.forEach(({node: partial}) => {
-            const partialFile = theme.files.find(f => normalizePath(f.file) === `partials/${normalizePath(partial)}.hbs`);
+        linter.partials.forEach(({normalizedName}) => {
+            const partialFile = theme.files.find(f => f.normalizedFile === `partials/${normalizedName}.hbs`);
             if (partialFile) {
                 processFile(partialFile);
             }

package/lib/checks/120-no-unknown-globals.js

@@ -2,7 +2,6 @@ const _ = require('lodash');
 const spec = require('../specs');
 const versions = require('../utils').versions;
 const ASTLinter = require('../ast-linter');
-const {normalizePath} = require('../utils');
 
 function processFileFunction(files, failures, theme, partialsFound) {
     const processedFiles = [];
@@ -61,7 +60,7 @@ function processFileFunction(files, failures, theme, partialsFound) {
         linter.partials.forEach((partial) => {
             const partialName = partial.node;
             partialsFound[partialName] = true;
-            const file = files.find(f => normalizePath(f.file) === `partials/${normalizePath(partialName)}.hbs`);
+            const file = files.find(f => f.normalizedFile === `partials/${partial.normalizedName}.hbs`);
             if (file) {
                 // Find all inline partial declaration that were within the partial usage block
                 const childrenInlinePartials = [...parentInlinePartials];

package/lib/read-theme.js

@@ -3,6 +3,7 @@ const _ = require('lodash');
 const os = require('os');
 const path = require('path');
 const ASTLinter = require('./ast-linter');
+const {normalizePath} = require('./utils');
 
 const ignore = [
     'node_modules',
@@ -31,6 +32,7 @@ const readThemeStructure = function readThemeFiles(themePath, subPath, arr) {
     var makeResult = function makeResult(result, subFilePath, ext, symlink) {
         result.push({
             file: subFilePath,
+            normalizedFile: normalizePath(subFilePath),
             ext,
             symlink
         });

package/lib/specs/v4.js

@@ -54,7 +54,7 @@ let rules = {
     '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>
+        details: oneLineTrim`Remove key from <code>"config.custom"</code> in your <code>package.json</code> to have less than or exactly 20 settings.<br>
         Check the <a href="${docsBaseUrl}structure/#packagejson" target=_blank><code>package.json</code> documentation</a> for further information.`
     },
     'GS010-PJ-CUST-THEME-SETTINGS-CASE': {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gscan",
-  "version": "4.41.0",
+  "version": "4.42.1",
   "description": "Scans Ghost themes looking for errors, deprecations, features and compatibility",
   "keywords": [
     "ghost",
@@ -13,6 +13,9 @@
     "type": "git",
     "url": "git@github.com:TryGhost/gscan.git"
   },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
   "engines": {
     "node": "^14.18.0 || ^16.13.0 || ^18.12.1"
   },
@@ -80,5 +83,14 @@
     "lib",
     "bin",
     "app"
-  ]
+  ],
+  "renovate": {
+    "extends": [
+      "@tryghost:quietJS",
+      "@tryghost:automergeDevDependencies"
+    ],
+    "ignoreDeps": [
+      "validator"
+    ]
+  }
 }