gscan 4.10.2 → 4.12.0

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,7 +10,30 @@ 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;
+    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 (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/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,138 +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
     },
     '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
     },
     '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
+        css: 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
+        css: 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
+        css: 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
+        css: 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
+        css: 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
+        css: 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
+        css: 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
+        css: 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
+        css: 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
+        css: 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
+        css: 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
+        css: 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
+        css: true,
+        cardAsset: 'bookmark'
     },
     // Updated v1 rules
     'GS001-DEPR-AC': {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gscan",
-  "version": "4.10.2",
+  "version": "4.12.0",
   "description": "Scans Ghost themes looking for errors, deprecations, features and compatibility",
   "keywords": [
     "ghost",
@@ -41,16 +41,16 @@
   },
   "dependencies": {
     "@sentry/node": "6.15.0",
-    "@tryghost/config": "0.2.0",
+    "@tryghost/config": "0.2.1",
     "@tryghost/debug": "0.1.9",
     "@tryghost/ignition-errors": "0.1.8",
-    "@tryghost/logging": "1.0.0",
+    "@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.1",
+    "common-tags": "1.8.2",
     "express": "4.17.1",
     "express-hbs": "2.4.0",
     "fs-extra": "9.1.0",