(chore) fix some linter unhappiness

Author: joshgoebel

Diff for: .eslintrc.js

@@ -29,8 +29,7 @@ module.exports = {
     quotes: "off",
     // this is the style we are already using
     "operator-linebreak": ["error", "before", { overrides: {
-      "=": "after",
-      "+": "after"
+      "=": "after"
     }
     }],
     // sometimes we declare variables with extra spacing

Diff for: src/highlight.js

@@ -17,6 +17,7 @@ import * as logger from "./lib/logger.js";
 /**
 @typedef {import('highlight.js').Mode} Mode
 @typedef {import('highlight.js').CompiledMode} CompiledMode
+@typedef {import('highlight.js').CompiledScope} CompiledScope
 @typedef {import('highlight.js').Language} Language
 @typedef {import('highlight.js').HLJSApi} HLJSApi
 @typedef {import('highlight.js').HLJSPlugin} HLJSPlugin
@@ -269,7 +270,7 @@ const HLJS = function(hljs) {
     }
 
     /**
-     * @param {CompiledMode} mode
+     * @param {CompiledScope} scope
      * @param {RegExpMatchArray} match
      */
     function emitMultiClass(scope, match) {

Diff for: src/lib/ext/multi_class.js

@@ -33,7 +33,7 @@ const MultiClassError = new Error();
  * are 1, 2, and 5.  This function handles this behavior.
  *
  * @param {CompiledMode} mode
- * @param {Array<RegExp>} regexes
+ * @param {Array<RegExp | string>} regexes
  * @param {{key: "beginScope"|"endScope"}} opts
  */
 function remapScopeNames(mode, regexes, { key }) {
@@ -72,7 +72,7 @@ function beginMultiClass(mode) {
     throw MultiClassError;
   }
 
-  remapScopeNames(mode, mode.begin, {key: "beginScope"});
+  remapScopeNames(mode, mode.begin, { key: "beginScope" });
   mode.begin = regex._rewriteBackreferences(mode.begin, { joinWith: "" });
 }
 
@@ -92,7 +92,7 @@ function endMultiClass(mode) {
     throw MultiClassError;
   }
 
-  remapScopeNames(mode, mode.end, {key: "endScope"});
+  remapScopeNames(mode, mode.end, { key: "endScope" });
   mode.end = regex._rewriteBackreferences(mode.end, { joinWith: "" });
 }
 

Diff for: src/lib/mode_compiler.js

@@ -33,7 +33,10 @@ export function compileLanguage(language) {
   function langRe(value, global) {
     return new RegExp(
       regex.source(value),
-      'm' + (language.case_insensitive ? 'i' : '') + (language.unicodeRegex ? 'u' : '') + (global ? 'g' : '')
+      'm'
+      + (language.case_insensitive ? 'i' : '')
+      + (language.unicodeRegex ? 'u' : '')
+      + (global ? 'g' : '')
     );
   }
 
@@ -334,10 +337,10 @@ export function compileLanguage(language) {
 
     if (parent) {
       if (!mode.begin) mode.begin = /\B|\b/;
-      cmode.beginRe = langRe(mode.begin);
+      cmode.beginRe = langRe(cmode.begin);
       if (!mode.end && !mode.endsWithParent) mode.end = /\B|\b/;
-      if (mode.end) cmode.endRe = langRe(mode.end);
-      cmode.terminatorEnd = regex.source(mode.end) || '';
+      if (mode.end) cmode.endRe = langRe(cmode.end);
+      cmode.terminatorEnd = regex.source(cmode.end) || '';
       if (mode.endsWithParent && parent.terminatorEnd) {
         cmode.terminatorEnd += (mode.end ? '|' : '') + parent.terminatorEnd;
       }

Diff for: src/lib/regex.js

@@ -50,6 +50,10 @@ export function concat(...args) {
   return joined;
 }
 
+/**
+ * @param { Array<string | RegExp | Object> } args
+ * @returns {object}
+ */
 function stripOptionsFromArgs(args) {
   const opts = args[args.length - 1];
 
@@ -69,15 +73,16 @@ function stripOptionsFromArgs(args) {
  * @returns {string}
  */
 export function either(...args) {
+  /** @type { object & {capture?: boolean} }  */
   const opts = stripOptionsFromArgs(args);
-  const joined = '(' +
-    (opts.capture ? "" : "?:") +
-    args.map((x) => source(x)).join("|") + ")";
+  const joined = '('
+    + (opts.capture ? "" : "?:")
+    + args.map((x) => source(x)).join("|") + ")";
   return joined;
 }
 
 /**
- * @param {RegExp} re
+ * @param {RegExp | string} re
  * @returns {number}
  */
 export function countMatchGroups(re) {

Diff for: types/index.d.ts

@@ -15,7 +15,7 @@ declare module 'highlight.js/private' {
 }
 declare module 'highlight.js' {
 
-    import { KeywordDict} from "highlight.js/private";
+    import { KeywordDict } from "highlight.js/private";
 
     export type HLJSApi = PublicApi & ModesAPI
 
@@ -190,8 +190,13 @@ declare module 'highlight.js' {
         keywords: Record<string, any>
     }
 
+    export type CompiledScope = Record<number, string> & {_emit?: Record<number, boolean>, _multi?: boolean, _wrap?: string};
+
     export type CompiledMode = Omit<Mode, 'contains'> &
         {
+            begin?: RegExp | string
+            end?: RegExp | string
+            scope?: string
             contains: CompiledMode[]
             keywords: KeywordDict
             data: Record<string, any>
@@ -204,8 +209,8 @@ declare module 'highlight.js' {
             isCompiled: true
             starts?: CompiledMode
             parent?: CompiledMode
-            beginScope?: Record<number, string> & {_emit?: Record<number,boolean>, _multi?: boolean, _wrap?: string}
-            endScope?: Record<number, string> & {_emit?: Record<number,boolean>, _multi?: boolean, _wrap?: string}
+            beginScope?: CompiledScope
+            endScope?: CompiledScope
         }
 
     interface ModeDetails {