gscan 4.37.5 → 4.38.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2022 Ghost Foundation
+Copyright (c) 2013-2023 Ghost Foundation
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

package/README.md

@@ -115,4 +115,4 @@ gscan.checkZip({
 
 # Copyright & License
 
-Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE). Ghost and the Ghost Logo are trademarks of Ghost Foundation Ltd. Please see our [trademark policy](https://ghost.org/trademark/) for info on acceptable usage.
+Copyright (c) 2013-2023 Ghost Foundation - Released under the [MIT license](LICENSE). Ghost and the Ghost Logo are trademarks of Ghost Foundation Ltd. Please see our [trademark policy](https://ghost.org/trademark/) for info on acceptable usage.

package/lib/checker.js

@@ -1,4 +1,3 @@
-const Promise = require('bluebird');
 const _ = require('lodash');
 const requireDir = require('require-dir');
 const debug = require('@tryghost/debug')('checker');
@@ -50,12 +49,12 @@ const check = function checkAll(themePath, options = {}) {
             // set the major version to check
             theme.checkedVersion = versions[version].major;
 
-            return Promise.reduce(_.values(checks), async function (themeToCheck, checkFunction) {
+            return Promise.all(_.values(checks).map(async (checkFunction) => {
                 const now = Date.now();
-                const result = await checkFunction(themeToCheck, options, themePath);
+                const result = await checkFunction(theme, options, themePath);
                 debug(checkFunction.name, 'took', Date.now() - now, 'ms');
                 return result;
-            }, theme);
+            })).then(() => theme);
         })
         .catch((error) => {
             throw new errors.ValidationError({

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

@@ -44,8 +44,8 @@ const v4PackageJSONValidationRules = _.extend({},
     {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'},
-    {unkownCustomThemeSettingsGroup: 'GS010-PJ-CUST-THEME-SETTINGS-GROUP'},
+    {unknownCustomThemeSettingsType: 'GS010-PJ-CUST-THEME-SETTINGS-TYPE'},
+    {unknownCustomThemeSettingsGroup: 'GS010-PJ-CUST-THEME-SETTINGS-GROUP'},
     {missingCustomThemeSettingsSelectOptions: 'GS010-PJ-CUST-THEME-SETTINGS-SELECT-OPTIONS'},
     {missingCustomThemeSettingsSelectDefault: 'GS010-PJ-CUST-THEME-SETTINGS-SELECT-DEFAULT'},
     {invalidCustomThemeSetingBooleanDefault: 'GS010-PJ-CUST-THEME-SETTINGS-BOOLEAN-DEFAULT'},
@@ -160,14 +160,14 @@ _private.validatePackageJSONFields = function validatePackageJSONFields(packageJ
 
         const knownSettingsTypes = new Set(['select', 'boolean', 'color', 'image', 'text']);
         if (customSettingsKeys.some(key => !knownSettingsTypes.has(packageJSON.config.custom[key].type))) {
-            markFailed('unkownCustomThemeSettingsType');
+            markFailed('unknownCustomThemeSettingsType');
         }
 
         const knownSettingsGroups = new Set(['post', 'homepage']);
         // Ignore undefined values as "groups" is an optional property
         if (customSettingsKeys.some(key => typeof packageJSON.config.custom[key].group !== 'undefined'
                 && !knownSettingsGroups.has(packageJSON.config.custom[key].group))) {
-            markFailed('unkownCustomThemeSettingsGroup');
+            markFailed('unknownCustomThemeSettingsGroup');
         }
 
         for (const key of customSettingsKeys) {

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

@@ -95,7 +95,8 @@ function parseWithAST({theme, log, file, rules, callback}) {
 
         if (astResults.length) {
             log.failure({
-                message: astResults[0].message
+                message: astResults[0].message,
+                ref: themeFile.file
             });
         }
 

package/lib/read-theme.js

@@ -1,5 +1,4 @@
 const fs = require('fs-extra');
-const Promise = require('bluebird');
 const _ = require('lodash');
 const os = require('os');
 const path = require('path');
@@ -39,35 +38,43 @@ const readThemeStructure = function readThemeFiles(themePath, subPath, arr) {
     };
 
     return fs.readdir(themePath, {withFileTypes: true}).then(function (files) {
-        return Promise.reduce(files, function (result, dirent) {
-            const file = dirent.name;
-            var extMatch = file.match(/.*?(\.[0-9a-z]+$)/i),
-                subFilePath = path.join(subPath, file),
-                newPath = path.join(themePath, file);
-
-            /**
-             * don't process ignored paths, remove target file
-             *
-             * @TODO:
-             * - gscan extracts the target zip into a tmp directory
-             * - if you use gscan with `keepExtractedDir` the caller (Ghost) will use the tmp folder with the deleted ignore files
-             * - what we don't support right now is to delete the ignore files from the zip
-             */
-            if (ignore.indexOf(file) > -1) {
-                return inTmp
-                    ? fs.remove(newPath)
-                        .then(function () {
-                            return result;
-                        })
-                    : result;
-            }
+        let result = arr;
+
+        return files.reduce(function (promise, dirent) {
+            return promise.then(function () {
+                const file = dirent.name;
+                const extMatch = file.match(/.*?(\.[0-9a-z]+$)/i);
+                const subFilePath = path.join(subPath, file);
+                const newPath = path.join(themePath, file);
+
+                /**
+                 * don't process ignored paths, remove target file
+                 *
+                 * @TODO:
+                 * - gscan extracts the target zip into a tmp directory
+                 * - if you use gscan with `keepExtractedDir` the caller (Ghost) will use the tmp folder with the deleted ignore files
+                 * - what we don't support right now is to delete the ignore files from the zip
+                 */
+                if (ignore.indexOf(file) > -1) {
+                    return inTmp
+                        ? fs.remove(newPath)
+                            .then(function () {
+                                return result;
+                            })
+                        : Promise.resolve(result);
+                }
 
-            if (dirent.isDirectory()) {
-                return readThemeStructure(newPath, subFilePath, result);
-            } else {
-                return makeResult(result, subFilePath, extMatch !== null ? extMatch[1] : undefined, dirent.isSymbolicLink());
-            }
-        }, arr);
+                if (dirent.isDirectory()) {
+                    return readThemeStructure(newPath, subFilePath, result)
+                        .then((updatedResult) => {
+                            result = updatedResult;
+                        });
+                } else {
+                    result = makeResult(result, subFilePath, extMatch !== null ? extMatch[1] : undefined, dirent.isSymbolicLink());
+                    return Promise.resolve();
+                }
+            });
+        }, Promise.resolve()).then(() => result);
     });
 };
 
@@ -89,9 +96,8 @@ const readFiles = function readFiles(theme) {
     // Setup the helper object
     theme.helpers = {};
 
-    // CASE: we need the actual content of all css, hbs files, and package.json for
-    // our checks
-    return Promise.map(themeFilesContent, function (themeFile) {
+    // CASE: we need the actual content of all css, hbs files, and package.json for our checks
+    return Promise.all(themeFilesContent.map((themeFile) => {
         return fs.readFile(path.join(theme.path, themeFile.file), 'utf8').then(function (content) {
             themeFile.content = content;
 
@@ -119,13 +125,10 @@ const readFiles = function readFiles(theme) {
             const handlebarsMatch = themeFile.file.match(/\.hbs$/);
             if (handlebarsMatch) {
                 themeFile.parsed = ASTLinter.parse(themeFile.content, themeFile.file);
-
                 processHelpers(theme, themeFile);
             }
         });
-    }).then(function () {
-        return theme;
-    });
+    })).then(() => theme);
 };
 
 const processHelpers = function (theme, themeFile) {

package/lib/read-zip.js

@@ -1,6 +1,5 @@
 const debug = require('@tryghost/debug')('zip');
 const path = require('path');
-const Promise = require('bluebird');
 const os = require('os');
 const glob = require('glob');
 const {extract} = require('@tryghost/zip');

package/lib/specs/canary.js

@@ -716,19 +716,19 @@ let rules = {
     'GS110-NO-MISSING-PAGE-BUILDER-USAGE': {
         level: 'error',
         rule: 'Not all page features are being used',
-        details: oneLineTrim`Some page features used by Ghost via the <code>{{@page}}</code> global are not implemented in this theme.&nbsp;
+        details: oneLineTrim`<b>This error only applies to pages created with the Beta editor.</b> Some page features used by Ghost via the <code>{{@page}}</code> global are not implemented in this theme.&nbsp;
         Find more information about the <code>{{@page}}</code> global <a href="${docsBaseUrl}helpers/page/" target=_blank>here</a>.`
     },
     'GS110-NO-UNKNOWN-PAGE-BUILDER-USAGE': {
         level: 'error',
         fatal: true,
         rule: 'Unsupported page builder feature used',
-        details: oneLineTrim`A page feature used via the <code>{{@page}}</code> global was detected but it's not supported by this version of Ghost.&nbsp;
-        Find more information about the <code>{{@page}}</code> global <a href="${docsBaseUrl}helpers/page/" target=_blank>here</a>.`
+        details: oneLineTrim`A page feature used via the <code>{{@page}}</code> global was detected but is not supported by this version of Ghost. Please upgrade to the latest version for full access.&nbsp;
+        You can find more information about the <code>{{@page}}</code> global <a href="${docsBaseUrl}helpers/page/" target=_blank>here</a>.`
     },
     'GS120-NO-UNKNOWN-GLOBALS': {
         level: 'error',
-        rule: 'Unknown global helper used',
+        rule: 'No unknown global helper used',
         details: oneLineTrim`A global helper was detected that is not supported by this version of Ghost. Check the 
         <a href="${docsBaseUrl}helpers/" target=_blank>helpers documentation</a> for further information.`
     }

package/lib/specs/v4.js

@@ -172,7 +172,7 @@ let rules = {
     },
     'GS090-NO-UNKNOWN-CUSTOM-THEME-SETTINGS': {
         level: 'error',
-        rule: 'An unkown custom theme setting has been used.',
+        rule: 'An unknown 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.`
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gscan",
-  "version": "4.37.5",
+  "version": "4.38.0",
   "description": "Scans Ghost themes looking for errors, deprecations, features and compatibility",
   "keywords": [
     "ghost",
@@ -40,19 +40,18 @@
     "gscan": "./bin/cli.js"
   },
   "dependencies": {
-    "@sentry/node": "7.61.0",
-    "@tryghost/config": "0.2.17",
-    "@tryghost/debug": "0.1.25",
-    "@tryghost/errors": "1.2.25",
-    "@tryghost/logging": "2.4.5",
-    "@tryghost/pretty-cli": "1.2.37",
-    "@tryghost/server": "0.1.35",
-    "@tryghost/zip": "1.1.35",
-    "bluebird": "3.7.2",
+    "@sentry/node": "7.66.0",
+    "@tryghost/config": "0.2.18",
+    "@tryghost/debug": "0.1.26",
+    "@tryghost/errors": "1.2.26",
+    "@tryghost/logging": "2.4.6",
+    "@tryghost/pretty-cli": "1.2.38",
+    "@tryghost/server": "0.1.36",
+    "@tryghost/zip": "1.1.37",
     "chalk": "4.1.2",
     "common-tags": "1.8.2",
     "express": "4.18.2",
-    "express-hbs": "2.4.0",
+    "express-hbs": "2.4.1",
     "fs-extra": "11.1.1",
     "glob": "8.1.0",
     "lodash": "4.17.21",