gscan 4.20.2 → 4.21.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2021 Ghost Foundation
+Copyright (c) 2013-2022 Ghost Foundation
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

package/README.md

@@ -114,4 +114,4 @@ gscan.checkZip({
 
 # Copyright & License
 
-Copyright (c) 2013-2021 Ghost Foundation - Released under the [MIT license](LICENSE). Ghost and the Ghost Logo are trademarks of Ghost Foundation Ltd. Please see our [trademark policy](https://ghost.org/trademark/) for info on acceptable usage.
+Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE). Ghost and the Ghost Logo are trademarks of Ghost Foundation Ltd. Please see our [trademark policy](https://ghost.org/trademark/) for info on acceptable usage.

package/app/public/safari-pinned-tab.svg

@@ -0,0 +1,28 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
+ "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
+<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
+ width="512.000000pt" height="512.000000pt" viewBox="0 0 512.000000 512.000000"
+ preserveAspectRatio="xMidYMid meet">
+<metadata>
+Created by potrace 1.14, written by Peter Selinger 2001-2017
+</metadata>
+<g transform="translate(0.000000,512.000000) scale(0.100000,-0.100000)"
+fill="#000000" stroke="none">
+<path d="M2175 5114 c-710 -35 -1152 -142 -1481 -359 -397 -263 -605 -746
+-674 -1565 -6 -69 -13 -285 -17 -480 -15 -925 66 -1475 278 -1881 276 -527
+827 -767 1884 -820 251 -13 845 -7 1055 11 1085 90 1560 424 1770 1245 99 387
+138 839 127 1465 -11 582 -55 933 -158 1255 -179 562 -504 859 -1106 1011
+-200 50 -401 82 -673 105 -123 10 -867 20 -1005 13z m530 -604 c371 -31 710
+-154 1008 -367 97 -70 278 -241 359 -340 481 -589 575 -1404 241 -2078 -271
+-547 -759 -921 -1372 -1052 -118 -26 -142 -27 -381 -27 -240 0 -263 1 -383 27
+-548 117 -987 422 -1282 892 -292 465 -365 1067 -194 1603 134 417 407 775
+785 1027 255 171 594 288 906 314 149 12 172 12 313 1z"/>
+<path d="M2425 4124 c-315 -48 -569 -134 -755 -254 -81 -53 -218 -185 -276
+-266 -59 -82 -137 -248 -169 -359 -14 -49 -35 -146 -46 -215 -19 -116 -44
+-243 -91 -450 -29 -127 -34 -314 -13 -441 46 -275 164 -501 369 -704 202 -200
+419 -317 699 -376 121 -26 374 -32 472 -11 297 63 813 327 1112 569 172 139
+289 280 367 444 60 124 86 227 93 371 16 317 -103 589 -448 1026 -68 86 -169
+202 -224 258 -159 160 -381 297 -599 369 -170 57 -305 68 -491 39z"/>
+</g>
+</svg>

package/app/tpl/layouts/default.hbs

@@ -13,7 +13,12 @@
 
     <link rel="stylesheet" href="/gscan.css?v=1">
 
-    <link rel="icon" type="image/png" sizes="32x32" href="/favicon.png">
+    <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
+    <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
+    <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
+    <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#0d1013">
+    <meta name="msapplication-TileColor" content="#0d1013">
+    <meta name="theme-color" content="#ffffff">
 
     <meta name="HandheldFriendly" content="True">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">

package/lib/ast-linter/linter.js

@@ -6,17 +6,19 @@ class Linter {
     /**
      *
      * @param {Object} [options]
-     * @param {string[]} options.partials - list of known theme partial names in ['mypartial', 'logo'] format
-     * @param {string[]} options.helpers - list of registered theme helper names in ['is', 'has'] format
-     * @param {Object} options.customThemeSettings - list of registered custom theme settings in {'main_accent':{}} format
+     * @param {string[]?} options.partials - list of known theme partial names in ['mypartial', 'logo'] format
+     * @param {string[]?} options.helpers - list of registered theme helper names in ['is', 'has'] format
+     * @param {string[]?} options.inlinePartials - list of known local partial names in ['mypartial', 'logo'] format
+     * @param {Object?} options.customThemeSettings - list of registered custom theme settings in {'main_accent':{}} format
      */
-    constructor(options = {partials: [], helpers: [], customThemeSettings: {}}) {
+    constructor(options = {partials: [], helpers: [], inlinePartials: [], customThemeSettings: {}}) {
         this.options = options;
         // Ignore OS-specific path separator as Handlebars only uses forward-separators in its syntax
         this.options.partials = this.options.partials.map(partial => normalizePath(partial));
 
         this.partials = [];
         this.helpers = [];
+        this.inlinePartials = [];
         this.customThemeSettings = [];
     }
 
@@ -40,6 +42,7 @@ class Linter {
                 source: config.source,
                 partials: this.options.partials,
                 helpers: this.options.helpers,
+                inlinePartials: this.options.inlinePartials,
                 customThemeSettings: this.options.customThemeSettings
             });
 
@@ -53,6 +56,7 @@ class Linter {
             this.context = {
                 partials: [],
                 helpers: [],
+                inlinePartials: [],
                 customThemeSettings: []
             };
         }
@@ -65,12 +69,12 @@ class Linter {
             'PartialStatement',
             'PartialBlockStatement',
             'PathExpression',
-            'SubExpression'
+            'SubExpression',
+            'DecoratorBlock'
             // the following types are not used in Ghost or we don't validate
             // 'ContentStatement',
             // 'CommentStatement,
             // 'Decorator',
-            // 'DecoratorBlock'
         ];
 
         nodeTypes.forEach((nodeType) => {
@@ -153,6 +157,10 @@ class Linter {
             this.customThemeSettings = scanner.context.customThemeSettings;
         }
 
+        if (scanner.context.inlinePartials) {
+            this.inlinePartials = scanner.context.inlinePartials;
+        }
+
         return messages;
     }
 }

package/lib/ast-linter/rules/base.js

@@ -7,6 +7,7 @@ module.exports = class BaseRule {
         this.source = options.source;
         this.partials = options.partials;
         this.helpers = options.helpers;
+        this.inlinePartials = options.inlinePartials || [];
         this.customThemeSettings = options.customThemeSettings;
     }
 
@@ -27,7 +28,8 @@ module.exports = class BaseRule {
             'PartialStatement',
             'PartialBlockStatement',
             'PathExpression',
-            'SubExpression'
+            'SubExpression',
+            'DecoratorBlock'
         ];
 
         // this object keeps an array of functions for each node type, eventually
@@ -111,8 +113,44 @@ module.exports = class BaseRule {
         this._log(reportedResult);
     }
 
-    isValidPartialReference(node) {
-        return node.name.original === '@partial-block' || this.partials.includes(node.name.original);
+    isValidPartialReference(node, parents) {
+        return node.name.original === '@partial-block'
+            || this.partials.includes(node.name.original)
+            || this.isAccessibleInlinePartial(node, parents);
+    }
+
+    // Make sure one inline partial match the partial usage
+    isAccessibleInlinePartial(node, parents) {
+        const parentNodes = parents || [];
+        return this.inlinePartials.some((partial) => {
+            if (partial.node !== node.name.original) {
+                return false;
+            }
+
+            //filter candidates so that the inline partial is in the same scope as where it's used
+            for (let i = 0; i < partial.parents.length; i++) {
+                const declarationParent = partial.parents[i];
+                for (let j = 0; j < parentNodes.length; j++) {
+                    const usageParent = parentNodes[j];
+
+                    // If we found a common ancestor, we're good
+                    // To compare two nodes, we check the type of the node and the location of the code
+                    if (usageParent.type === declarationParent.type &&
+                        usageParent.loc.source === declarationParent.loc.source &&
+                        usageParent.loc.start.line === declarationParent.loc.start.line &&
+                        usageParent.loc.start.column === declarationParent.loc.start.column &&
+                        usageParent.loc.end.line === declarationParent.loc.end.line &&
+                        usageParent.loc.end.column === declarationParent.loc.end.column) {
+                        return true;
+                    }
+
+                    // If we found a block before finding a common ancestor, the usage can't access the declaration
+                    if (['BlockStatement','PartialBlockStatement','DecoratorBlock'].includes(declarationParent.type)) {
+                        return false;
+                    }
+                }
+            }
+        });
     }
 
     isValidHelperReference(nodeName) {

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

@@ -2,14 +2,32 @@ const Rule = require('./base');
 const {getPartialName} = require('../helpers');
 
 module.exports = class NoUnknownPartials extends Rule {
-    _checkForUnknownPartials(node) {
+    _checkForUnknownPartials(node, visitor) {
         if (node.name) {
-            if (!this.isValidPartialReference(node)) {
-                this.log({
-                    message: `The partial ${getPartialName(node)} could not be found`,
+            if (!this.isValidPartialReference(node, visitor.parents)) {
+                const logObject = {
                     line: node.loc && node.loc.start.line,
                     column: node.loc && node.loc.start.column,
                     source: this.sourceForNode(node)
+                };
+
+                // Dynamic partials (https://handlebarsjs.com/guide/partials.html#dynamic-partials)
+                if (node.name.type === 'SubExpression') {
+                    if (node.type === 'PartialBlockStatement') {
+                        // A dynamic partial is valid when declared as a block
+                        return;
+                    }
+                    if (node.type === 'PartialStatement') {
+                        return this.log({
+                            message: `Inlined dynamic partials like <code>{{> (dynamicPartial) }}</code> can result in page errors if the partial does not exist, use block dynamic partials instead.`,
+                            ...logObject
+                        });
+                    }
+                }
+
+                this.log({
+                    message: `The partial ${getPartialName(node)} could not be found`,
+                    ...logObject
                 });
             }
         }

package/lib/ast-linter/rules/mark-declared-inline-partials.js

@@ -0,0 +1,26 @@
+const Rule = require('./base');
+const get = require('lodash/get');
+
+module.exports = class MarkDeclaredInlinePartials extends Rule {
+    _markDeclaredInlinePartials(node, visitor) {
+        if (get(node, 'path.original') === 'inline' && get(node, 'params.length') > 0) {
+            const nodeName = get(node, 'params[0].original');
+            this.scanner.context.inlinePartials.push({
+                node: nodeName,
+                parents: visitor.parents.map(p => ({
+                    type: p.type,
+                    loc: p.loc
+                })),
+                type: node.type,
+                loc: node.loc,
+                parameters: node.params ? node.params.map(p => p.original) : null
+            });
+        }
+    }
+
+    visitor() {
+        return {
+            DecoratorBlock: this._markDeclaredInlinePartials.bind(this)
+        };
+    }
+};

package/lib/checks/005-template-compile.js

@@ -14,6 +14,22 @@ function processFileFunction(files, failures, theme, partialsFound) {
 
         processedFiles.push(themeFile.file);
 
+        // Reset inline partial variables
+        linter.inlinePartials = [];
+        linter.options.inlinePartials = [];
+
+        linter.verify({
+            parsed: themeFile.parsed,
+            rules: [
+                require('../ast-linter/rules/mark-declared-inline-partials')
+            ],
+            source: themeFile.content,
+            moduleId: themeFile.file
+        });
+
+        // Store the inline partials for the actual partial linting
+        linter.options.inlinePartials = linter.inlinePartials;
+
         const astResults = linter.verify({
             parsed: themeFile.parsed,
             rules: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gscan",
-  "version": "4.20.2",
+  "version": "4.21.0",
   "description": "Scans Ghost themes looking for errors, deprecations, features and compatibility",
   "keywords": [
     "ghost",
@@ -41,12 +41,12 @@
   },
   "dependencies": {
     "@sentry/node": "6.16.1",
-    "@tryghost/config": "0.2.1",
-    "@tryghost/debug": "0.1.9",
+    "@tryghost/config": "0.2.2",
+    "@tryghost/debug": "0.1.10",
     "@tryghost/ignition-errors": "0.1.8",
-    "@tryghost/logging": "2.0.0",
+    "@tryghost/logging": "2.0.1",
     "@tryghost/pretty-cli": "1.2.22",
-    "@tryghost/server": "0.1.3",
+    "@tryghost/server": "0.1.4",
     "@tryghost/zip": "1.1.18",
     "bluebird": "3.7.2",
     "chalk": "4.1.2",