gscan 4.9.4 → 4.11.0

package/app/ghost-version.js

@@ -1,6 +1,6 @@
-const debug = require('ghost-ignition').debug('ghost-version');
+const debug = require('@tryghost/debug')('ghost-version');
 const exec = require('child_process').exec;
-const config = require('ghost-ignition').config();
+const config = require('@tryghost/config');
 
 let ttl;
 let ghostVersion;

package/app/index.js

@@ -1,9 +1,10 @@
 const express = require('express');
-const debug = require('ghost-ignition').debug('app');
+const debug = require('@tryghost/debug')('app');
 const hbs = require('express-hbs');
 const multer = require('multer');
-const server = require('ghost-ignition').server;
-const errors = require('ghost-ignition').errors;
+const server = require('@tryghost/server');
+const config = require('@tryghost/config');
+const errors = require('@tryghost/ignition-errors');
 const gscan = require('../lib');
 const fs = require('fs-extra');
 const logRequest = require('./middlewares/log-request');
@@ -109,4 +110,4 @@ app.use(function (err, req, res, next) {
     res.render(template, {message: err.message, stack: err.stack, details: err.errorDetails, context: err.context});
 });
 
-server.start(app);
+server.start(app, config.get('port'));

package/app/middlewares/log-request.js

@@ -1,5 +1,5 @@
 var uuid = require('uuid'),
-    logging = require('../logging');
+    logging = require('@tryghost/logging');
 
 /**
  * @TODO:

package/app/middlewares/upload-validation.js

@@ -1,7 +1,7 @@
 // NOTE: this middleware was extracted from Ghost core validation for theme uploads
 //       might be useful to unify this logic in the future if it's extracted to separate module
 const path = require('path');
-const errors = require('ghost-ignition').errors;
+const errors = require('@tryghost/ignition-errors');
 
 const checkFileExists = function checkFileExists(fileData) {
     return !!(fileData.mimetype && fileData.path);

package/lib/checker.js

@@ -1,12 +1,9 @@
 const Promise = require('bluebird');
 const _ = require('lodash');
 const requireDir = require('require-dir');
-const {errors} = require('ghost-ignition');
-const readTheme = require('./read-theme');
+const errors = require('@tryghost/ignition-errors');
 const versions = require('./utils').versions;
 
-const checks = requireDir('./checks');
-
 // An object containing helpers as keys and their labs flag as values
 // E.g. match:  'matchHelper'
 const labsEnabledHelpers = {
@@ -24,7 +21,9 @@ const labsEnabledHelpers = {
  * @param {Object=} [options.labs] object containing boolean flags for enabled labs features
  * @returns {Promise<Object>}
  */
-const checker = function checkAll(themePath, options = {}) {
+const check = function checkAll(themePath, options = {}) {
+    // Require checks late to avoid loading all until used
+    const checks = requireDir('./checks');
     const passedVersion = _.get(options, 'checkVersion', versions.default);
     let version = passedVersion;
 
@@ -41,13 +40,15 @@ const checker = 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.reduce(_.values(checks), function (themeToCheck, check) {
-                return check(themeToCheck, options, themePath);
+            return Promise.reduce(_.values(checks), function (themeToCheck, checkFunction) {
+                return checkFunction(themeToCheck, options, themePath);
             }, theme);
         })
         .catch((error) => {
@@ -61,4 +62,50 @@ const checker = function checkAll(themePath, options = {}) {
         });
 };
 
-module.exports = checker;
+const checkZip = async function checkZip(path, options) {
+    options = Object.assign({}, {
+        keepExtractedDir: false
+    }, options);
+
+    let zip;
+
+    if (_.isString(path)) {
+        zip = {
+            path,
+            name: path.match(/(.*\/)?(.*).zip$/)[2]
+        };
+    } else {
+        zip = _.clone(path);
+    }
+
+    try {
+        const readZip = require('./read-zip');
+        const {path: extractedZipPath} = await readZip(zip);
+        const theme = await check(extractedZipPath, Object.assign({themeName: zip.name}, options));
+
+        if (options.keepExtractedDir) {
+            return theme;
+        } else {
+            const fs = require('fs-extra');
+            await fs.remove(zip.origPath);
+            return theme;
+        }
+    } catch (error) {
+        if (!errors.utils.isIgnitionError(error)) {
+            throw new errors.ValidationError({
+                message: 'Failed to check zip file',
+                help: 'Your zip file might be corrupted, try unzipping and zipping again.',
+                errorDetails: error.message,
+                context: zip.name,
+                err: error
+            });
+        }
+
+        throw error;
+    }
+};
+
+module.exports = {
+    check,
+    checkZip
+};

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

@@ -4,7 +4,6 @@ const isEmail = require('validator/lib/isEmail');
 const _private = {};
 const packageJSONFileName = 'package.json';
 const versions = require('../utils').versions;
-// const debug = require('ghost-ignition').debug('checks:package-json');
 
 const isSnakeCase = (str) => {
     return /^[a-z0-9]+[a-z0-9_]*$/.test(str);

package/lib/checks/050-koenig-css-classes.js

@@ -1,6 +1,7 @@
 const _ = require('lodash');
 const spec = require('../specs');
 const versions = require('../utils').versions;
+const {getPackageJSON} = require('../utils');
 
 const checkKoenigCssClasses = function checkKoenigCssClasses(theme, options) {
     const checkVersion = _.get(options, 'checkVersion', versions.default);
@@ -9,8 +10,13 @@ const checkKoenigCssClasses = function checkKoenigCssClasses(theme, options) {
     // CASE: 050-koenig-css-classes checks only needs `rules` that start with `GS050-`
     const ruleRegex = /GS050-.*/g;
 
+    // Following the introduction of card assets, we disable certain rules
+    // when it's enabled by the theme.
+    const packageJson = getPackageJSON(theme);
+    const cardAssetsEnabled = packageJson && packageJson.config && packageJson.config.card_assets === true;
+
     ruleSet = _.pickBy(ruleSet.rules, function (rule, ruleCode) {
-        if (ruleCode.match(ruleRegex)) {
+        if (ruleCode.match(ruleRegex) && (!cardAssetsEnabled || !rule.cardAsset)) {
             return rule;
         }
     });

package/lib/checks/080-helper-usage.js

@@ -1,17 +1,12 @@
 const _ = require('lodash');
 const spec = require('../specs');
-const versions = require('../utils').versions;
-const packageJSONFileName = 'package.json';
+const {versions, getPackageJSON} = require('../utils');
 
 module.exports = function checkUsage(theme, options) {
     const checkVersion = _.get(options, 'checkVersion', versions.default);
     let ruleSet = spec.get([checkVersion]);
-    let [packageJSON] = _.filter(theme.files, {file: packageJSONFileName});
-    let targetApiVersion = versions.default;
-    if (packageJSON && packageJSON.content) {
-        let packageJSONParsed = JSON.parse(packageJSON.content);
-        targetApiVersion = (packageJSONParsed && packageJSONParsed.engines && packageJSONParsed.engines['ghost-api']) || versions.default;
-    }
+    const packageJSON = getPackageJSON(theme);
+    let targetApiVersion = (packageJSON && packageJSON.engines && packageJSON.engines['ghost-api']) || versions.default;
 
     // CASE: 080-helper-usage checks only needs `rules` that start with `GS080-`
     const ruleRegex = /GS080-.*/g;

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

@@ -1,6 +1,6 @@
 const _ = require('lodash');
 const spec = require('../specs');
-const {versions, normalizePath} = require('../utils');
+const {versions, normalizePath, getPackageJSON} = require('../utils');
 const ASTLinter = require('../ast-linter');
 
 function processFileFunction(files, failures, rules) {
@@ -40,13 +40,10 @@ function processFileFunction(files, failures, rules) {
 }
 
 function getCustomThemeSettings(theme) {
-    let [packageJSON] = _.filter(theme.files, {file: 'package.json'});
+    const packageJSON = getPackageJSON(theme);
     let customThemeSettingsConfig;
-    if (packageJSON && packageJSON.content) {
-        let packageJSONParsed = JSON.parse(packageJSON.content);
-        if (packageJSONParsed.config && packageJSONParsed.config.custom) {
-            customThemeSettingsConfig = packageJSONParsed.config.custom;
-        }
+    if (packageJSON && packageJSON.config && packageJSON.config.custom) {
+        customThemeSettingsConfig = packageJSON.config.custom;
     }
     return customThemeSettingsConfig;
 }

package/lib/index.js

@@ -1,59 +1,5 @@
-const _ = require('lodash');
-const fs = require('fs-extra');
-const check = require('./checker');
+const {check, checkZip} = require('./checker');
 const format = require('./format');
-const readZip = require('./read-zip');
-const {errors} = require('ghost-ignition');
-
-/**
- *
- * @param {string} path zip file path or a folder path containing a theme
- * @param {Object} options
- * @param {boolean} options.keepExtractedDir flag controling if the directory with extracted zip should stay after the check is complete
- * @param {string} options.checkVersion version to check the theme against
- * @param {Object=} [options.labs] object containing boolean flags for enabled labs features
- * @returns {Promise<any>}
- */
-const checkZip = async function checkZip(path, options) {
-    options = Object.assign({}, {
-        keepExtractedDir: false
-    }, options);
-
-    let zip;
-
-    if (_.isString(path)) {
-        zip = {
-            path,
-            name: path.match(/(.*\/)?(.*).zip$/)[2]
-        };
-    } else {
-        zip = _.clone(path);
-    }
-
-    try {
-        const {path: extractedZipPath} = await readZip(zip);
-        const theme = await check(extractedZipPath, Object.assign({themeName: zip.name}, options));
-
-        if (options.keepExtractedDir) {
-            return theme;
-        } else {
-            await fs.remove(zip.origPath);
-            return theme;
-        }
-    } catch (error) {
-        if (!errors.utils.isIgnitionError(error)) {
-            throw new errors.ValidationError({
-                message: 'Failed to check zip file',
-                help: 'Your zip file might be corrupted, try unzipping and zipping again.',
-                errorDetails: error.message,
-                context: zip.name,
-                err: error
-            });
-        }
-
-        throw error;
-    }
-};
 
 module.exports = {
     check,

package/lib/read-zip.js

@@ -1,10 +1,10 @@
-const debug = require('ghost-ignition').debug('zip');
+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');
-const {errors} = require('ghost-ignition');
+const errors = require('@tryghost/ignition-errors');
 const uuid = require('uuid');
 const _ = require('lodash');
 

package/lib/specs/index.js

@@ -1,4 +1,4 @@
-const debug = require('ghost-ignition').debug('ghost-spec');
+const debug = require('@tryghost/debug')('ghost-spec');
 
 module.exports = {
     get: function get(key) {

package/lib/specs/v2.js

@@ -451,7 +451,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#image-size-implementations" target=_blank>here</a>.`,
         regex: /\.kg-width-wide/g,
         className: '.kg-width-wide',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGWF': {
         level: 'error',
@@ -460,7 +461,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#image-size-implementations" target=_blank>here</a>.`,
         regex: /\.kg-width-full/g,
         className: '.kg-width-full',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGGC': {
         level: 'error',
@@ -469,7 +471,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#gallery-card" target=_blank>here</a>.`,
         regex: /\.kg-gallery-container/g,
         className: '.kg-gallery-container',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGGR': {
         level: 'error',
@@ -478,7 +481,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#gallery-card" target=_blank>here</a>.`,
         regex: /\.kg-gallery-row/g,
         className: '.kg-gallery-row',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGGI': {
         level: 'error',
@@ -487,7 +491,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#gallery-card" target=_blank>here</a>.`,
         regex: /\.kg-gallery-image/g,
         className: '.kg-gallery-image',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBM': {
         level: 'error',
@@ -496,7 +501,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-card/g,
         className: '.kg-bookmark-card',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMCO': {
         level: 'error',
@@ -505,7 +511,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-container/g,
         className: '.kg-bookmark-container',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMCON': {
         level: 'error',
@@ -514,7 +521,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-content/g,
         className: '.kg-bookmark-content',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMTI': {
         level: 'error',
@@ -523,7 +531,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-title/g,
         className: '.kg-bookmark-title',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMDE': {
         level: 'error',
@@ -532,7 +541,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-description/g,
         className: '.kg-bookmark-description',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMME': {
         level: 'error',
@@ -541,7 +551,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-metadata/g,
         className: '.kg-bookmark-metadata',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMIC': {
         level: 'error',
@@ -550,7 +561,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-icon/g,
         className: '.kg-bookmark-icon',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMAU': {
         level: 'error',
@@ -559,7 +571,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-author/g,
         className: '.kg-bookmark-author',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMPU': {
         level: 'error',
@@ -568,7 +581,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-publisher/g,
         className: '.kg-bookmark-publisher',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMTH': {
         level: 'error',
@@ -577,7 +591,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-thumbnail/g,
         className: '.kg-bookmark-thumbnail',
-        css: true
+        css: true,
+        cardAsset: true
     },
     // Updated v1 rules
     'GS001-DEPR-AC': {

package/lib/utils/index.js

@@ -16,5 +16,6 @@ module.exports = {
     // `docs` is used to generate the URLs that link to documentation and needs to be updated whenever
     // we release a new version on ghost.org/docs/api/
     versions: require('./versions.json'),
-    normalizePath
+    normalizePath,
+    getPackageJSON: require('./package-json')
 };

package/lib/utils/package-json.js

@@ -0,0 +1,20 @@
+/**
+ * Extracts the package.json JSON content. Note that this function never throws,
+ * even when there is a JSON parsing error.
+ * @param {Object} theme The theme to extract package.json from.
+ * @returns {Object} The content of the package.json file, or `null` if
+ * something happened (no file, JSON parsing error...).
+ */
+function getJSON(theme) {
+    let packageJSON = theme.files.find(item => item.file === 'package.json');
+    if (packageJSON && packageJSON.content) {
+        try {
+            return JSON.parse(packageJSON.content);
+        } catch (e) {
+            // Do nothing here
+        }
+    }
+    return null;
+}
+
+module.exports = getJSON;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gscan",
-  "version": "4.9.4",
+  "version": "4.11.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.10.0 || ^14.13.0"
+    "node": "^12.22.1 || ^14.17.0 || ^16.13.0"
   },
   "bugs": {
     "url": "https://github.com/TryGhost/gscan/issues"
@@ -40,16 +40,20 @@
     "gscan": "./bin/cli.js"
   },
   "dependencies": {
-    "@sentry/node": "6.13.3",
+    "@sentry/node": "6.15.0",
+    "@tryghost/config": "0.2.0",
+    "@tryghost/debug": "0.1.9",
+    "@tryghost/ignition-errors": "0.1.8",
+    "@tryghost/logging": "1.0.1",
     "@tryghost/pretty-cli": "1.2.22",
+    "@tryghost/server": "0.1.0",
     "@tryghost/zip": "1.1.18",
     "bluebird": "3.7.2",
     "chalk": "4.1.2",
-    "common-tags": "1.8.0",
+    "common-tags": "1.8.2",
     "express": "4.17.1",
     "express-hbs": "2.4.0",
     "fs-extra": "9.1.0",
-    "ghost-ignition": "4.6.3",
     "glob": "7.2.0",
     "lodash": "4.17.21",
     "multer": "1.4.3",
@@ -60,14 +64,14 @@
     "validator": "13.0.0"
   },
   "devDependencies": {
-    "eslint": "7.25.0",
+    "eslint": "8.1.0",
     "eslint-plugin-ghost": "2.1.0",
     "istanbul": "0.4.5",
     "mocha": "9.0.2",
     "nodemon": "2.0.7",
     "rewire": "5.0.0",
     "should": "13.2.3",
-    "sinon": "11.0.0"
+    "sinon": "12.0.0"
   },
   "files": [
     "lib",

package/app/logging.js

@@ -1,12 +0,0 @@
-var config = require('ghost-ignition').config();
-
-// see defaults in GhostLogger
-var logging = require('ghost-ignition').logging({
-    path: config.get('logging:path'),
-    domain: config.get('logging:domain'),
-    mode: config.get('logging:mode'),
-    level: config.get('logging:level'),
-    transports: config.get('logging:transports')
-});
-
-module.exports = logging;