gscan 4.11.1 → 4.13.2

package/lib/ast-linter/helpers/index.js

@@ -73,7 +73,7 @@ function classifyNode(sexpr, options = {knownHelpers: [], knownHelpersOnly: fals
     // An eligible helper is one that does not have a complex path, i.e. `this.foo`, `../foo` etc.
     if (isEligible && !isHelper) {
         let name = sexpr.path.parts[0];
-        if (options.knownHelpers[name]) {
+        if (options.knownHelpers.includes(name)) {
             isHelper = true;
         } else if (options.knownHelpersOnly) {
             isEligible = false;

package/lib/ast-linter/rules/lint-no-unknown-partials.js

@@ -1,12 +1,12 @@
 const Rule = require('./base');
-const {getNodeName} = require('../helpers');
+const {getPartialName} = require('../helpers');
 
 module.exports = class NoUnknownPartials extends Rule {
     _checkForUnknownPartials(node) {
         if (node.name) {
             if (!this.isValidPartialReference(node)) {
                 this.log({
-                    message: `The partial ${getNodeName(node)} could not be found`,
+                    message: `The partial ${getPartialName(node)} could not be found`,
                     line: node.loc && node.loc.start.line,
                     column: node.loc && node.loc.start.column,
                     source: this.sourceForNode(node)

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

@@ -13,10 +13,28 @@ const checkKoenigCssClasses = function checkKoenigCssClasses(theme, options) {
     // 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;
+    const cardAssetsEnabled = packageJson
+        && packageJson.config
+        && packageJson.config.card_assets === true;
+    const enabledCards = packageJson
+        && packageJson.config
+        && packageJson.config.card_assets
+        && Array.isArray(packageJson.config.card_assets.include)
+        && packageJson.config.card_assets.include;
+    const disabledCards = !enabledCards // include takes priority over exclude
+        && packageJson
+        && packageJson.config
+        && packageJson.config.card_assets
+        && Array.isArray(packageJson.config.card_assets.exclude)
+        && packageJson.config.card_assets.exclude;
 
     ruleSet = _.pickBy(ruleSet.rules, function (rule, ruleCode) {
-        if (ruleCode.match(ruleRegex) && (!cardAssetsEnabled || !rule.cardAsset)) {
+        if (rule.cardAsset && (cardAssetsEnabled
+            || (enabledCards && enabledCards.includes(rule.cardAsset))
+            || (disabledCards && !disabledCards.includes(rule.cardAsset)))) {
+            return; // skip rule
+        }
+        if (ruleCode.match(ruleRegex)) {
             return rule;
         }
     });

package/lib/specs/canary.js

@@ -10,6 +10,19 @@ const previousKnownHelpers = previousSpec.knownHelpers;
 const previousTemplates = previousSpec.templates;
 const previousRules = previousSpec.rules;
 
+function cssCardRule(cardName, className) {
+    return {
+        level: 'warning',
+        rule: `The <code>.${className}</code> CSS class is required to appear styled in your theme`,
+        details: oneLineTrim`The <code>.${className}</code> CSS class is required otherwise wide images will appear unstyled.
+        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/" target=_blank>here</a>.`,
+        regex: new RegExp(`\\.${className}`, 'g'),
+        className: `.${className}`,
+        css: true,
+        cardAsset: cardName
+    };
+}
+
 // assign new or overwrite existing knownHelpers, templates, or rules here:
 let knownHelpers = ['match'];
 let templates = [];
@@ -171,7 +184,19 @@ let rules = {
         level: 'error',
         rule: 'A custom theme setting defined in <code>package.json</code> hasn\'t been used in any theme file.',
         details: oneLineTrim`Custom theme settings defined in <code>package.json</code> must be used at least once in the theme templates.`
-    }
+    },
+    'GS050-CSS-KGCO': cssCardRule('callout', 'kg-card-callout'),
+    'GS050-CSS-KGCOE': cssCardRule('callout', 'kg-card-callout-emoji'),
+    'GS050-CSS-KGCOT': cssCardRule('callout', 'kg-card-callout-text'),
+    'GS050-CSS-KGCOBGGY': cssCardRule('callout', 'kg-card-callout-background-grey'),
+    'GS050-CSS-KGCOBGW': cssCardRule('callout', 'kg-card-callout-background-white'),
+    'GS050-CSS-KGCOBGB': cssCardRule('callout', 'kg-card-callout-background-blue'),
+    'GS050-CSS-KGCOBGGN': cssCardRule('callout', 'kg-card-callout-background-green'),
+    'GS050-CSS-KGCOBGY': cssCardRule('callout', 'kg-card-callout-background-yellow'),
+    'GS050-CSS-KGCOBGR': cssCardRule('callout', 'kg-card-callout-background-red'),
+    'GS050-CSS-KGCOBGPK': cssCardRule('callout', 'kg-card-callout-background-pink'),
+    'GS050-CSS-KGCOBGPE': cssCardRule('callout', 'kg-card-callout-background-purple'),
+    'GS050-CSS-KGCOBGA': cssCardRule('callout', 'kg-card-callout-background-accent')
 };
 
 knownHelpers = _.union(previousKnownHelpers, knownHelpers);

package/lib/specs/v2.js

@@ -10,6 +10,15 @@ const previousKnownHelpers = previousSpec.knownHelpers;
 const previousTemplates = previousSpec.templates;
 const previousRules = previousSpec.rules;
 
+function requiredClassRule(strings) {
+    return `The <code>.${strings[0]}</code> CSS class is required to appear styled in your theme`;
+}
+
+function requiredClassDetails(strings) {
+    return oneLineTrim`The <code>.${strings[0]}</code> CSS class is required otherwise wide images will appear unstyled.
+    Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/" target=_blank>here</a>.`;
+}
+
 // assign new or overwrite existing knownHelpers, templates, or rules here:
 let knownHelpers = ['link', 'link_class', 'concat'];
 let templates = [];
@@ -446,153 +455,136 @@ let rules = {
     },
     'GS050-CSS-KGWW': {
         level: 'error',
-        rule: 'The <code>.kg-width-wide</code> CSS class is required to appear styled in your theme',
-        details: oneLineTrim`The <code>.kg-width-wide</code> CSS class is required otherwise wide images will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#image-size-implementations" target=_blank>here</a>.`,
+        rule: requiredClassRule`kg-width-wide`,
+        details: requiredClassDetails`kg-width-wide`,
         regex: /\.kg-width-wide/g,
         className: '.kg-width-wide',
-        css: true,
-        cardAsset: true
+        css: true
     },
     'GS050-CSS-KGWF': {
         level: 'error',
-        rule: 'The <code>.kg-width-full</code> CSS class is required to appear styled in your theme',
-        details: oneLineTrim`The <code>.kg-width-full</code> CSS class is required otherwise full width images will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#image-size-implementations" target=_blank>here</a>.`,
+        rule: requiredClassRule`kg-width-full`,
+        details: requiredClassDetails`kg-width-full`,
         regex: /\.kg-width-full/g,
         className: '.kg-width-full',
-        css: true,
-        cardAsset: true
+        css: true
     },
     'GS050-CSS-KGGC': {
         level: 'error',
-        rule: 'The <code>.kg-gallery-container</code> CSS class is required to appear styled in your theme',
-        details: oneLineTrim`The <code>.kg-gallery-container</code> CSS class is required otherwise galleries will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#gallery-card" target=_blank>here</a>.`,
+        rule: requiredClassRule`kg-gallery-container`,
+        details: requiredClassDetails``,
         regex: /\.kg-gallery-container/g,
         className: '.kg-gallery-container',
         css: true,
-        cardAsset: true
+        cardAsset: 'gallery'
     },
     'GS050-CSS-KGGR': {
         level: 'error',
-        rule: 'The <code>.kg-gallery-row</code> CSS class is required to appear styled in your theme',
-        details: oneLineTrim`The <code>.kg-gallery-row</code> CSS class is required otherwise gallery rows will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#gallery-card" target=_blank>here</a>.`,
+        rule: requiredClassRule`kg-gallery-row`,
+        details: requiredClassDetails`kg-gallery-row`,
         regex: /\.kg-gallery-row/g,
         className: '.kg-gallery-row',
         css: true,
-        cardAsset: true
+        cardAsset: 'gallery'
     },
     'GS050-CSS-KGGI': {
         level: 'error',
-        rule: 'The <code>.kg-gallery-image</code> CSS class is required to appear styled in your theme',
-        details: oneLineTrim`The <code>.kg-gallery-image</code> CSS class is required otherwise gallery images will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#gallery-card" target=_blank>here</a>.`,
+        rule: requiredClassRule`kg-gallery-image`,
+        details: requiredClassDetails`kg-gallery-image`,
         regex: /\.kg-gallery-image/g,
         className: '.kg-gallery-image',
         css: true,
-        cardAsset: true
+        cardAsset: 'gallery'
     },
     'GS050-CSS-KGBM': {
         level: 'error',
-        rule: 'The <code>.kg-bookmark-card</code> CSS class is required to appear styled in your theme',
-        details: oneLineTrim`The <code>.kg-bookmark-card</code> CSS class is required otherwise the bookmark card will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
+        rule: requiredClassRule`kg-bookmark-card`,
+        details: requiredClassDetails`kg-bookmark-card`,
         regex: /\.kg-bookmark-card/g,
         className: '.kg-bookmark-card',
         css: true,
-        cardAsset: true
+        cardAsset: 'bookmark'
     },
     'GS050-CSS-KGBMCO': {
         level: 'error',
-        rule: 'The <code>.kg-bookmark-container</code> CSS class is required to appear styled in your theme',
-        details: oneLineTrim`The <code>.kg-bookmark-card</code> CSS class is required otherwise the bookmark card will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
+        rule: requiredClassRule`kg-bookmark-container`,
+        details: requiredClassDetails`kg-bookmark-container`,
         regex: /\.kg-bookmark-container/g,
         className: '.kg-bookmark-container',
         css: true,
-        cardAsset: true
+        cardAsset: 'bookmark'
     },
     'GS050-CSS-KGBMCON': {
         level: 'error',
-        rule: 'The <code>.kg-bookmark-content</code> CSS class is required to appear styled in your theme',
-        details: oneLineTrim`The <code>.kg-bookmark-content</code> CSS class is required otherwise the bookmark card main content will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
+        rule: requiredClassRule`kg-bookmark-content`,
+        details: requiredClassDetails`kg-bookmark-content`,
         regex: /\.kg-bookmark-content/g,
         className: '.kg-bookmark-content',
         css: true,
-        cardAsset: true
+        cardAsset: 'bookmark'
     },
     'GS050-CSS-KGBMTI': {
         level: 'error',
-        rule: 'The <code>.kg-bookmark-title</code> CSS class is required to appear styled in your theme',
-        details: oneLineTrim`The <code>.kg-bookmark-title</code> CSS class is required otherwise the bookmark card title will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
+        rule: requiredClassRule`kg-bookmark-title`,
+        details: requiredClassDetails`kg-bookmark-title`,
         regex: /\.kg-bookmark-title/g,
         className: '.kg-bookmark-title',
         css: true,
-        cardAsset: true
+        cardAsset: 'bookmark'
     },
     'GS050-CSS-KGBMDE': {
         level: 'error',
-        rule: 'The <code>.kg-bookmark-description</code> CSS class is required to appear styled in your theme',
-        details: oneLineTrim`The <code>.kg-bookmark-description</code> CSS class is required otherwise the bookmark card description will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
+        rule: requiredClassRule`kg-bookmark-description`,
+        details: requiredClassDetails`kg-bookmark-description`,
         regex: /\.kg-bookmark-description/g,
         className: '.kg-bookmark-description',
         css: true,
-        cardAsset: true
+        cardAsset: 'bookmark'
     },
     'GS050-CSS-KGBMME': {
         level: 'error',
-        rule: 'The <code>.kg-bookmark-metadata</code> CSS class is required to appear styled in your theme',
-        details: oneLineTrim`The <code>.kg-bookmark-metadata</code> CSS class is required otherwise the bookmark card meta details will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
+        rule: requiredClassRule`kg-bookmark-metadata`,
+        details: requiredClassDetails`kg-bookmark-metadata`,
         regex: /\.kg-bookmark-metadata/g,
         className: '.kg-bookmark-metadata',
         css: true,
-        cardAsset: true
+        cardAsset: 'bookmark'
     },
     'GS050-CSS-KGBMIC': {
         level: 'error',
-        rule: 'The <code>.kg-bookmark-icon</code> CSS class is required to appear styled in your theme',
-        details: oneLineTrim`The <code>.kg-bookmark-icon</code> CSS class is required otherwise the bookmark card author icon will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
+        rule: requiredClassRule`kg-bookmark-icon`,
+        details: requiredClassDetails`kg-bookmark-icon`,
         regex: /\.kg-bookmark-icon/g,
         className: '.kg-bookmark-icon',
         css: true,
-        cardAsset: true
+        cardAsset: 'bookmark'
     },
     'GS050-CSS-KGBMAU': {
         level: 'error',
-        rule: 'The <code>.kg-bookmark-author</code> CSS class is required to appear styled in your theme',
-        details: oneLineTrim`The <code>.kg-bookmark-author</code> CSS class is required otherwise the bookmark card author name will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
+        rule: requiredClassRule`kg-bookmark-author`,
+        details: requiredClassDetails`kg-bookmark-author`,
         regex: /\.kg-bookmark-author/g,
         className: '.kg-bookmark-author',
         css: true,
-        cardAsset: true
+        cardAsset: 'bookmark'
     },
     'GS050-CSS-KGBMPU': {
         level: 'error',
-        rule: 'The <code>.kg-bookmark-publisher</code> CSS class is required to appear styled in your theme',
-        details: oneLineTrim`The <code>.kg-bookmark-publisher</code> CSS class is required otherwise the bookmark card publisher name will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
+        rule: requiredClassRule`kg-bookmark-publisher`,
+        details: requiredClassDetails``,
         regex: /\.kg-bookmark-publisher/g,
         className: '.kg-bookmark-publisher',
         css: true,
-        cardAsset: true
+        cardAsset: 'bookmark'
     },
     'GS050-CSS-KGBMTH': {
         level: 'error',
-        rule: 'The <code>.kg-bookmark-thumbnail</code> CSS class is required to appear styled in your theme',
-        details: oneLineTrim`The <code>.kg-bookmark-thumbnail</code> CSS class is required otherwise the bookmark card thumbnail image will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
+        rule: requiredClassRule`kg-bookmark-thumbnail`,
+        details: requiredClassDetails``,
         regex: /\.kg-bookmark-thumbnail/g,
         className: '.kg-bookmark-thumbnail',
         css: true,
-        cardAsset: true
+        cardAsset: 'bookmark'
     },
     // Updated v1 rules
     'GS001-DEPR-AC': {

package/lib/utils/package-json.js

@@ -1,6 +1,17 @@
+/**
+ * Copy of Ghost defaults for https://github.com/TryGhost/Ghost/blob/e25f1df0ae551c447da0d319bae06eadf9665444/core/frontend/services/theme-engine/config/defaults.json
+ */
+const defaultConfig = {
+    posts_per_page: 5,
+    card_assets: {
+        exclude: ['bookmark', 'gallery']
+    }
+};
+
 /**
  * Extracts the package.json JSON content. Note that this function never throws,
  * even when there is a JSON parsing error.
+ * This function uses the default `config` property to match Ghost implementation.
  * @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...).
@@ -9,12 +20,21 @@ function getJSON(theme) {
     let packageJSON = theme.files.find(item => item.file === 'package.json');
     if (packageJSON && packageJSON.content) {
         try {
-            return JSON.parse(packageJSON.content);
+            const json = JSON.parse(packageJSON.content);
+
+            // Use the default .config and allow it to be overwritten
+            const content = Object.assign({}, json, {
+                config: Object.assign({}, defaultConfig, json.config)
+            });
+
+            return content;
         } catch (e) {
             // Do nothing here
         }
     }
-    return null;
+    return {
+        config: defaultConfig
+    };
 }
 
 module.exports = getJSON;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gscan",
-  "version": "4.11.1",
+  "version": "4.13.2",
   "description": "Scans Ghost themes looking for errors, deprecations, features and compatibility",
   "keywords": [
     "ghost",