Fix: Add helpers directly to the site to allow cache

Ref #434

Author: Jesus David García Gomez

gulpfile.js

@@ -79,6 +79,11 @@ gulp.task('move:static', () => {
         .pipe(gulp.dest(`${dirs.tmp}/source/static`));
 });
 
+gulp.task('move:helpers', () => {
+    return gulp.src(`${dirs.tmp}/source/js/helpers/*.js`)
+        .pipe(gulp.dest(`${dirs.tmp}/helper`));
+});
+
 gulp.task('optimize:js', () => {
     return gulp.src(`${dirs.tmp}/source/**/*.js`)
         .pipe(plugins.uglify())
@@ -297,6 +302,7 @@ gulp.task('build', gulp.series(
     'optimize:js',
     'optimize:css',
     'move:static',
+    'move:helpers',
     'clean:after',
     'revfiles',
     'revreplace:content',

package.json

@@ -79,10 +79,10 @@
     "gulp": "gulp",
     "hexo:clean": "hexo clean",
     "lint": "npm-run-all lint:*",
-    "lint:browser": "eslint -c .eslintrc --env browser src/sonarwhal-theme/source/**/*.js",
+    "lint:browser": "eslint src/sonarwhal-theme/source/**/*.js",
     "lint:js": "npm run lint:node && npm run lint:browser",
     "lint:md": "markdownlint README.md ./src/hexo/source",
-    "lint:node": "eslint -c .eslintrc --env node **/*.js --ignore-pattern src/sonarwhal-theme/source/**/*.js --ignore-pattern src/sonarwhal-theme-optimized/**/*.js --ignore-pattern dist/**/*.js",
+    "lint:node": "eslint **/*.js --ignore-pattern src/sonarwhal-theme/source/**/*.js --ignore-pattern src/sonarwhal-theme-optimized/**/*.js --ignore-pattern dist/**/*.js",
     "lint:styles": "stylelint src/hexo/themes/sonarwhal/source/**/*.css --config .stylelintrc",
     "start": "npm run build -- watch",
     "watch": "gulp watch",

src/server/index.js

@@ -38,14 +38,14 @@ const createServer = () => {
     const themeDir = path.join(hexoDir, theme);
     const layoutsDir = path.join(themeDir, 'layout');
     const partialsDir = path.join(layoutsDir, 'partials');
+
+    /* Helpers path */
     const helpersPath = path.join(themeDir, 'helper/index.js');
-    const themeHelpers = require(helpersPath)();
-    const customHelpers = {
-        url_for: (url) => { // eslint-disable-line camelcase
-            return url;
-        }
-    };
-    const helpers = Object.assign(handlebars.helpers, themeHelpers, customHelpers); // combine helpers
+
+    /* Required Helpers */
+    const miscHelpers = require(helpersPath)();
+
+    const helpers = Object.assign(handlebars.helpers, miscHelpers); // Combine helpers
     const app = express();
 
     app.disable('x-powered-by');

src/sonarwhal-theme/helper/index.js

@@ -1,6 +1,15 @@
-/* eslint-disable object-shorthand, prefer-template */
-const Handlebars = require('handlebars');
+const globby = require('globby');
+const path = require('path');
+
 const pagination = require('./pagination');
+
+const basePath = path.join(__dirname, '..');
+const files = globby.sync(['helper/*.js', '**/helpers/*.js', '!helper/index.js', '!helper/pagination.js'], { cwd: basePath }); // eslint-disable-line no-sync
+
+const helpers = files.reduce((result, file) => {
+    return Object.assign(result, require(path.join(basePath, file)));
+}, {});
+
 const url = require('url');
 
 const jobStatus = {
@@ -30,10 +39,6 @@ module.exports = function () {
         return isIndexPage(page) && page.title.toLowerCase().replace(' ', '-') !== page.category;
     };
 
-    const normalizeString = (str) => {
-        return str.toLowerCase().replace(/[^a-z0-9]/gi, '-');
-    };
-
     const sortPageByAlpha = (l, r) => {
         if (l.title > r.title) {
             return 1;
@@ -75,138 +80,11 @@ module.exports = function () {
     };
 
     const self = {
-        /* eslint-disable object-shorthand */
-        capitalize: function (str) {
+        capitalize: (str) => {
             const filtered = str.replace(/[^a-zA-Z0-9]/g, ' ');
 
             return filtered.charAt(0).toUpperCase() + filtered.slice(1);
         },
-        /* eslint-enable object-shorthand */
-        /**
-         * Handlebars Comparison Helpers
-         * Copyright (c) 2013 Jon Schlinkert, Brian Woodward, contributors
-         * Licensed under the MIT License (MIT).
-         * https://github.com/helpers/handlebars-helpers/blob/a3683bab5519882927de527077c34a98ac22067b/lib/comparison.js#L48
-         * Modified to fit sonarwhal Website
-         */
-        /**
-         * {{#compare}}...{{/compare}}
-         *
-         * @credit: OOCSS
-         * @param left value
-         * @param operator The operator, must be between quotes ">", "=", "<=", etc...
-         * @param right value
-         * @param options option object sent by handlebars
-         * @return {String} formatted html
-         *
-         * @example:
-         *   {{#compare unicorns "<" ponies}}
-         *     I knew it, unicorns are just low-quality ponies!
-         *   {{/compare}}
-         *
-         *   {{#compare value ">=" 10}}
-         *     The value is greater or equal than 10
-         *     {{else}}
-         *     The value is lower than 10
-         *   {{/compare}}
-         */
-        compare: function (left, operator, right, options) { // eslint-disable-line object-shorthand
-            if (arguments.length < 3) {
-                throw new Error('Handlebars Helper "compare" needs 2 parameters');
-            }
-
-            /* eslint-disable no-param-reassign */
-            if (!options) {
-                options = right;
-                right = operator;
-                operator = '===';
-            }
-            /* eslint-enable no-param-reassign */
-
-            const operators = {
-                '!=': function (l, r) {
-                    return l !== r;
-                },
-                '!==': function (l, r) {
-                    return l !== r;
-                },
-                '<': function (l, r) {
-                    return l < r;
-                },
-                '<=': function (l, r) {
-                    return l <= r;
-                },
-                '==': function (l, r) {
-                    return l === r;
-                },
-                '===': function (l, r) {
-                    if (typeof l === 'string' && typeof r === 'string') {
-                        /* eslint-disable no-param-reassign */
-                        l = normalizeString(l);
-                        r = normalizeString(r);
-                        /* eslint-enable no-param-reassign */
-                    }
-
-                    return l === r;
-                },
-                '>': function (l, r) {
-                    return l > r;
-                },
-                '>=': function (l, r) {
-                    return l >= r;
-                },
-                includes: function (collection, member) {
-                    const normalizedR = member ? normalizeString(member) : member;
-                    const normalizedL = collection.split(/, */g).map(function (element) { //eslint-disable-line prefer-arrow-callback
-                        return normalizeString(element);
-                    });
-
-                    return normalizedL.indexOf(normalizedR) !== -1;
-                },
-                typeof: function (l, r) {
-                    return typeof l === r;
-                },
-                '||': function (l, r) {
-                    return l || r;
-                }
-            };
-
-            if (!operators[operator]) {
-                throw new Error('Handlebars Helper "compare" doesn\'t know the operator ' + operator);
-            }
-
-            const result = operators[operator](left, right);
-
-            if (result) {
-                return options.fn(this);
-            }
-
-            return options.inverse(this);
-        },
-        cutCodeString: function (codeString) {
-            return self.shortenString(codeString, 150);
-        },
-        cutString: function (string, maxLength) {
-            const minLength = 0.8 * maxLength;
-            const preferredStopChars = /[^a-zA-Z0-9]/g;
-            let chunk;
-
-            for (let i = minLength; i < maxLength; i++) {
-                // Start looking for preferred stop characters.
-                if (preferredStopChars.test(string[i])) {
-                    chunk = string.slice(0, i);
-
-                    break;
-                }
-            }
-
-            chunk = chunk || string.slice(0, maxLength);
-
-            return chunk;
-        },
-        cutUrlString: function (urlString) {
-            return self.shortenString(urlString, 25);
-        },
         filterErrorsAndWarnings: (results) => {
             if (!results) {
                 return results;
@@ -231,16 +109,10 @@ module.exports = function () {
             if (match) {
                 const ruleName = match.pop();
 
-                return 'packages/' + ruleName + '/README.md';
+                return `packages/${ruleName}/README.md`;
             }
 
-            return 'packages/sonarwhal/' + originalFile;
-        },
-        getLength: function (messages, unit) {
-            const length = messages.length;
-            const units = self.pluralize(unit, length);
-
-            return length + ' ' + units;
+            return `packages/sonarwhal/${originalFile}`;
         },
         getPagesByToCTitle: (title, pages) => {
             return pages[title].filter((page) => {
@@ -318,27 +190,6 @@ module.exports = function () {
         isPending: (status) => {
             return status === jobStatus.pending;
         },
-        linkify: function (msg) {
-            const regex = /(https?:\/\/[a-zA-Z0-9.\\/?:@\-_=#]+\.[a-zA-Z0-9&.\\/?:@-_=#]*)\s[a-zA-Z]/g;
-            // Modified use of regular expression in https://stackoverflow.com/a/39220764
-            // Should match:
-            // [email protected] has 2 known vulnerabilities (1 medium, 1 low). See https://snyk.io/vuln/npm:jquery for more information.
-            // [email protected] has 3 known vulnerabilities (3 high). See https://snyk.io/vuln/npm:angular for more information.
-            // Shouldn't match (shortened url):
-            // File https://www.odysys.com/ … hedule-Your-Demo-Now.png could be around 37.73kB (78%) smaller.
-            const match = regex.exec(msg);
-            const escapedMsg = Handlebars.Utils.escapeExpression(msg);
-
-            if (!match) {
-                return escapedMsg;
-            }
-
-            const urlMatch = match.pop();
-            const escapedUrlMatch = Handlebars.Utils.escapeExpression(urlMatch);
-            const newMsg = escapedMsg.replace(escapedUrlMatch, '<a href="' + urlMatch + '">' + escapedUrlMatch + '</a>');
-
-            return new Handlebars.SafeString(newMsg);
-        },
         noIssue: (category) => {
             return category.rules.every((rule) => {
                 return rule.status === ruleStatus.pass;
@@ -355,13 +206,6 @@ module.exports = function () {
             return className.toLowerCase().trim()
                 .replace(/[^a-z0-9]/gi, '-');
         },
-        normalizePosition: function (position) {
-            if (!position || parseInt(position) === -1) {
-                return '';
-            }
-
-            return ':' + position;
-        },
         or: (l, r) => {
             return l || r;
         },
@@ -375,13 +219,6 @@ module.exports = function () {
         passWarnings: (statistics) => {
             return statistics && statistics.warnings === 0;
         },
-        pluralize: function (text, count) {
-            return text + (count === 1 ? '' : 's');
-        },
-        reverseString: function (str) {
-            return str.split('').reverse()
-                .join('');
-        },
         sanitize: (permalink) => {
             return permalink.replace(/\/index.html/g, '/');
         },
@@ -390,18 +227,6 @@ module.exports = function () {
                 return accumulator || value;
             });
         },
-        // Solution inspired by https://stackoverflow.com/a/10903003
-        shortenString: function (string, maxLength) {
-            if (!string || string.length < maxLength * 2) {
-                return string;
-            }
-
-            const headChunk = self.cutString(string, maxLength);
-            const reverseTailChunk = self.cutString(self.reverseString(string), maxLength);
-            const tailChunk = self.reverseString(reverseTailChunk);
-
-            return headChunk + ' … ' + tailChunk;
-        },
         showMdContent: (page) => {
             // If the markdown Content should be used.
             const guildeIndexes = ['contributor guide', 'user guide'];
@@ -444,5 +269,5 @@ module.exports = function () {
         }
     };
 
-    return self;
+    return Object.assign(self, helpers);
 };

src/sonarwhal-theme/layout/partials/helpers.hbs

@@ -31,7 +31,14 @@
     <script src="/js/highlight/highlight.min.js"></script>
     <script src="/js/highlight/languages/xml.min.js"></script>
     <!-- endbuild -->
-    <script src="/scanner/helpers/compare,cutCodeString,cutString,cutUrlString,getLength,normalizePosition,pluralize,reverseString,shortenString,linkify"></script>
+    <!-- build:js /static/scripts/helpers.js -->
+    <script src="/js/helpers/compare.js"></script>
+    <script src="/js/helpers/cutstring.js"></script>
+    <script src="/js/helpers/getlength.js"></script>
+    <script src="/js/helpers/linkify.js"></script>
+    <script src="/js/helpers/normalizeposition.js"></script>
+    <script src="/js/helpers/compare.js"></script>
+    <!-- endbuild -->
     <!-- build:js /static/scripts/scanner.js -->
     <script src="/js/scanner-common.js"></script>
     <script src="/js/scanner-submit.js"></script>

src/sonarwhal-theme/layout/scan.hbs

@@ -17,7 +17,7 @@ hexo.extend.filter.register('before_post_render', (data) => {
      * For packages with multiple rules, we should have
      * links to each rules in the README.md
      * Those links will be transform:
-     * 
+     *
      * ./docs/rule-name.md => ./rule-name
      */
     data.content = data.content.replace(docLinkRegex, (link, docsString, extensionString) => {

src/sonarwhal-theme/scripts/link-filter.js

@@ -0,0 +1,21 @@
+{
+    "env": {
+        "browser": true,
+        "node": true,
+        "amd": false,
+        "mocha": false,
+        "jasmine": false,
+        "es6": false
+    },
+    "parserOptions": {
+        "ecmaVersion": 8,
+        "impliedStrict": true,
+        "sourceType": "module"
+    },
+    "rules": {
+        "no-var": "off",
+        "object-shorthand": "off",
+        "prefer-arrow-callback": "off",
+        "prefer-template": "off"
+    }
+}

src/sonarwhal-theme/source/.eslintrc

@@ -27,8 +27,6 @@
 
 /* global setImmediate */
 (function () {
-    'use strict';
-
     var supportDetails = 'open' in document.createElement('details');
 
     var animateOpen = function (parent, content) {

src/sonarwhal-theme/source/components/accordion/accordion.js

@@ -1,5 +1,3 @@
-/* eslint-env browser */
-/* eslint-disable no-var, prefer-template, strict, prefer-arrow-callback, object-shorthand, no-continue */
 (function () {
     /** Creates a cookie. Code based on https://www.quirksmode.org/js/cookies.html */
     var createCookie = function (name, value, days) {