gscan 4.9.2 → 4.10.1

package/lib/checker.js

@@ -41,7 +41,7 @@ const checker = function checkAll(themePath, options = {}) {
         }
     });
 
-    return readTheme(themePath, options)
+    return readTheme(themePath)
         .then(function (theme) {
             // set the major version to check
             theme.checkedVersion = versions[version].major;

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/checks/100-custom-template-settings-usage.js

@@ -116,15 +116,8 @@ function parseWithAST({theme, log, file, rules, callback}){
 
 const ruleImplementations = {
     'GS100-NO-UNUSED-CUSTOM-THEME-SETTING': {
-        isEnabled: ({theme, result}) => {
-            let [packageJSON] = _.filter(theme.files, {file: 'package.json'});
-            if (packageJSON && packageJSON.content) {
-                let packageJSONParsed = JSON.parse(packageJSON.content);
-                if (packageJSONParsed.config && packageJSONParsed.config.custom) {
-                    result.customThemeSettingsConfig = packageJSONParsed.config.custom;
-                }
-            }
-            return !!result.customThemeSettingsConfig;
+        isEnabled: ({theme}) => {
+            return !!theme.customSettings;
         },
         init: ({result}) => {
             result.customThemeSettings = new Set();
@@ -142,8 +135,8 @@ const ruleImplementations = {
                 }});
             }
         },
-        done: ({log, result}) => {
-            const config = Object.keys(result.customThemeSettingsConfig);
+        done: ({log, theme, result}) => {
+            const config = Object.keys(theme.customSettings);
             const notUsedVariable = config.filter(x => !result.customThemeSettings.has(x));
 
             if (notUsedVariable.length > 0) {

package/lib/read-theme.js

@@ -75,11 +75,9 @@ const readThemeStructure = function readThemeFiles(themePath, subPath, arr) {
 /**
  *
  * @param {Theme} theme
- * @param {Object} options
- * @param {Object=} [options.labs] object containing boolean flags for enabled labs features
  * @returns {Promise<Theme>}
  */
-const readFiles = function readFiles(theme, options = {}) {
+const readFiles = function readFiles(theme) {
     const themeFilesContent = _.filter(theme.files, function (themeFile) {
         if (themeFile && themeFile.ext) {
             return themeFile.ext.match(/\.hbs|\.css|\.js/ig) || themeFile.file.match(/package.json/i);
@@ -98,17 +96,19 @@ const readFiles = function readFiles(theme, options = {}) {
         return fs.readFile(path.join(theme.path, themeFile.file), 'utf8').then(function (content) {
             themeFile.content = content;
 
-            if (options.labs && options.labs.customThemeSettings) {
-                if (!theme.customSettings) {
-                    theme.customSettings = {};
-                }
+            if (!theme.customSettings) {
+                theme.customSettings = {};
+            }
 
-                const packageJsonMatch = themeFile.file.match(/^package\.json/);
-                if (packageJsonMatch) {
+            const packageJsonMatch = themeFile.file === 'package.json';
+            if (packageJsonMatch) {
+                try {
                     const packageJson = JSON.parse(themeFile.content);
                     if (packageJson.config && packageJson.config.custom) {
                         theme.customSettings = packageJson.config.custom;
                     }
+                } catch (e) {
+                    // Ignore error as they will be caught in 010-package-json.js
                 }
             }
 
@@ -230,11 +230,9 @@ const extractTemplates = function extractTemplates(allFiles) {
 /**
  *
  * @param {string} themePath - path to the validated theme
- * @param {Object} options
- * @param {Object=} [options.labs] object containing boolean flags for enabled labs features
  * @returns {Promise<Theme>}
  */
-module.exports = function readTheme(themePath, options = {}) {
+module.exports = function readTheme(themePath) {
     return readThemeStructure(themePath)
         .then(function (themeFiles) {
             var allTemplates = extractTemplates(themeFiles);
@@ -252,7 +250,7 @@ module.exports = function readTheme(themePath, options = {}) {
                     pass: [],
                     fail: {}
                 }
-            }, options);
+            });
         });
 };
 

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.2",
+  "version": "4.10.1",
   "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"
@@ -60,7 +60,7 @@
     "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",