gscan 4.9.0 → 4.9.4

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/090-template-syntax.js

@@ -4,6 +4,12 @@ const {versions, normalizePath} = require('../utils');
 const ASTLinter = require('../ast-linter');
 
 function processFileFunction(files, failures, rules) {
+    // This rule is needed to find partials
+    // Partials are needed for a full parsing
+    if (!rules['mark-used-partials']) {
+        rules['mark-used-partials'] = require(`../ast-linter/rules/mark-used-partials`);
+    }
+
     return function processFile(linter, themeFile) {
         if (themeFile.parsed.error) {
             // Ignore parsing errors, they are handled in 005

package/lib/checks/100-custom-template-settings-usage.js

@@ -74,6 +74,12 @@ function applyRule(rule, theme) {
 function parseWithAST({theme, log, file, rules, callback}){
     const linter = new ASTLinter();
 
+    // This rule is needed to find partials
+    // Partials are needed for a full parsing
+    if (!rules['mark-used-partials']) {
+        rules['mark-used-partials'] = require(`../ast-linter/rules/mark-used-partials`);
+    }
+
     function processFile(themeFile) {
         if (themeFile.parsed.error) {
             // Ignore parsing errors, they are handled in 005
@@ -110,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();
@@ -136,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.custom) {
+                    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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gscan",
-  "version": "4.9.0",
+  "version": "4.9.4",
   "description": "Scans Ghost themes looking for errors, deprecations, features and compatibility",
   "keywords": [
     "ghost",
@@ -41,8 +41,8 @@
   },
   "dependencies": {
     "@sentry/node": "6.13.3",
-    "@tryghost/pretty-cli": "1.2.21",
-    "@tryghost/zip": "1.1.17",
+    "@tryghost/pretty-cli": "1.2.22",
+    "@tryghost/zip": "1.1.18",
     "bluebird": "3.7.2",
     "chalk": "4.1.2",
     "common-tags": "1.8.0",