Fix ESLint errors

Author: jhildenbiddle

.eslintrc.js

@@ -38,7 +38,12 @@ module.exports = {
     'no-return-assign': ['error'],
     'no-self-compare': ['error'],
     'no-shadow-restricted-names': ['error'],
-    'no-shadow': ['warn'],
+    'no-shadow': [
+      'error',
+      {
+        allow: ['Events', 'Fetch', 'Lifecycle', 'Render', 'Router'],
+      },
+    ],
     'no-unused-vars': ['error', { args: 'none' }],
     'no-useless-call': ['error'],
     'no-useless-escape': ['warn'],

src/core/config.js

@@ -3,7 +3,7 @@ import { merge, hyphenate, isPrimitive, hasOwn } from './util/core';
 const currentScript = document.currentScript;
 
 /** @param {import('./Docsify').Docsify} vm */
-export default function(vm) {
+export default function (vm) {
   const config = merge(
     {
       el: '#app',

src/core/fetch/ajax.js

@@ -13,7 +13,7 @@ const cache = {};
  */
 export function get(url, hasBar = false, headers = {}) {
   const xhr = new XMLHttpRequest();
-  const on = function() {
+  const on = function () {
     xhr.addEventListener.apply(xhr, arguments);
   };
 
@@ -33,7 +33,7 @@ export function get(url, hasBar = false, headers = {}) {
   xhr.send();
 
   return {
-    then: function(success, error = noop) {
+    then: function (success, error = noop) {
       if (hasBar) {
         const id = setInterval(
           _ =>

src/core/fetch/index.js

@@ -152,11 +152,9 @@ export function Fetch(Base) {
         if (path) {
           path = this.router.getFile(root + path);
           this.coverIsHTML = /\.html$/g.test(path);
-          get(
-            path + stringifyQuery(query, ['id']),
-            false,
-            requestHeaders
-          ).then(text => this._renderCover(text, coverOnly));
+          get(path + stringifyQuery(query, ['id']), false, requestHeaders).then(
+            text => this._renderCover(text, coverOnly)
+          );
         } else {
           this._renderCover(null, coverOnly);
         }

src/core/global-api.js

@@ -10,7 +10,7 @@ import { get } from './fetch/ajax';
 // major release. We'll tell people to get everything from the DOCSIFY global
 // when using the global build, but we'll highly recommend for them to import
 // from the ESM build (f.e. lib/docsify.esm.js and lib/docsify.min.esm.js).
-export default function() {
+export default function () {
   window.Docsify = {
     util,
     dom,

src/core/init/lifecycle.js

@@ -30,7 +30,7 @@ export function Lifecycle(Base) {
     callHook(hookName, data, next = noop) {
       const queue = this._hooks[hookName];
 
-      const step = function(index) {
+      const step = function (index) {
         const hookFn = queue[index];
 
         if (index >= queue.length) {

src/core/render/compiler.js

@@ -28,8 +28,9 @@ const compileMedia = {
   },
   iframe(url, title) {
     return {
-      html: `<iframe src="${url}" ${title ||
-        'width=100% height=400'}></iframe>`,
+      html: `<iframe src="${url}" ${
+        title || 'width=100% height=400'
+      }></iframe>`,
     };
   },
   video(url, title) {
@@ -204,7 +205,7 @@ export class Compiler {
      * @param {Number} level Type of heading (h<level> tag)
      * @returns {String} Heading element
      */
-    origin.heading = renderer.heading = function(text, level) {
+    origin.heading = renderer.heading = function (text, level) {
       let { str, config } = getAndRemoveConfig(text);
       const nextToc = { level, title: removeAtag(str) };
 

src/core/render/compiler/code.js

@@ -3,7 +3,7 @@ import Prism from 'prismjs';
 import 'prismjs/components/prism-markup-templating';
 
 export const highlightCodeCompiler = ({ renderer }) =>
-  (renderer.code = function(code, lang = 'markup') {
+  (renderer.code = function (code, lang = 'markup') {
     const langOrMarkup = Prism.languages[lang] || Prism.languages.markup;
     const text = Prism.highlight(
       code.replace(/@DOCSIFY_QM@/g, '`'),

src/core/render/embed.js

@@ -15,7 +15,7 @@ function walkFetchEmbed({ embedTokens, compile, fetch }, cb) {
 
   while ((token = embedTokens[step++])) {
     // eslint-disable-next-line no-shadow
-    const next = (function(token) {
+    const next = (function (token) {
       return text => {
         let embedToken;
         if (text) {

src/core/render/emojify.js

@@ -15,6 +15,6 @@ export function emojify(text) {
     .replace(/<(pre|template|code)[^>]*?>[\s\S]+?<\/(pre|template|code)>/g, m =>
       m.replace(/:/g, '__colon__')
     )
-    .replace(/:([a-z0-9_\-\+]+?):/g, (inBrowser && window.emojify) || replace)
+    .replace(/:([a-z0-9_\-+]+?):/g, (inBrowser && window.emojify) || replace)
     .replace(/__colon__/g, ':');
 }

src/core/render/index.js

@@ -174,7 +174,7 @@ function renderMain(html) {
             // This provides a global store for all Vue instances that receive
             // vueGlobalOptions as their configuration.
             if (vueGlobalData) {
-              vueConfig.data = function() {
+              vueConfig.data = function () {
                 return vueGlobalData;
               };
             }

src/core/render/progressbar.js

@@ -17,7 +17,7 @@ function init() {
 /**
  * Render progress bar
  */
-export default function({ loaded, total, step }) {
+export default function ({ loaded, total, step }) {
   let num;
 
   !barEl && init();

src/core/render/slugify.js

@@ -32,6 +32,6 @@ export function slugify(str) {
   return slug;
 }
 
-slugify.clear = function() {
+slugify.clear = function () {
   cache = {};
 };

src/core/router/util.js

@@ -13,7 +13,7 @@ export function parseQuery(query) {
   }
 
   // Simple parse
-  query.split('&').forEach(function(param) {
+  query.split('&').forEach(function (param) {
     const parts = param.replace(/\+/g, ' ').split('=');
 
     res[parts[0]] = parts[1] && decode(parts[1]);

src/core/util/core.js

@@ -6,7 +6,7 @@
 
 export function cached(fn) {
   const cache = Object.create(null);
-  return function(str) {
+  return function (str) {
     const key = isPrimitive(str) ? str : JSON.stringify(str);
     const hit = cache[key];
     return hit || (cache[key] = fn(str));
@@ -29,7 +29,7 @@ export const hasOwn = Object.prototype.hasOwnProperty;
  */
 export const merge =
   Object.assign ||
-  function(to) {
+  function (to) {
     for (let i = 1; i < arguments.length; i++) {
       const from = Object(arguments[i]);
 

src/core/util/env.js

@@ -7,7 +7,7 @@ export const isMobile = inBrowser && document.body.clientWidth <= 600;
  */
 export const supportsPushState =
   inBrowser &&
-  (function() {
+  (function () {
     // Borrowed wholesale from https://github.com/defunkt/jquery-pjax
     return (
       window.history &&

src/core/util/polyfill/css-vars.js

@@ -8,7 +8,7 @@ function replaceVar(block, color) {
   );
 }
 
-export default function(color) {
+export default function (color) {
   // Variable support
   if (window.CSS && window.CSS.supports && window.CSS.supports('(--v:red)')) {
     return;

src/plugins/disqus.js

@@ -39,7 +39,7 @@ function install(hook, vm) {
     if (typeof window.DISQUS !== 'undefined') {
       window.DISQUS.reset({
         reload: true,
-        config: function() {
+        config: function () {
           this.page.url = location.origin + '/-' + vm.route.path;
           this.page.identifier = vm.route.path;
           this.page.title = document.title;

src/plugins/external-script.js

@@ -18,7 +18,7 @@ function handleExternalScript() {
   }
 }
 
-const install = function(hook) {
+const install = function (hook) {
   hook.doneEach(handleExternalScript);
 };
 

src/plugins/front-matter/index.js

@@ -1,10 +1,10 @@
 import parser from './parser';
 
-const install = function(hook, vm) {
+const install = function (hook, vm) {
   // Used to remove front matter from embedded pages if installed.
   vm.config.frontMatter = {};
   vm.config.frontMatter.installed = true;
-  vm.config.frontMatter.parseMarkdown = function(content) {
+  vm.config.frontMatter.parseMarkdown = function (content) {
     const { body } = parser(content);
     return body;
   };

src/plugins/ga.js

@@ -11,7 +11,7 @@ function init(id) {
   appendScript();
   window.ga =
     window.ga ||
-    function() {
+    function () {
       (window.ga.q = window.ga.q || []).push(arguments);
     };
 
@@ -28,7 +28,7 @@ function collect() {
   window.ga('send', 'pageview');
 }
 
-const install = function(hook) {
+const install = function (hook) {
   if (!$docsify.ga) {
     console.error('[Docsify] ga is required.');
     return;

src/plugins/matomo.js

@@ -9,7 +9,7 @@ function init(options) {
   window._paq = window._paq || [];
   window._paq.push(['trackPageView']);
   window._paq.push(['enableLinkTracking']);
-  setTimeout(function() {
+  setTimeout(function () {
     appendScript(options);
     window._paq.push(['setTrackerUrl', options.host + '/matomo.php']);
     window._paq.push(['setSiteId', String(options.id)]);
@@ -26,7 +26,7 @@ function collect() {
   window._paq.push(['trackPageView']);
 }
 
-const install = function(hook) {
+const install = function (hook) {
   if (!$docsify.matomo) {
     // eslint-disable-next-line no-console
     console.error('[Docsify] matomo is required.');

src/plugins/search/index.js

@@ -13,7 +13,7 @@ const CONFIG = {
   pathNamespaces: undefined,
 };
 
-const install = function(hook, vm) {
+const install = function (hook, vm) {
   const { util } = Docsify;
   const opts = vm.config.search || CONFIG;
 

src/plugins/search/search.js

@@ -58,7 +58,7 @@ function getTableData(token) {
   if (!token.text && token.type === 'table') {
     token.cells.unshift(token.header);
     token.text = token.cells
-      .map(function(rows) {
+      .map(function (rows) {
         return rows.join(' | ');
       })
       .join(' |\n ');
@@ -85,7 +85,7 @@ export function genIndex(path, content = '', router, depth) {
   let slug;
   let title = '';
 
-  tokens.forEach(function(token, tokenIndex) {
+  tokens.forEach(function (token, tokenIndex) {
     if (token.type === 'heading' && token.depth <= depth) {
       const { str, config } = getAndRemoveConfig(token.text);