gscan 5.3.4 → 5.4.0

package/lib/specs/v6.js

@@ -8,7 +8,7 @@ const previousTemplates = previousSpec.templates;
 const previousRules = previousSpec.rules;
 
 // assign new or overwrite existing knownHelpers, templates, or rules here:
-let knownHelpers = ['split'];
+let knownHelpers = ['split', 'json', 'color_to_rgba', 'contrast_text_color', 'raw', 'search'];
 let templates = [];
 let rules = {
     'GS090-NO-LIMIT-ALL-IN-GET-HELPER': {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gscan",
-  "version": "5.3.4",
+  "version": "5.4.0",
   "description": "Scans Ghost themes looking for errors, deprecations, features and compatibility",
   "keywords": [
     "ghost",
@@ -43,15 +43,15 @@
     "gscan": "./bin/cli.js"
   },
   "dependencies": {
-    "@sentry/node": "10.42.0",
-    "@tryghost/config": "2.0.2",
-    "@tryghost/debug": "2.0.2",
-    "@tryghost/errors": "3.0.2",
-    "@tryghost/logging": "4.0.2",
+    "@sentry/node": "10.43.0",
+    "@tryghost/config": "2.0.3",
+    "@tryghost/debug": "2.0.3",
+    "@tryghost/errors": "3.0.3",
+    "@tryghost/logging": "4.0.3",
     "@tryghost/nql": "0.12.10",
-    "@tryghost/pretty-cli": "3.0.2",
-    "@tryghost/server": "2.0.2",
-    "@tryghost/zip": "3.0.2",
+    "@tryghost/pretty-cli": "3.0.3",
+    "@tryghost/server": "2.0.3",
+    "@tryghost/zip": "3.0.3",
     "chalk": "5.6.2",
     "express": "5.2.1",
     "express-handlebars": "7.1.3",
@@ -67,13 +67,13 @@
     "@eslint/eslintrc": "3.3.5",
     "@eslint/js": "10.0.1",
     "@tryghost/pro-ship": "1.0.7",
-    "@vitest/coverage-v8": "4.0.18",
+    "@vitest/coverage-v8": "4.1.0",
     "eslint": "10.0.3",
     "eslint-plugin-ghost": "3.5.0",
     "nodemon": "3.1.14",
     "should": "13.2.3",
     "sinon": "21.0.2",
-    "vitest": "4.0.18"
+    "vitest": "4.1.0"
   },
   "resolutions": {
     "node-loggly-bulk": "4.0.2",
@@ -81,7 +81,6 @@
   },
   "files": [
     "lib",
-    "bin",
-    "app"
+    "bin"
   ]
 }

package/app/ghost-version.js

@@ -1,39 +0,0 @@
-const debug = require('@tryghost/debug')('ghost-version');
-const exec = require('child_process').exec;
-const config = require('@tryghost/config');
-
-let ttl;
-let ghostVersion;
-
-const fetchGhostVersion = function fetchGhostVersion() {
-    debug('Ghost version not set or ttl expired');
-    exec('npm show ghost version', function (err, stdout, stderr) {
-        if (err) {
-            debug('fetchGhostVersion err', err);
-        }
-
-        if (stderr) {
-            debug('fetchGhostVersion stderr', stderr);
-        }
-
-        if (stdout) {
-            debug('fetchGhostVersion stdout', stdout);
-            ghostVersion = stdout;
-            ttl = new Date(Date.now() + config.get('ghostVersionTTL')).valueOf();
-        }
-    });
-};
-
-const middleware = function middleware(req, res, next) {
-    if (!ghostVersion || ttl && ttl < Date.now()) {
-        fetchGhostVersion();
-    }
-
-    debug('res.locals.ghostVersion: ' + ghostVersion);
-    res.locals.ghostVersion = ghostVersion;
-    next();
-};
-
-fetchGhostVersion();
-
-module.exports = middleware;

package/app/index.js

@@ -1,154 +0,0 @@
-// Init Sentry middleware
-require('./middlewares/sentry');
-const sentry = require('@sentry/node');
-
-// Require rest of the modules
-const express = require('express');
-const debug = require('@tryghost/debug')('app');
-const {create} = require('express-handlebars');
-const multer = require('multer');
-const server = require('@tryghost/server');
-const config = require('@tryghost/config');
-const errors = require('@tryghost/errors');
-const gscan = require('../lib');
-const fs = require('fs-extra');
-const path = require('path');
-const logRequest = require('./middlewares/log-request');
-const uploadValidation = require('./middlewares/upload-validation');
-const ghostVer = require('./ghost-version');
-const ghostVersions = require('../lib/utils').versions;
-const upload = multer({dest: __dirname + '/uploads/'});
-const app = express();
-const viewsDir = path.join(__dirname, 'tpl');
-const scanHbs = create({
-    extname: '.hbs',
-    partialsDir: path.join(viewsDir, 'partials'),
-    layoutsDir: path.join(viewsDir, 'layouts'),
-    defaultLayout: 'default',
-    helpers: {
-        block(name, options) {
-            const root = options.data && options.data.root;
-
-            if (!root) {
-                return typeof options.fn === 'function' ? options.fn(this) : '';
-            }
-
-            const blockCache = root.blockCache || {};
-            let val = blockCache[name];
-
-            if (val === undefined && typeof options.fn === 'function') {
-                val = options.fn(this);
-            }
-
-            if (Array.isArray(val)) {
-                val = val.join('\n');
-            }
-
-            return val;
-        },
-        contentFor(name, options) {
-            const root = options.data && options.data.root;
-
-            if (!root) {
-                return '';
-            }
-
-            const blockCache = root.blockCache || (root.blockCache = {});
-            const block = blockCache[name] || (blockCache[name] = []);
-            block.push(options.fn(this));
-            return '';
-        }
-    }
-});
-
-// Configure express
-app.set('x-powered-by', false);
-app.set('query parser', false);
-
-app.engine('hbs', scanHbs.engine);
-
-app.set('view engine', 'hbs');
-app.set('views', viewsDir);
-
-app.use(logRequest);
-app.use(express.static(__dirname + '/public'));
-app.use(ghostVer);
-
-app.get('/', function (req, res) {
-    res.render('index', {ghostVersions});
-});
-
-app.post('/',
-    upload.single('theme'),
-    uploadValidation,
-    function (req, res, next) {
-        const zip = {
-            path: req.file.path,
-            name: req.file.originalname
-        };
-        const options = {
-            checkVersion: req.body.version || ghostVersions.default
-        };
-
-        debug('Uploaded: ' + zip.name + ' to ' + zip.path);
-        debug('Version to check: ' + options.checkVersion);
-
-        let checkError;
-
-        gscan.checkZip(zip, options)
-            .then(function processResult(theme) {
-                debug('Checked: ' + zip.name);
-                res.theme = theme;
-            }).catch(function (error) {
-                checkError = error;
-            }).finally(function () {
-                debug('attempting to remove: ' + req.file.path);
-                fs.remove(req.file.path)
-                    .catch(function (removeError) {
-                        debug('failed to remove uploaded file', removeError);
-                    })
-                    .then(function () {
-                        if (checkError) {
-                            debug('Calling next with error');
-                            return next(checkError);
-                        }
-
-                        debug('Calling next');
-                        return next();
-                    });
-            });
-    },
-    function doRender(req, res) {
-        const options = {
-            checkVersion: req.body.version || ghostVersions.default
-        };
-        debug('Formatting result');
-        const result = gscan.format(res.theme, options);
-        debug('Rendering result');
-        scanHbs.handlebars.logger.level = 0;
-        res.render('result', result);
-    }
-);
-
-app.use(function (req, res, next) {
-    next(new errors.NotFoundError({message: 'Page not found'}));
-});
-
-// eslint-disable-next-line no-unused-vars
-app.use(function (err, req, res, next) {
-    let template = 'error';
-    req.err = err;
-
-    let statusCode = err.statusCode || 500;
-    res.status(statusCode);
-
-    if (res.statusCode === 404) {
-        template = 'error-404';
-    }
-
-    res.render(template, {message: err.message, stack: err.stack, details: err.errorDetails, context: err.context});
-});
-
-sentry.setupExpressErrorHandler(app);
-
-server.start(app, config.get('port'));

package/app/middlewares/log-request.js

@@ -1,30 +0,0 @@
-const randomUUID = require('crypto').randomUUID;
-const logging = require('@tryghost/logging');
-
-/**
- * @TODO:
- * - move middleware to ignition?
- */
-module.exports = function logRequest(req, res, next) {
-    const startTime = Date.now();
-    const requestId = randomUUID();
-
-    function logResponse() {
-        res.responseTime = (Date.now() - startTime) + 'ms';
-        req.requestId = requestId;
-        req.userId = req.user ? (req.user.id ? req.user.id : req.user) : null;
-
-        if (req.err) {
-            logging.error({req: req, res: res, err: req.err});
-        } else {
-            logging.info({req: req, res: res});
-        }
-
-        res.removeListener('finish', logResponse);
-        res.removeListener('close', logResponse);
-    }
-
-    res.on('finish', logResponse);
-    res.on('close', logResponse);
-    next();
-};

package/app/middlewares/sentry.js

@@ -1,11 +0,0 @@
-const sentryDSN = process.env.SENTRY_DSN;
-
-if (sentryDSN) {
-    const Sentry = require('@sentry/node');
-    const version = require('../../package.json').version;
-    Sentry.init({
-        dsn: sentryDSN,
-        release: 'gscan@' + version,
-        environment: process.env.NODE_ENV
-    });
-}

package/app/middlewares/upload-validation.js

@@ -1,43 +0,0 @@
-// 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('@tryghost/errors');
-
-const checkFileExists = function checkFileExists(fileData) {
-    return !!(fileData.mimetype && fileData.path);
-};
-
-const checkFileIsValid = function checkFileIsValid(fileData, types, extensions) {
-    const type = fileData.mimetype;
-
-    if (types.includes(type) && extensions.includes(fileData.ext)) {
-        return true;
-    }
-
-    return false;
-};
-
-module.exports = function uploadValidation(req, res, next) {
-    const extensions = ['.zip'];
-    const contentTypes = ['application/zip', 'application/x-zip-compressed', 'application/octet-stream'];
-
-    req.file = req.file || {};
-    req.file.name = req.file.originalname;
-    req.file.type = req.file.mimetype;
-
-    if (!checkFileExists(req.file)) {
-        return next(new errors.ValidationError({
-            message: `"Please select a zip file.`
-        }));
-    }
-
-    req.file.ext = path.extname(req.file.name).toLowerCase();
-
-    if (!checkFileIsValid(req.file, contentTypes, extensions)) {
-        return next(new errors.UnsupportedMediaTypeError({
-            message: 'Please select a valid zip file.'
-        }));
-    }
-
-    next();
-};