gscan 4.12.0 → 4.13.3

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/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 = [];
@@ -18,70 +31,70 @@ let rules = {
     'GS010-PJ-GHOST-API': {
         level: 'warning',
         rule: '<code>package.json</code> property <code>"engines.ghost-api"</code> is recommended. Otherwise, it falls back to "v4"',
-        details: oneLineTrim`Please add <code>"ghost-api"</code> to your <code>package.json</code>. E.g. <code>{"engines": {"ghost-api": "v4"}}</code>.<br>
+        details: oneLineTrim`Add <code>"ghost-api"</code> to your <code>package.json</code>. E.g. <code>{"engines": {"ghost-api": "v4"}}</code>.<br>
         If no <code>"ghost-api"</code> property is provided, Ghost will use its default setting of "v4" Ghost API.<br>
         Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
     },
     'GS010-PJ-GHOST-API-V01': {
         level: 'error',
         rule: '<code>package.json</code> property <code>"engines.ghost-api"</code> is incompatible with current version of Ghost API and will fall back to "v4"',
-        details: oneLineTrim`Please change <code>"ghost-api"</code> in your <code>package.json</code> to higher version. E.g. <code>{"engines": {"ghost-api": "v4"}}</code>.<br>
+        details: oneLineTrim`Change <code>"ghost-api"</code> in your <code>package.json</code> to higher version. E.g. <code>{"engines": {"ghost-api": "v4"}}</code>.<br>
         If <code>"ghost-api"</code> property is left at "v0.1", Ghost will use its default setting of "v4".<br>
         Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
     },
     'GS010-PJ-GHOST-API-V2': {
         level: 'warning',
         rule: '<code>package.json</code> property <code>"engines.ghost-api"</code> is using a deprecated version of Ghost API',
-        details: oneLineTrim`Please change <code>"ghost-api"</code> in your <code>package.json</code> to higher version. E.g. <code>{"engines": {"ghost-api": "v4"}}</code>.<br>
+        details: oneLineTrim`Change <code>"ghost-api"</code> in your <code>package.json</code> to higher version. E.g. <code>{"engines": {"ghost-api": "v4"}}</code>.<br>
         If <code>"ghost-api"</code> property is left at "v2", it will stop working with next major version upgrade and default to v5.<br>
         Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
     },
     'GS010-PJ-CUST-THEME-TOTAL-SETTINGS': {
         level: 'error',
         rule: '<code>package.json</code> property <code>"config.custom"</code> contains too many settings',
-        details: oneLineTrim`Please remove key from <code>"config.custom"</code> in your <code>package.json</code> to have less than or exactly 15 settings.<br>
+        details: oneLineTrim`Remove key from <code>"config.custom"</code> in your <code>package.json</code> to have less than or exactly 15 settings.<br>
         Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
     },
     'GS010-PJ-CUST-THEME-SETTINGS-CASE': {
         level: 'error',
         rule: '<code>package.json</code> property <code>"config.custom"</code> contains a property that isn\'t snake-cased',
-        details: oneLineTrim`Please rewrite all property in <code>"config.custom"</code> in your <code>package.json</code> in snake case.<br>
+        details: oneLineTrim`Rewrite all property in <code>"config.custom"</code> in your <code>package.json</code> in snake case.<br>
         Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
     },
     'GS010-PJ-CUST-THEME-SETTINGS-TYPE': {
         level: 'error',
         rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> should have a known <code>"type"</code>.',
-        details: oneLineTrim`Please only use the following types: <code>"select"</code>, <code>"boolean"</code>, <code>"color"</code>, <code>"image"</code>, <code>"text"</code>.<br>
+        details: oneLineTrim`Only use the following types: <code>"select"</code>, <code>"boolean"</code>, <code>"color"</code>, <code>"image"</code>, <code>"text"</code>.<br>
         Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
     },
     'GS010-PJ-CUST-THEME-SETTINGS-GROUP': {
         level: 'recommendation',
         rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> should have a known <code>"group"</code>.',
-        details: oneLineTrim`Please only use the following groups: <code>"post"</code>, <code>"homepage"</code>.<br>
+        details: oneLineTrim`Only use the following groups: <code>"post"</code>, <code>"homepage"</code>.<br>
         Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
     },
     'GS010-PJ-CUST-THEME-SETTINGS-SELECT-OPTIONS': {
         level: 'error',
         rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> of type <code>"select"</code> need to have at least 2 <code>"options"</code>.',
-        details: oneLineTrim`Please make sure there is at least 2 <code>"options"</code> in each <code>"select"</code> custom theme property.<br>
+        details: oneLineTrim`Make sure there is at least 2 <code>"options"</code> in each <code>"select"</code> custom theme property.<br>
         Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
     },
     'GS010-PJ-CUST-THEME-SETTINGS-SELECT-DEFAULT': {
         level: 'error',
         rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> of type <code>"select"</code> need to have a valid <code>"default"</code>.',
-        details: oneLineTrim`Please make sure the <code>"default"</code> property matches a value in <code>"options"</code> of the same <code>"select"</code>.<br>
+        details: oneLineTrim`Make sure the <code>"default"</code> property matches a value in <code>"options"</code> of the same <code>"select"</code>.<br>
         Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
     },
     'GS010-PJ-CUST-THEME-SETTINGS-BOOLEAN-DEFAULT': {
         level: 'error',
         rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> of type <code>"boolean"</code> need to have a valid <code>"default"</code>.',
-        details: oneLineTrim`Please make sure the <code>"default"</code> property is either <code>true</code> or <code>false</code>.<br>
+        details: oneLineTrim`Make sure the <code>"default"</code> property is either <code>true</code> or <code>false</code>.<br>
         Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
     },
     'GS010-PJ-CUST-THEME-SETTINGS-COLOR-DEFAULT': {
         level: 'error',
         rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> of type <code>"color"</code> need to have a valid <code>"default"</code>.',
-        details: oneLineTrim`Please make sure the <code>"default"</code> property is either <code>null</code>, an empty string <code>''</code> or a valid 6-hexadecimal-digit color code like <code>#15171a</code>.<br>
+        details: oneLineTrim`Make sure the <code>"default"</code> property is a valid 6-hexadecimal-digit color code like <code>#15171a</code>.<br>
         Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
     },
     'GS010-PJ-CUST-THEME-SETTINGS-IMAGE-DEFAULT': {
@@ -93,7 +106,7 @@ let rules = {
     'GS001-DEPR-LABS-MEMBERS': {
         level: 'warning',
         rule: 'The <code>{{@labs.members}}</code> helper should not be used.',
-        details: oneLineTrim`Please remove <code>{{@labs.members}}</code> from the theme.<br>
+        details: oneLineTrim`Remove <code>{{@labs.members}}</code> from the theme.<br>
         The <code>{{@labs.members}}</code> helper will always return <code>true</code> in Ghost v4 and will be removed from Ghost v5, at which point it will return <code>null</code> and evaluate to <code>false</code>.
         Find more information about the <code>@labs</code> property <a href="${docsBaseUrl}helpers/labs/" target=_blank>here</a>.`,
         regex: /@labs\.members/g,
@@ -137,7 +150,7 @@ let rules = {
     'GS001-DEPR-SITE-LANG': {
         level: 'warning',
         rule: 'The <code>{{@site.lang}}</code> helper should be replaced with <code>{{@site.locale}}</code>',
-        details: oneLineTrim`Please replace <code>{{@site.lang}}</code> helper with <code>{{@site.locale}}</code>.<br>
+        details: oneLineTrim`Replace <code>{{@site.lang}}</code> helper with <code>{{@site.locale}}</code>.<br>
         The <code>{{@site.lang}}</code> helper will be removed in next version of Ghost and should not be used.
         Find more information about the <code>@site</code> property <a href="${docsBaseUrl}helpers/site/" target=_blank>here</a>.`,
         regex: /@site\.lang/g,
@@ -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/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.12.0",
+  "version": "4.13.3",
   "description": "Scans Ghost themes looking for errors, deprecations, features and compatibility",
   "keywords": [
     "ghost",
@@ -44,7 +44,7 @@
     "@tryghost/config": "0.2.1",
     "@tryghost/debug": "0.1.9",
     "@tryghost/ignition-errors": "0.1.8",
-    "@tryghost/logging": "1.0.1",
+    "@tryghost/logging": "1.0.2",
     "@tryghost/pretty-cli": "1.2.22",
     "@tryghost/server": "0.1.0",
     "@tryghost/zip": "1.1.18",