gscan 4.10.2 → 4.11.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,8 +10,13 @@ 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;
+
     ruleSet = _.pickBy(ruleSet.rules, function (rule, ruleCode) {
-        if (ruleCode.match(ruleRegex)) {
+        if (ruleCode.match(ruleRegex) && (!cardAssetsEnabled || !rule.cardAsset)) {
             return rule;
         }
     });

package/lib/specs/v2.js

@@ -451,7 +451,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#image-size-implementations" target=_blank>here</a>.`,
         regex: /\.kg-width-wide/g,
         className: '.kg-width-wide',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGWF': {
         level: 'error',
@@ -460,7 +461,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#image-size-implementations" target=_blank>here</a>.`,
         regex: /\.kg-width-full/g,
         className: '.kg-width-full',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGGC': {
         level: 'error',
@@ -469,7 +471,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#gallery-card" target=_blank>here</a>.`,
         regex: /\.kg-gallery-container/g,
         className: '.kg-gallery-container',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGGR': {
         level: 'error',
@@ -478,7 +481,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#gallery-card" target=_blank>here</a>.`,
         regex: /\.kg-gallery-row/g,
         className: '.kg-gallery-row',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGGI': {
         level: 'error',
@@ -487,7 +491,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#gallery-card" target=_blank>here</a>.`,
         regex: /\.kg-gallery-image/g,
         className: '.kg-gallery-image',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBM': {
         level: 'error',
@@ -496,7 +501,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-card/g,
         className: '.kg-bookmark-card',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMCO': {
         level: 'error',
@@ -505,7 +511,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-container/g,
         className: '.kg-bookmark-container',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMCON': {
         level: 'error',
@@ -514,7 +521,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-content/g,
         className: '.kg-bookmark-content',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMTI': {
         level: 'error',
@@ -523,7 +531,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-title/g,
         className: '.kg-bookmark-title',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMDE': {
         level: 'error',
@@ -532,7 +541,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-description/g,
         className: '.kg-bookmark-description',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMME': {
         level: 'error',
@@ -541,7 +551,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-metadata/g,
         className: '.kg-bookmark-metadata',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMIC': {
         level: 'error',
@@ -550,7 +561,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-icon/g,
         className: '.kg-bookmark-icon',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMAU': {
         level: 'error',
@@ -559,7 +571,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-author/g,
         className: '.kg-bookmark-author',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMPU': {
         level: 'error',
@@ -568,7 +581,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-publisher/g,
         className: '.kg-bookmark-publisher',
-        css: true
+        css: true,
+        cardAsset: true
     },
     'GS050-CSS-KGBMTH': {
         level: 'error',
@@ -577,7 +591,8 @@ let rules = {
         Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/#bookmark-card" target=_blank>here</a>.`,
         regex: /\.kg-bookmark-thumbnail/g,
         className: '.kg-bookmark-thumbnail',
-        css: true
+        css: true,
+        cardAsset: true
     },
     // Updated v1 rules
     'GS001-DEPR-AC': {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gscan",
-  "version": "4.10.2",
+  "version": "4.11.0",
   "description": "Scans Ghost themes looking for errors, deprecations, features and compatibility",
   "keywords": [
     "ghost",
@@ -44,13 +44,13 @@
     "@tryghost/config": "0.2.0",
     "@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",