gscan 4.29.0 → 4.30.0

package/lib/specs/v3.js

@@ -2,8 +2,9 @@ const _ = require('lodash');
 const oneLineTrim = require('common-tags/lib/oneLineTrim');
 const previousSpec = require('./v2');
 const ghostVersions = require('../utils').versions;
-const docsBaseUrl = `https://ghost.org/docs/api/handlebars-themes/`;
-const faqBaseUrl = `https://ghost.org/faq/`;
+const docsBaseUrl = `https://ghost.org/docs/themes/`;
+// TODO: we don't use versioned docs anymore and the previous rules should only contain
+// correct links. The usage of replacing the previousBaseUrl can probably be removed
 const prevDocsBaseUrl = `https://themes.ghost.org/v${ghostVersions.v2.docs}/docs/`;
 const prevDocsBaseUrlRegEx = new RegExp(prevDocsBaseUrl, 'g');
 
@@ -21,14 +22,14 @@ let rules = {
         rule: '<code>package.json</code> property <code>"engines.ghost-api"</code> is recommended. Otherwise, it falls back to "v3"',
         details: oneLineTrim`Please add <code>"ghost-api"</code> to your <code>package.json</code>. E.g. <code>{"engines": {"ghost-api": "v3"}}</code>.<br>
         If no <code>"ghost-api"</code> property is provided, Ghost will use its default setting of "v3" Ghost API.<br>
-        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
+        Check the <a href="${docsBaseUrl}structure/#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 "v3"',
         details: oneLineTrim`Please change <code>"ghost-api"</code> in your <code>package.json</code> to higher version. E.g. <code>{"engines": {"ghost-api": "v3"}}</code>.<br>
         If <code>"ghost-api"</code> property is left at "v0.1", Ghost will use its default setting of "v3".<br>
-        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
+        Check the <a href="${docsBaseUrl}structure/#packagejson" target=_blank><code>package.json</code> documentation</a> for further information.`
     },
     'GS001-DEPR-ESC': {
         level: 'error',
@@ -43,7 +44,7 @@ let rules = {
         level: 'error',
         rule: 'The v0.1 API and <code>ghost.url.api()</code> JavaScript helper have been removed.',
         details: oneLineTrim`The v0.1 API & Public API Beta have been removed, along with the <code>public/ghost-sdk.min.js</code> file & the <code>ghost.url.api()</code> helper.<br>
-        All code relying on the v0.1 API must be upgraded to use the <a href="${faqBaseUrl}upgrades/" target=_blank>new API</a>.`,
+        All code relying on the v0.1 API must be upgraded to use the <a href="https://ghost.org/docs/changes/" target=_blank>new API</a>.`,
         regex: /ghost\.url\.api/g
     },
     'GS070-VALID-TRANSLATIONS': {

package/lib/specs/v4.js

@@ -3,6 +3,8 @@ const oneLineTrim = require('common-tags/lib/oneLineTrim');
 const previousSpec = require('./v3');
 const ghostVersions = require('../utils').versions;
 const docsBaseUrl = `https://ghost.org/docs/themes/`;
+// TODO: we don't use versioned docs anymore and the previous rules should only contain
+// correct links. The usage of replacing the previousBaseUrl can probably be removed
 const prevDocsBaseUrl = `https://themes.ghost.org/v${ghostVersions.v3.docs}/docs/`;
 const prevDocsBaseUrlRegEx = new RegExp(prevDocsBaseUrl, 'g');
 
@@ -15,7 +17,7 @@ function cssCardRule(cardName, className) {
         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 the ${cardName} card will appear unstyled.
-        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}editor/" target=_blank>here</a>.`,
+        Find out more about required theme changes for the Koenig editor <a href="${docsBaseUrl}content/" target=_blank>here</a>.`,
         regex: new RegExp(`\\.${className}`, 'g'),
         className: `.${className}`,
         css: true,
@@ -33,75 +35,75 @@ let rules = {
         rule: '<code>package.json</code> property <code>"engines.ghost-api"</code> is deprecated.',
         details: oneLineTrim`Remove <code>"ghost-api"</code> from your <code>package.json</code>.<br>
         The <code>ghost-api</code> support will be removed in next major version of Ghost and should not be used.
-        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
+        Check the <a href="${docsBaseUrl}structure/#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`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.`
+        Check the <a href="${docsBaseUrl}structure/#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`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.`
+        Check the <a href="${docsBaseUrl}structure/#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`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.`
+        Check the <a href="${docsBaseUrl}structure/#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`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.`
+        Check the <a href="${docsBaseUrl}structure/#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`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.`
+        Check the <a href="${docsBaseUrl}structure/#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`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.`
+        Check the <a href="${docsBaseUrl}structure/#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`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.`
+        Check the <a href="${docsBaseUrl}structure/#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`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.`
+        Check the <a href="${docsBaseUrl}structure/#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`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.`
+        Check the <a href="${docsBaseUrl}structure/#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`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.`
+        Check the <a href="${docsBaseUrl}structure/#packagejson" target=_blank><code>package.json</code> documentation</a> for further information.`
     },
     'GS010-PJ-CUST-THEME-SETTINGS-IMAGE-DEFAULT': {
         level: 'error',
         rule: '<code>package.json</code> objects defined in <code>"config.custom"</code> of type <code>"image"</code> can\'t have a <code>"default"</code> value.',
         details: oneLineTrim`Make sure the <code>"default"</code> property is either <code>null</code>, an empty string <code>''</code> or isn't present.<br>
-        Check the <a href="${docsBaseUrl}packagejson/" target=_blank><code>package.json</code> documentation</a> for further information.`
+        Check the <a href="${docsBaseUrl}structure/#packagejson" target=_blank><code>package.json</code> documentation</a> for further information.`
     },
     'GS001-DEPR-LABS-MEMBERS': {
         level: 'warning',
@@ -114,8 +116,8 @@ let rules = {
     },
     'GS080-FEACH-POSTS': {
         level: 'warning',
-        rule: 'The default visibility for posts in <code>{{#foreach}}</code> block helper has changed in v4.',
-        details: oneLineTrim`The default visibility for posts in <code>{{#foreach}}</code> block helper has changed from <code>public</code> to <code>all</code> in Ghost v4.
+        rule: 'The default visibility for posts in <code>{{#foreach}}</code> block helper changed in Ghost v4.',
+        details: oneLineTrim`The default visibility for posts in <code>{{#foreach}}</code> block helper changed from <code>public</code> to <code>all</code>.<br>
         Find more information about the <code>{{foreach}}</code> helper <a href="${docsBaseUrl}helpers/foreach/" target=_blank>here</a>.`,
         regex: /{{\s*?#foreach\s*?\w*?\s*?}}/g,
         helper: '{{#foreach}}',
@@ -133,7 +135,7 @@ let rules = {
     'GS080-FEACH-PV': {
         level: 'recommendation',
         rule: 'The use of <code>visibility="all"</code> is no longer required for posts in <code>{{#foreach}}</code> helper.',
-        details: oneLineTrim`The default visibility in <code>{{#foreach}}</code> helper for posts has changed in v4 from "public" to "all" and is no longer required when looping over posts.
+        details: oneLineTrim`The default visibility in <code>{{#foreach}}</code> helper for posts changed in v4 from <code>public</code> to <code>all</code> and is no longer required when looping over posts.<br>
         Check out the documentation for <code>{{#foreach}}</code> <a href="${docsBaseUrl}helpers/foreach/" target=_blank>here</a>.`,
         regex: /{{\s*?#foreach\b[\w\s='"]*?visibility=("|')all("|')[\w\s='"]*?}}/g,
         helper: '{{#foreach}}',

package/lib/utils/score-calculator.js

@@ -0,0 +1,40 @@
+const _ = require('lodash');
+
+const levelWeights = {
+    error: 10,
+    warning: 3,
+    recommendation: 1
+};
+
+/**
+ *
+ * @param {Object} results
+ * @param {Object} results.error
+ * @param {Object} results.warning
+ * @param {Object} results.recommendation
+ * @param {Object} stats
+ * @param {Object} stats.error
+ * @param {Object} stats.warning
+ * @param {Object} stats.recommendation
+* @returns {Object}
+ */
+const calcScore = function calcScore(results, stats) {
+    var maxScore, actualScore, balancedScore;
+
+    maxScore = _.reduce(levelWeights, function (max, weight, level) {
+        return max + (weight * stats[level]);
+    }, 0);
+
+    actualScore = _.reduce(levelWeights, function (max, weight, level) {
+        return max - (weight * _.size(results[level]));
+    }, maxScore);
+
+    balancedScore = _.floor((100 / maxScore) * actualScore);
+
+    return {
+        value: balancedScore,
+        level: _.size(results.error) > 0 ? 'error' : balancedScore < 60 ? 'warning' : 'passing'
+    };
+};
+
+module.exports = calcScore;

package/lib/utils/versions.json

@@ -19,5 +19,5 @@
     "major": "5.x",
     "docs": "5.0.0"
   },
-  "default": "v4"
+  "default": "v5"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gscan",
-  "version": "4.29.0",
+  "version": "4.30.0",
   "description": "Scans Ghost themes looking for errors, deprecations, features and compatibility",
   "keywords": [
     "ghost",
@@ -8,7 +8,7 @@
     "validator",
     "lint"
   ],
-  "homepage": "https://ghost.org",
+  "homepage": "https://ghost.org/",
   "repository": {
     "type": "git",
     "url": "git@github.com:TryGhost/gscan.git"
@@ -22,7 +22,7 @@
   "author": {
     "name": "Ghost Foundation",
     "email": "hello@ghost.org",
-    "web": "https://ghost.org"
+    "web": "https://ghost.org/"
   },
   "main": "lib",
   "license": "MIT",
@@ -45,7 +45,7 @@
     "@tryghost/debug": "0.1.11",
     "@tryghost/errors": "1.2.12",
     "@tryghost/logging": "2.1.8",
-    "@tryghost/pretty-cli": "1.2.27",
+    "@tryghost/pretty-cli": "1.2.28",
     "@tryghost/server": "0.1.4",
     "@tryghost/zip": "1.1.25",
     "bluebird": "3.7.2",