Merge pull request #2275 from github/koesie10/markdown-lint-generated-files

koesie10 · web-flow · commit 82e3d48533b8 · 2023-04-06T09:33:27.000+02:00
Fix markdownlint errors for generated files
diff --git a/extensions/ql-vscode/src/variant-analysis/markdown-generation.ts b/extensions/ql-vscode/src/variant-analysis/markdown-generation.ts
@@ -112,7 +112,7 @@ export function generateVariantAnalysisMarkdownSummary(
   lines.push(`### Results for "${query.name}"`, "");
 
   // Expandable section containing query text
-  const queryCodeBlock = ["```ql", ...query.text.split("\n"), "```"];
+  const queryCodeBlock = ["```ql", ...query.text.split("\n"), "```", ""];
   lines.push(...buildExpandableMarkdownSection("Query", queryCodeBlock));
 
   // Padding between sections
@@ -128,6 +128,9 @@ export function generateVariantAnalysisMarkdownSummary(
     lines.push(`| ${fullName} | [${summary.resultCount} result(s)](${link}) |`);
   }
 
+  // Add a trailing newline
+  lines.push("");
+
   return {
     fileName: "_summary",
     content: lines,
@@ -279,8 +282,8 @@ function generateMarkdownForPathResults(
       );
       // Indent the snippet to fit with the numbered list.
       // The indentation is "n + 2" where the list number is an n-digit number.
-      const codeSnippetIndented = codeSnippet.map(
-        (line) => " ".repeat(listNumber.toString().length + 2) + line,
+      const codeSnippetIndented = codeSnippet.map((line) =>
+        (" ".repeat(listNumber.toString().length + 2) + line).trimEnd(),
       );
       pathLines.push(`${listNumber}. ${link}`, ...codeSnippetIndented);
     }
@@ -382,7 +385,6 @@ function buildExpandableMarkdownSection(
     `<summary>${title}</summary>`,
     "",
     ...contents,
-    "",
     "</details>",
     "",
   );
diff --git a/extensions/ql-vscode/test/unit-tests/data/markdown-generation/.markdownlint.jsonc b/extensions/ql-vscode/test/unit-tests/data/markdown-generation/.markdownlint.jsonc
@@ -0,0 +1,7 @@
+{
+  "extends": "../../../../../../.markdownlint.json",
+  "MD010": false, // Hard tabs are from the original snippet in the SARIF file
+  "MD024": false, // Duplicate headings
+  "MD033": false, // Inline HTML for <details> and <summary>
+  "MD051": false // Link fragments are used in Gist to link to other files
+}
diff --git a/extensions/ql-vscode/test/unit-tests/data/markdown-generation/interpreted-results/path-problem/expected/result-1-github-codeql.md b/extensions/ql-vscode/test/unit-tests/data/markdown-generation/interpreted-results/path-problem/expected/result-1-github-codeql.md
@@ -22,38 +22,37 @@
      cp.execSync(cmd); // BAD
    }
    </code></pre>
-   
+
 2. [javascript/ql/src/Security/CWE-078/examples/shell-command-injection-from-environment.js](https://github.com/github/codeql/blob/48015e5a2e6202131f2d1062cc066dc33ed69a9b/javascript/ql/src/Security/CWE-078/examples/shell-command-injection-from-environment.js#L4-L4)
    <pre><code class="javascript">  path = require("path");
    function cleanupTemp() {
      let cmd = "rm -rf " + <strong>path.join(__dirname, "temp")</strong>;
      cp.execSync(cmd); // BAD
    }
    </code></pre>
-   
+
 3. [javascript/ql/src/Security/CWE-078/examples/shell-command-injection-from-environment.js](https://github.com/github/codeql/blob/48015e5a2e6202131f2d1062cc066dc33ed69a9b/javascript/ql/src/Security/CWE-078/examples/shell-command-injection-from-environment.js#L4-L4)
    <pre><code class="javascript">  path = require("path");
    function cleanupTemp() {
      let cmd = <strong>"rm -rf " + path.join(__dirname, "temp")</strong>;
      cp.execSync(cmd); // BAD
    }
    </code></pre>
-   
+
 4. [javascript/ql/src/Security/CWE-078/examples/shell-command-injection-from-environment.js](https://github.com/github/codeql/blob/48015e5a2e6202131f2d1062cc066dc33ed69a9b/javascript/ql/src/Security/CWE-078/examples/shell-command-injection-from-environment.js#L4-L4)
    <pre><code class="javascript">  path = require("path");
    function cleanupTemp() {
      let <strong>cmd = "rm -rf " + path.join(__dirname, "temp")</strong>;
      cp.execSync(cmd); // BAD
    }
    </code></pre>
-   
+
 5. [javascript/ql/src/Security/CWE-078/examples/shell-command-injection-from-environment.js](https://github.com/github/codeql/blob/48015e5a2e6202131f2d1062cc066dc33ed69a9b/javascript/ql/src/Security/CWE-078/examples/shell-command-injection-from-environment.js#L5-L5)
    <pre><code class="javascript">function cleanupTemp() {
      let cmd = "rm -rf " + path.join(__dirname, "temp");
      cp.execSync(<strong>cmd</strong>); // BAD
    }
    </code></pre>
-   
 
 </details>
 
@@ -79,26 +78,25 @@
    <pre><code class="javascript">(function() {
    	cp.execFileSync('rm',  ['-rf', path.join(__dirname, "temp")]); // GOOD
    	cp.execSync('rm -rf ' + path.join(<strong>__dirname</strong>, "temp")); // BAD
-   
+
    	execa.shell('rm -rf ' + path.join(__dirname, "temp")); // NOT OK
    </code></pre>
-   
+
 2. [javascript/ql/test/query-tests/Security/CWE-078/tst_shell-command-injection-from-environment.js](https://github.com/github/codeql/blob/48015e5a2e6202131f2d1062cc066dc33ed69a9b/javascript/ql/test/query-tests/Security/CWE-078/tst_shell-command-injection-from-environment.js#L6-L6)
    <pre><code class="javascript">(function() {
    	cp.execFileSync('rm',  ['-rf', path.join(__dirname, "temp")]); // GOOD
    	cp.execSync('rm -rf ' + <strong>path.join(__dirname, "temp")</strong>); // BAD
-   
+
    	execa.shell('rm -rf ' + path.join(__dirname, "temp")); // NOT OK
    </code></pre>
-   
+
 3. [javascript/ql/test/query-tests/Security/CWE-078/tst_shell-command-injection-from-environment.js](https://github.com/github/codeql/blob/48015e5a2e6202131f2d1062cc066dc33ed69a9b/javascript/ql/test/query-tests/Security/CWE-078/tst_shell-command-injection-from-environment.js#L6-L6)
    <pre><code class="javascript">(function() {
    	cp.execFileSync('rm',  ['-rf', path.join(__dirname, "temp")]); // GOOD
    	cp.execSync(<strong>'rm -rf ' + path.join(__dirname, "temp")</strong>); // BAD
-   
+
    	execa.shell('rm -rf ' + path.join(__dirname, "temp")); // NOT OK
    </code></pre>
-   
 
 </details>
 
@@ -122,28 +120,27 @@
 
 1. [javascript/ql/test/query-tests/Security/CWE-078/tst_shell-command-injection-from-environment.js](https://github.com/github/codeql/blob/48015e5a2e6202131f2d1062cc066dc33ed69a9b/javascript/ql/test/query-tests/Security/CWE-078/tst_shell-command-injection-from-environment.js#L8-L8)
    <pre><code class="javascript">	cp.execSync('rm -rf ' + path.join(__dirname, "temp")); // BAD
-   
+
    	execa.shell('rm -rf ' + path.join(<strong>__dirname</strong>, "temp")); // NOT OK
    	execa.shellSync('rm -rf ' + path.join(__dirname, "temp")); // NOT OK
-   
+
    </code></pre>
-   
+
 2. [javascript/ql/test/query-tests/Security/CWE-078/tst_shell-command-injection-from-environment.js](https://github.com/github/codeql/blob/48015e5a2e6202131f2d1062cc066dc33ed69a9b/javascript/ql/test/query-tests/Security/CWE-078/tst_shell-command-injection-from-environment.js#L8-L8)
    <pre><code class="javascript">	cp.execSync('rm -rf ' + path.join(__dirname, "temp")); // BAD
-   
+
    	execa.shell('rm -rf ' + <strong>path.join(__dirname, "temp")</strong>); // NOT OK
    	execa.shellSync('rm -rf ' + path.join(__dirname, "temp")); // NOT OK
-   
+
    </code></pre>
-   
+
 3. [javascript/ql/test/query-tests/Security/CWE-078/tst_shell-command-injection-from-environment.js](https://github.com/github/codeql/blob/48015e5a2e6202131f2d1062cc066dc33ed69a9b/javascript/ql/test/query-tests/Security/CWE-078/tst_shell-command-injection-from-environment.js#L8-L8)
    <pre><code class="javascript">	cp.execSync('rm -rf ' + path.join(__dirname, "temp")); // BAD
-   
+
    	execa.shell(<strong>'rm -rf ' + path.join(__dirname, "temp")</strong>); // NOT OK
    	execa.shellSync('rm -rf ' + path.join(__dirname, "temp")); // NOT OK
-   
+
    </code></pre>
-   
 
 </details>
 
@@ -169,26 +166,25 @@
    <pre><code class="javascript">
    	execa.shell('rm -rf ' + path.join(__dirname, "temp")); // NOT OK
    	execa.shellSync('rm -rf ' + path.join(<strong>__dirname</strong>, "temp")); // NOT OK
-   
+
    	const safe = "\"" + path.join(__dirname, "temp") + "\"";
    </code></pre>
-   
+
 2. [javascript/ql/test/query-tests/Security/CWE-078/tst_shell-command-injection-from-environment.js](https://github.com/github/codeql/blob/48015e5a2e6202131f2d1062cc066dc33ed69a9b/javascript/ql/test/query-tests/Security/CWE-078/tst_shell-command-injection-from-environment.js#L9-L9)
    <pre><code class="javascript">
    	execa.shell('rm -rf ' + path.join(__dirname, "temp")); // NOT OK
    	execa.shellSync('rm -rf ' + <strong>path.join(__dirname, "temp")</strong>); // NOT OK
-   
+
    	const safe = "\"" + path.join(__dirname, "temp") + "\"";
    </code></pre>
-   
+
 3. [javascript/ql/test/query-tests/Security/CWE-078/tst_shell-command-injection-from-environment.js](https://github.com/github/codeql/blob/48015e5a2e6202131f2d1062cc066dc33ed69a9b/javascript/ql/test/query-tests/Security/CWE-078/tst_shell-command-injection-from-environment.js#L9-L9)
    <pre><code class="javascript">
    	execa.shell('rm -rf ' + path.join(__dirname, "temp")); // NOT OK
    	execa.shellSync(<strong>'rm -rf ' + path.join(__dirname, "temp")</strong>); // NOT OK
-   
+
    	const safe = "\"" + path.join(__dirname, "temp") + "\"";
    </code></pre>
-   
 
 </details>
 
diff --git a/extensions/ql-vscode/test/unit-tests/data/markdown-generation/interpreted-results/path-problem/expected/result-2-meteor-meteor.md b/extensions/ql-vscode/test/unit-tests/data/markdown-generation/interpreted-results/path-problem/expected/result-2-meteor-meteor.md
@@ -20,34 +20,34 @@
    <pre><code class="javascript">
    const meteorLocalFolder = '.meteor';
    const meteorPath = <strong>path.resolve(rootPath, meteorLocalFolder)</strong>;
-   
+
    module.exports = {
    </code></pre>
-   
+
 2. [npm-packages/meteor-installer/config.js](https://github.com/meteor/meteor/blob/73b538fe201cbfe89dd0c709689023f9b3eab1ec/npm-packages/meteor-installer/config.js#L39-L39)
    <pre><code class="javascript">
    const meteorLocalFolder = '.meteor';
    const <strong>meteorPath = path.resolve(rootPath, meteorLocalFolder)</strong>;
-   
+
    module.exports = {
    </code></pre>
-   
+
 3. [npm-packages/meteor-installer/config.js](https://github.com/meteor/meteor/blob/73b538fe201cbfe89dd0c709689023f9b3eab1ec/npm-packages/meteor-installer/config.js#L44-L44)
    <pre><code class="javascript">  METEOR_LATEST_VERSION,
      extractPath: rootPath,
      <strong>meteorPath</strong>,
      release: process.env.INSTALL_METEOR_VERSION || METEOR_LATEST_VERSION,
      rootPath,
    </code></pre>
-   
+
 4. [npm-packages/meteor-installer/install.js](https://github.com/meteor/meteor/blob/73b538fe201cbfe89dd0c709689023f9b3eab1ec/npm-packages/meteor-installer/install.js#L12-L12)
    <pre><code class="javascript">const os = require('os');
    const {
      <strong>meteorPath</strong>,
      release,
      startedPath,
    </code></pre>
-   
+
 5. [npm-packages/meteor-installer/install.js](https://github.com/meteor/meteor/blob/73b538fe201cbfe89dd0c709689023f9b3eab1ec/npm-packages/meteor-installer/install.js#L11-L23)
    <pre><code class="javascript">const tmp = require('tmp');
    const os = require('os');
@@ -67,55 +67,54 @@
    const { uninstall } = require('./uninstall');
    const {
    </code></pre>
-   
+
 6. [npm-packages/meteor-installer/install.js](https://github.com/meteor/meteor/blob/73b538fe201cbfe89dd0c709689023f9b3eab1ec/npm-packages/meteor-installer/install.js#L259-L259)
    <pre><code class="javascript">  if (isWindows()) {
        //set for the current session and beyond
        child_process.execSync(`setx path "${<strong>meteorPath</strong>}/;%path%`);
        return;
      }
    </code></pre>
-   
+
 7. [npm-packages/meteor-installer/install.js](https://github.com/meteor/meteor/blob/73b538fe201cbfe89dd0c709689023f9b3eab1ec/npm-packages/meteor-installer/install.js#L259-L259)
    <pre><code class="javascript">  if (isWindows()) {
        //set for the current session and beyond
        child_process.execSync(`setx path "${<strong>meteorPath</strong>}/;%path%`);
        return;
      }
    </code></pre>
-   
+
 8. [npm-packages/meteor-installer/install.js](https://github.com/meteor/meteor/blob/73b538fe201cbfe89dd0c709689023f9b3eab1ec/npm-packages/meteor-installer/install.js#L259-L259)
    <pre><code class="javascript">  if (isWindows()) {
        //set for the current session and beyond
        child_process.execSync(`setx path "${<strong>meteorPath</strong>}/;%path%`);
        return;
      }
    </code></pre>
-   
+
 9. [npm-packages/meteor-installer/install.js](https://github.com/meteor/meteor/blob/73b538fe201cbfe89dd0c709689023f9b3eab1ec/npm-packages/meteor-installer/install.js#L259-L259)
    <pre><code class="javascript">  if (isWindows()) {
        //set for the current session and beyond
        child_process.execSync(`setx path "${<strong>meteorPath</strong>}/;%path%`);
        return;
      }
    </code></pre>
-   
+
 10. [npm-packages/meteor-installer/install.js](https://github.com/meteor/meteor/blob/73b538fe201cbfe89dd0c709689023f9b3eab1ec/npm-packages/meteor-installer/install.js#L259-L259)
     <pre><code class="javascript">  if (isWindows()) {
         //set for the current session and beyond
         child_process.execSync(`setx path "${<strong>meteorPath</strong>}/;%path%`);
         return;
       }
     </code></pre>
-    
+
 11. [npm-packages/meteor-installer/install.js](https://github.com/meteor/meteor/blob/73b538fe201cbfe89dd0c709689023f9b3eab1ec/npm-packages/meteor-installer/install.js#L259-L259)
     <pre><code class="javascript">  if (isWindows()) {
         //set for the current session and beyond
         child_process.execSync(<strong>`setx path "${meteorPath}/;%path%`</strong>);
         return;
       }
     </code></pre>
-    
 
 </details>
 
@@ -126,18 +125,17 @@
    <pre><code class="javascript">
    const meteorLocalFolder = '.meteor';
    const meteorPath = <strong>path.resolve(rootPath, meteorLocalFolder)</strong>;
-   
+
    module.exports = {
    </code></pre>
-   
+
 2. [npm-packages/meteor-installer/install.js](https://github.com/meteor/meteor/blob/73b538fe201cbfe89dd0c709689023f9b3eab1ec/npm-packages/meteor-installer/install.js#L259-L259)
    <pre><code class="javascript">  if (isWindows()) {
        //set for the current session and beyond
        child_process.execSync(<strong>`setx path "${meteorPath}/;%path%`</strong>);
        return;
      }
    </code></pre>
-   
 
 </details>
 
diff --git a/extensions/ql-vscode/test/unit-tests/data/markdown-generation/interpreted-results/problem/expected/_summary.md b/extensions/ql-vscode/test/unit-tests/data/markdown-generation/interpreted-results/problem/expected/_summary.md
@@ -41,4 +41,4 @@ select t,
 | Repository | Results |
 | --- | --- |
 | github/codeql | [1 result(s)](#file-result-1-github-codeql-md) |
-| meteor/meteor | [5 result(s)](#file-result-2-meteor-meteor-md) |
+| meteor/meteor | [5 result(s)](#file-result-2-meteor-meteor-md) |
diff --git a/extensions/ql-vscode/test/unit-tests/data/markdown-generation/raw-results/expected/_summary.md b/extensions/ql-vscode/test/unit-tests/data/markdown-generation/raw-results/expected/_summary.md
@@ -38,4 +38,4 @@ select c, c.getNumLines()
 | Repository | Results |
 | --- | --- |
 | github/codeql | [22 result(s)](#file-result-1-github-codeql-md) |
-| meteor/meteor | [2 result(s)](#file-result-2-meteor-meteor-md) |
+| meteor/meteor | [2 result(s)](#file-result-2-meteor-meteor-md) |
diff --git a/extensions/ql-vscode/test/unit-tests/data/markdown-generation/raw-results/expected/result-1-github-codeql.md b/extensions/ql-vscode/test/unit-tests/data/markdown-generation/raw-results/expected/result-1-github-codeql.md
@@ -23,4 +23,4 @@
 | [`functio ...  true\n}`](https://github.com/github/codeql/blob/cbdd4927cee593b715d8469240ce1d31edaaef9b/javascript/ql/test/query-tests/Statements/UselessComparisonTest/constant.js#L1-L4) | `4` |
 | [`functio ... n -1;\n}`](https://github.com/github/codeql/blob/cbdd4927cee593b715d8469240ce1d31edaaef9b/javascript/ql/test/query-tests/Statements/UselessComparisonTest/example.js#L1-L12) | `12` |
 | [`functio ... turn; }`](https://github.com/github/codeql/blob/cbdd4927cee593b715d8469240ce1d31edaaef9b/javascript/ql/test/query-tests/Statements/UselessComparisonTest/tst.js#L8-L8) | `1` |
-| [`\| functio ... i+1); \|}`](https://github.com/github/codeql/blob/cbdd4927cee593b715d8469240ce1d31edaaef9b/javascript/ql/test/query-tests/Statements/UselessComparisonTest/tst.js#L9-L9) | `1` |
+| [`\| functio ... i+1); \|}`](https://github.com/github/codeql/blob/cbdd4927cee593b715d8469240ce1d31edaaef9b/javascript/ql/test/query-tests/Statements/UselessComparisonTest/tst.js#L9-L9) | `1` |
diff --git a/extensions/ql-vscode/test/unit-tests/data/markdown-generation/raw-results/expected/result-2-meteor-meteor.md b/extensions/ql-vscode/test/unit-tests/data/markdown-generation/raw-results/expected/result-2-meteor-meteor.md
@@ -3,4 +3,4 @@
 | c |  |
 | --- | --- |
 | [`functio ... rn H\|0}`](https://github.com/meteor/meteor/blob/53f3c4442d3542d3d2a012a854472a0d1bef9d12/packages/logic-solver/minisat.js#L7-L7) | `1` |
-| [`functio ... ext;\n\t}`](https://github.com/meteor/meteor/blob/53f3c4442d3542d3d2a012a854472a0d1bef9d12/packages/sha/sha256.js#L94-L124) | `31` |
+| [`functio ... ext;\n\t}`](https://github.com/meteor/meteor/blob/53f3c4442d3542d3d2a012a854472a0d1bef9d12/packages/sha/sha256.js#L94-L124) | `31` |
