Guide users to reporting crashes

strager · strager · commit 1e7947ba7171 · 2021-10-12T17:24:45.000-07:00
If quick-lint-js crashes with an assertion failure, point them to our
bug tracker.
diff --git a/src/assert.cpp b/src/assert.cpp
@@ -8,7 +8,10 @@ namespace quick_lint_js {
 void report_assertion_failure(const char *qljs_file_name, int qljs_line,
                               const char *qljs_function_name,
                               const char *message) {
-  std::fprintf(stderr, "%s:%d: internal check failed in %s: %s\n",
+  std::fprintf(stderr,
+               "%s:%d: internal check failed in %s: %s\n"
+               "quick-lint-js crashed. Please report this bug here:\n"
+               "https://quick-lint-js.com/crash-report/\n",
                qljs_file_name, qljs_line, qljs_function_name, message);
 }
 }
diff --git a/website/public/common-nav.ejs.html b/website/public/common-nav.ejs.html
@@ -119,7 +119,13 @@
       uri: "https://github.com/quick-lint/quick-lint-js",
       title: "Code on GitHub",
     },
-    { uri: "/contact/", title: "Contact" },
+    {
+      uri: "/contact/",
+      title: "Contact",
+      subpages: [
+        { uri: "/crash-report/", title: "Crash report", hidden: true },
+      ],
+    },
   ];
 
   function pageLinkHTML(page) {
diff --git a/website/public/crash-report/index.ejs.html b/website/public/crash-report/index.ejs.html
@@ -0,0 +1,54 @@
+<!DOCTYPE html>
+<!-- Copyright (C) 2020  Matthew "strager" Glazar -->
+<!-- See end of file for extended copyright information. -->
+<html>
+  <head>
+    <%- await include("../common-head.ejs.html") %>
+    <title>quick-lint-js: report a crash</title>
+    <meta name="description" content="Report a quick-lint-js crash." />
+    <link href="../main.css" rel="stylesheet" />
+  </head>
+  <body class="side-bar-nav">
+    <header>
+      <h1><a href="..">quick-lint-js</a></h1>
+      <p class="tag-line">quick-lint-js finds bugs in JavaScript programs.</p>
+      <%- await include("../common-nav.ejs.html") %>
+    </header>
+
+    <main>
+      <h2>Report a quick-lint-js crash</h2>
+      <p>
+        Found a crash in quick-lint-js? Report it in our
+        <a href="https://github.com/quick-lint/quick-lint-js/issues/new"
+          >bug tracker</a
+        >.
+      </p>
+      <p>
+        If you prefer to report a bug privately, email:
+        <a href="mailto:strager.nds@gmail.com">strager.nds@gmail.com</a>
+      </p>
+    </main>
+
+    <footer><%- await include("../common-footer-nav.ejs.html") %></footer>
+  </body>
+</html>
+
+<!--
+quick-lint-js finds bugs in JavaScript programs.
+Copyright (C) 2020  Matthew "strager" Glazar
+
+This file is part of quick-lint-js.
+
+quick-lint-js is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+quick-lint-js is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with quick-lint-js.  If not, see <https://www.gnu.org/licenses/>.
+-->

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,10 @@ namespace quick_lint_js {`
`8`	`8`	`void report_assertion_failure(const char *qljs_file_name, int qljs_line,`
`9`	`9`	`const char *qljs_function_name,`
`10`	`10`	`const char *message) {`
`11`		`- std::fprintf(stderr, "%s:%d: internal check failed in %s: %s\n",`
	`11`	`+ std::fprintf(stderr,`
	`12`	`+ "%s:%d: internal check failed in %s: %s\n"`
	`13`	`+ "quick-lint-js crashed. Please report this bug here:\n"`
	`14`	`+ "https://quick-lint-js.com/crash-report/\n",`
`12`	`15`	`qljs_file_name, qljs_line, qljs_function_name, message);`
`13`	`16`	`}`
`14`	`17`	`}`