- cleanup pr-comments

Author: kaizhu256

CHANGELOG.md

@@ -15,9 +15,9 @@
 - node - after node-v14 is deprecated, remove shell-code `export "NODE_OPTIONS=--unhandled-rejections=strict"`.
 
 # v2022.6.1-beta
-- directive - add new directive `subscript` allowing JSLint to be used with scripts targeting Google Closure Compiler
+- directive - add new directive `subscript` for linting of scripts targeting Google Closure Compiler
 - warning - relax warning about missing `catch` in `try...finally` statement
-- jslint - allow aliases `evil, nomen` for jslint-directives `eval, name`, respectively
+- jslint - allow aliases `evil, nomen` for jslint-directives `eval, name`, respectively for backwards-compat
 - bugfix - fix broken codemirror example
 - bugfix - fix jslint not-recognizing option-chaining when comparing operands of binary operator
 - allow array-literals to directly call [...].flat() and [...].flatMap()

help.html

@@ -486,9 +486,9 @@ <h1><code>/*jslint*/</code></h1>
                 should be allowed to enclose string literals.</td>
         </tr>
         <tr>
-            <td id="subscript">Allow identifiers in subscript-notation.</td>
+            <td id="subscript">Allow identifier in subscript-notation.</td>
             <td><code>subscript</code></td>
-            <td><code>true</code> to allow identifiers in
+            <td><code>true</code> to allow identifier in
             subscript-notation, e.g.: <code>foo["bar"] = 1;</code>.
             This allows linting of scripts targeting Google Closure Compiler,
             where subscript-notation is commonly used to prevent renaming of

index.html

@@ -1172,7 +1172,7 @@
         <div title="Allow single-quote strings.">
         <label><input type="checkbox" value="single">single</label>
         </div>
-        <div title="Allow identifiers in subscript-notation.">
+        <div title="Allow identifier in subscript-notation.">
         <label><input type="checkbox" value="subscript">subscript</label>
         </div>
         <div title="Allow 'this'.">
@@ -1443,7 +1443,7 @@
 }) {
     switch (target.tagName) {
 
-// PR-368 - website
+// PR-368 - Website
 // Add clickable-links to editor-code in report-warnings and report-functions.
 
     case "ADDRESS":
@@ -1642,7 +1642,7 @@
 // .... /*jslint node*/ .......... Assume Node.js environment.
 // .... /*jslint nomen*/ ......... Allow weird property names.
 // .... /*jslint single*/ ........ Allow single-quote strings.
-// .... /*jslint subscript*/ ..... Allow identifiers in subscript-notation.
+// .... /*jslint subscript*/ ..... Allow identifier in subscript-notation.
 // .... /*jslint this*/ .......... Allow 'this'.
 // .... /*jslint trace*/ ......... Include jslint stack-trace in warnings.
 // .... /*jslint unordered*/ ..... Allow unordered cases, params, properties,

jslint.mjs

@@ -469,7 +469,9 @@ function globExclude({
 // $()*+-./?[\]^{|}
 
         strRegex = strRegex.replace((
-            // ignore [-/]
+
+// Ignore [-/].
+
             /[$()*+.?\[\\\]\^{|}]/g
         ), "\\$&");
 
@@ -1256,7 +1258,7 @@ function jslint(
             mode_json: false,           // true if parsing JSON.
             mode_module: false,         // true if import or export was used.
             mode_property: false,       // true if directive /*property*/ is
-                                        // used.
+                                        // ... used.
             mode_shebang: false,        // true if #! is seen on the first line.
             option_dict,
             property_dict,
@@ -2471,6 +2473,7 @@ function jslint_phase2_lex(state) {
                 global_dict[key] = "user-defined";
 
 // PR-347 - Disable warning "unexpected_directive_a".
+//
 //                 state.mode_module = the_comment;
 
                 break;
@@ -3289,7 +3292,7 @@ function jslint_phase2_lex(state) {
         case "node":            // Assume Node.js environment.
         case "nomen":           // Allow weird property names.
         case "single":          // Allow single-quote strings.
-        case "subscript":       // Allow identifiers in subscript-notation.
+        case "subscript":       // Allow identifier in subscript-notation.
         case "test_cause":      // Test jslint's causes.
         case "test_internal_error":     // Test jslint's internal-error
                                         // ... handling-ability.
@@ -3302,10 +3305,14 @@ function jslint_phase2_lex(state) {
         case "white":           // Allow messy whitespace.
             option_dict[key] = val;
             break;
-        // alias for eval
+
+// PR-404 - Alias "evil" to jslint-directive "eval" for backwards-compat.
+
         case "evil":
             return option_set_item("eval", val);
-        // alias for nomen
+
+// PR-404 - Alias "nomen" to jslint-directive "name" for backwards-compat.
+
         case "name":
             return option_set_item("nomen", val);
         default:
@@ -4555,9 +4562,7 @@ function jslint_phase3_parse(state) {
         if (the_subscript.id === "(string)" || the_subscript.id === "`") {
             name = survey(the_subscript);
 
-// PR-xxx - directive
-// Add new directive "subscript" allowing JSLint to be used with scripts
-// targeting Google Closure Compiler.
+// PR-404 - Add new directive "subscript" to play nice with Google Closure.
 
             if (!option_dict.subscript && jslint_rgx_identifier.test(name)) {
 
@@ -6357,6 +6362,7 @@ function jslint_phase3_parse(state) {
         let names;
 
 // PR-347 - Disable warning "unexpected_directive_a".
+//
 //         if (typeof state.mode_module === "object") {
 //
 // // test_cause:
@@ -6715,8 +6721,7 @@ function jslint_phase3_parse(state) {
 
             catchage = catch_stack.pop();
 
-// PR-xxx - warning
-// Relax warning about missing `catch` in `try...finally` statement.
+// PR-404 - Relax warning about missing `catch` in `try...finally` statement.
 //
 //         } else {
 //
@@ -6845,12 +6850,14 @@ function jslint_phase3_parse(state) {
                             return stop("expected_identifier_a");
                         }
 
-// PR-363 - Bugfix - fix false-warning
-// <uninitialized 'bb'> in code '/*jslint node*/\nlet {aa:bb} = {}; bb();'
+// PR-363 - Bugfix
+// Add test against false-warning <uninitialized 'bb'> in code
+// '/*jslint node*/\nlet {aa:bb} = {}; bb();'.
+//
+//                         token_nxt.label = name;
+//                         the_variable.names.push(token_nxt);
+//                         enroll(token_nxt, "variable", mode_const);
 
-                        // token_nxt.label = name;
-                        // the_variable.names.push(token_nxt);
-                        // enroll(token_nxt, "variable", mode_const);
                         name = token_nxt;
                         the_variable.names.push(name);
                         survey(name);
@@ -11113,15 +11120,13 @@ function sentinel() {}
         processArgElem[1] = processArgElem.slice(1).join("=");
         switch (processArgElem[0]) {
 
-// PR-371
-// Add cli-option `--exclude=...`.
+// PR-371 - Add cli-option `--exclude=...`.
 
         case "--exclude":
             excludeList.push(processArgElem[1]);
             break;
 
-// PR-371
-// Add cli-option `--include=...`
+// PR-371 - Add cli-option `--include=...`
 
         case "--include":
             includeList.push(processArgElem[1]);
@@ -11221,15 +11226,13 @@ function sentinel() {}
             pathnameDict[pathname] = scriptCov;
         });
 
-// PR-400
-// Filter directory `node_modules`.
+// PR-400 - Filter directory `node_modules`.
 
         if (!modeIncludeNodeModules) {
             excludeList.push("node_modules/");
         }
 
-// PR-400
-// Filter files by glob-patterns in excludeList, includeList.
+// PR-400 - Filter files by glob-patterns in excludeList, includeList.
 
         data.result = globExclude({
             excludeList,

jslint_ci.sh

@@ -1944,7 +1944,6 @@ function globExclude({
       /[\[\]]/g
     ), "\\$&");
     strRegex = strRegex.replace((
-      // ignore [-/]
       /[$()*+.?\[\\\]\^{|}]/g
     ), "\\$&");
     strRegex = strRegex.replace((

test.mjs

@@ -861,8 +861,9 @@ jstestDescribe((
             ],
             var: [
 
-// PR-363 - Bugfix - add test against false-warning
-// <uninitialized 'bb'> in code '/*jslint node*/\nlet {aa:bb} = {}; bb();'
+// PR-363 - Bugfix
+// Add test against false-warning <uninitialized 'bb'> in code
+// '/*jslint node*/\nlet {aa:bb} = {}; bb();'.
 
                 "/*jslint node*/\n",
                 ""
@@ -921,6 +922,9 @@ jstestDescribe((
         ], [
             "debugger;", {devel: true}, []
         ], [
+
+// PR-404 - Alias "evil" to jslint-directive "eval" for backwards-compat.
+
             "new Function();\neval();", {eval: true, evil: true}, []
         ], [
             (
@@ -943,12 +947,18 @@ jstestDescribe((
         ], [
             "/".repeat(100), {long: true}, []
         ], [
+
+// PR-404 - Alias "nomen" to jslint-directive "name" for backwards-compat.
+
             "let aa = aa._;", {name: true, nomen: true}, []
         ], [
             "require();", {node: true}, []
         ], [
             "let aa = 'aa';", {single: true}, []
         ], [
+
+// PR-404 - Add new directive "subscript" to play nice with Google Closure.
+
             "aa[\"aa\"] = 1;", {subscript: true}, ["aa"]
         ], [
             "", {test_internal_error: true}, []