gscan 4.48.0 → 4.49.0

package/README.md

@@ -43,21 +43,20 @@ 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, 4.0 and 5.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, 5.0 and 6.0):
 
 `--v1` or `-1`
 `--v2` or `-2`
 `--v3` or `-3`
-`--v4` or `-4` or `--canary`
-`--v5` or `-5`
-
-Use the `--canary` parameter to check for the upcoming Ghost version.
+`--v4` or `-4`
+`--v5` or `-5` (default)
+`--v6` or `-6` or `--canary`
 
 Examples:
 
-`gscan /path/to/theme.zip -z1` - scan a theme in a zip file for Ghost 1.0 compatibility
+`gscan /path/to/theme.zip -z -1` - 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/directory` - scan a theme for Ghost 5.0 compatibility
 
 ### 4. Lib usage
 
@@ -68,11 +67,12 @@ var gscan = require('gscan');
 
 gscan.checkZip({
     path: 'path-to-zip',
+    // Pass in a folder to check
     // if you need to check the theme for a different
     // major Ghost version, you can pass it. Currently
-    // v1, v2, v3, v4 and canary (v5) are supported. Default is
-    // the latest Ghost version 4.0:
-    // checkVersion: 'v4',
+    // v1, v2, v3, v4, v5 and v6 are supported. Default is
+    // the latest Ghost version 5.0:
+    // checkVersion: 'v5',
     name: 'my-theme'
 }).then(function (result) {
     console.log(result);

package/bin/cli.js

@@ -56,8 +56,11 @@ prettyCLI
     .boolean('-5, --v5', {
         desc: 'Check theme for Ghost 5.0 compatibility'
     })
+    .boolean('-6, --v6', {
+        desc: 'Check theme for Ghost 6.0 compatibility'
+    })
     .boolean('-c, --canary', {
-        desc: 'Check theme for upcoming Ghost version compatibility'
+        desc: 'Check theme for Ghost 6.0 compatibility (alias for --v6)'
     })
     .boolean('-f, --fatal', {
         desc: 'Only show fatal errors that prevent upgrading Ghost'
@@ -80,8 +83,10 @@ prettyCLI
             cliOptions.checkVersion = 'v4';
         } else if (argv.v5) {
             cliOptions.checkVersion = 'v5';
+        } else if (argv.v6) {
+            cliOptions.checkVersion = 'v6';
         } else if (argv.canary) {
-            cliOptions.checkVersion = 'canary';
+            cliOptions.checkVersion = ghostVersions.canary;
         } else {
             cliOptions.checkVersion = ghostVersions.default;
         }

package/lib/checker.js

@@ -30,8 +30,8 @@ const check = async function checkAll(themePath, options = {}) {
     let version = passedVersion;
 
     if (passedVersion === 'canary') {
-        version = 'v4';
-        options.checkVersion = 'v4';
+        version = versions.canary;
+        options.checkVersion = versions.canary;
     }
 
     _.each(labsEnabledHelpers, (flag, helper) => {

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

@@ -55,14 +55,19 @@ const v4PackageJSONValidationRules = _.extend({},
     v4PackageJSONConditionalRules
 );
 
-const canaryPackageJSONConditionalRules = {
+const v5PackageJSONConditionalRules = {
     invalidCustomThemeSettingVisibilitySyntax: 'GS010-PJ-CUST-THEME-SETTINGS-VISIBILITY-SYNTAX',
     invalidCustomThemeSettingVisibilityValue: 'GS010-PJ-CUST-THEME-SETTINGS-VISIBILITY-VALUE'
 };
-const canaryPackageJSONValidationRules = _.extend({},
+const v5PackageJSONValidationRules = _.extend({},
     {isNotPresentCardAssets: 'GS010-PJ-GHOST-CARD-ASSETS-NOT-PRESENT'},
     {invalidCustomThemeSettingDescriptionLength: 'GS010-PJ-CUST-THEME-SETTINGS-DESCRIPTION-LENGTH'},
-    canaryPackageJSONConditionalRules
+    v5PackageJSONConditionalRules
+);
+
+const v6PackageJSONConditionalRules = {};
+const v6PackageJSONValidationRules = _.extend({},
+    v6PackageJSONConditionalRules
 );
 
 _private.validatePackageJSONFields = function validatePackageJSONFields(packageJSON, theme, packageJSONValidationRules) {
@@ -294,7 +299,30 @@ module.exports = function checkPackageJSON(theme, options) {
             v2PackageJSONValidationRules,
             v3PackageJSONValidationRules,
             v4PackageJSONValidationRules,
-            canaryPackageJSONValidationRules
+            v5PackageJSONValidationRules
+        );
+        // Make these delete more declarative as the list grows
+        delete packageJSONValidationRules.isNotPresentEngineGhostAPI;
+        delete packageJSONValidationRules.isv01EngineGhostAPI;
+        delete packageJSONValidationRules.isv2EngineGhostAPI;
+
+        packageJSONConditionalRules = _.merge(
+            {},
+            v1PackageJSONConditionalRules,
+            v2PackageJSONConditionalRules,
+            v3PackageJSONConditionalRules,
+            v4PackageJSONConditionalRules,
+            v5PackageJSONConditionalRules
+        );
+    } else if (checkVersion === 'v6') {
+        packageJSONValidationRules = _.merge(
+            {},
+            v1PackageJSONValidationRules,
+            v2PackageJSONValidationRules,
+            v3PackageJSONValidationRules,
+            v4PackageJSONValidationRules,
+            v5PackageJSONValidationRules,
+            v6PackageJSONValidationRules
         );
         // Make these delete more declarative as the list grows
         delete packageJSONValidationRules.isNotPresentEngineGhostAPI;
@@ -307,7 +335,8 @@ module.exports = function checkPackageJSON(theme, options) {
             v2PackageJSONConditionalRules,
             v3PackageJSONConditionalRules,
             v4PackageJSONConditionalRules,
-            canaryPackageJSONConditionalRules
+            v5PackageJSONConditionalRules,
+            v6PackageJSONConditionalRules
         );
     } else {
         // default check for current version 'v4' rules

package/lib/specs/index.js

@@ -4,10 +4,6 @@ module.exports = {
     get: function get(key) {
         let [version] = key;
 
-        if (version === 'v5') {
-            version = 'canary';
-        }
-
         debug('Checking against version:', version);
 
         return require(`./${[version]}`);

package/lib/specs/v6.js

@@ -0,0 +1,25 @@
+const _ = require('lodash');
+const previousSpec = require('./v5');
+
+const previousKnownHelpers = previousSpec.knownHelpers;
+const previousTemplates = previousSpec.templates;
+const previousRules = previousSpec.rules;
+
+// assign new or overwrite existing knownHelpers, templates, or rules here:
+// Currently no new rules for v6
+let knownHelpers = [];
+let templates = [];
+let rules = {};
+
+knownHelpers = _.union(previousKnownHelpers, knownHelpers);
+templates = _.union(previousTemplates, templates);
+
+// Merge the previous rules into the new rules
+rules = _.merge({}, previousRules, rules);
+
+module.exports = {
+    knownHelpers: knownHelpers,
+    templates: templates,
+    rules: rules,
+    defaultPackageJSON: previousSpec.defaultPackageJSON
+};

package/lib/utils/versions.json

@@ -19,5 +19,10 @@
     "major": "5.x",
     "docs": "5.0.0"
   },
-  "default": "v5"
+  "v6": {
+    "major": "6.x",
+    "docs": "6.0.0"
+  },
+  "default": "v5",
+  "canary": "v6"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gscan",
-  "version": "4.48.0",
+  "version": "4.49.0",
   "description": "Scans Ghost themes looking for errors, deprecations, features and compatibility",
   "keywords": [
     "ghost",
@@ -33,9 +33,8 @@
     "start": "node app/index.js",
     "dev": "NODE_ENV=development DEBUG=gscan:* nodemon",
     "lint": "eslint . --ext .js --cache",
-    "test": "NODE_ENV=testing mocha -- $(find test -name '*.test.js')",
+    "test": "NODE_ENV=testing c8 mocha test/*.test.js",
     "posttest": "yarn lint",
-    "coverage": "NODE_ENV=testing istanbul cover --dir test/coverage _mocha -- $(find test -name '*.test.js')",
     "preship": "yarn test",
     "ship": "pro-ship",
     "postship": "npm publish"
@@ -44,7 +43,7 @@
     "gscan": "./bin/cli.js"
   },
   "dependencies": {
-    "@sentry/node": "^7.73.0",
+    "@sentry/node": "^9.0.0",
     "@tryghost/config": "^0.2.18",
     "@tryghost/debug": "^0.1.26",
     "@tryghost/errors": "^1.2.26",
@@ -60,7 +59,7 @@
     "fs-extra": "^11.1.1",
     "glob": "^8.1.0",
     "lodash": "^4.17.21",
-    "multer": "^1.4.4",
+    "multer": "^2.0.0",
     "pluralize": "^8.0.0",
     "require-dir": "^1.2.0",
     "semver": "^7.5.4",
@@ -69,10 +68,10 @@
   },
   "devDependencies": {
     "@tryghost/pro-ship": "1.0.7",
+    "c8": "8.0.1",
     "eslint": "8.1.0",
     "eslint-plugin-ghost": "2.1.0",
-    "istanbul": "0.4.5",
-    "mocha": "11.1.0",
+    "mocha": "11.5.0",
     "node-fetch": "3.3.2",
     "nodemon": "2.0.7",
     "rewire": "6.0.0",