refactor: rename *_error_reporter -> *_diag_reporter

strager · strager · commit 7ee6c2cf04ee · 2022-04-19T02:55:05.000-07:00
diff --git a/plugin/vscode/quick-lint-js/vscode-diag-reporter.h b/plugin/vscode/quick-lint-js/vscode-diag-reporter.h
@@ -12,13 +12,13 @@
 #include <string_view>
 
 namespace quick_lint_js {
-class vscode_error_formatter
-    : public diagnostic_formatter<vscode_error_formatter> {
+class vscode_diag_formatter
+    : public diagnostic_formatter<vscode_diag_formatter> {
  public:
-  explicit vscode_error_formatter(vscode_module* vscode, ::Napi::Env env,
-                                  ::Napi::Array diagnostics,
-                                  const lsp_locator* locator,
-                                  ::Napi::Value document_uri)
+  explicit vscode_diag_formatter(vscode_module* vscode, ::Napi::Env env,
+                                 ::Napi::Array diagnostics,
+                                 const lsp_locator* locator,
+                                 ::Napi::Value document_uri)
       : vscode_(vscode),
         env_(env),
         diagnostics_(diagnostics),
@@ -138,7 +138,7 @@ class vscode_diag_reporter final : public diag_reporter {
   ::Napi::Array diagnostics() const { return this->diagnostics_; }
 
   void report_impl(diag_type type, void* error) override {
-    vscode_error_formatter formatter(
+    vscode_diag_formatter formatter(
         /*vscode=*/this->vscode_,
         /*env=*/this->env_,
         /*diagnostics=*/this->diagnostics_,
diff --git a/src/c-api-diag-reporter.cpp b/src/c-api-diag-reporter.cpp
@@ -36,7 +36,7 @@ void c_api_diag_reporter<Diagnostic, Locator>::reset() {
 template <class Diagnostic, class Locator>
 void c_api_diag_reporter<Diagnostic, Locator>::report_impl(diag_type type,
                                                            void *error) {
-  c_api_error_formatter formatter(this);
+  c_api_diag_formatter formatter(this);
   formatter.format(get_diagnostic_info(type), error);
 }
 
@@ -60,12 +60,12 @@ char8 *c_api_diag_reporter<Diagnostic, Locator>::allocate_c_string(
 }
 
 template <class Diagnostic, class Locator>
-c_api_error_formatter<Diagnostic, Locator>::c_api_error_formatter(
+c_api_diag_formatter<Diagnostic, Locator>::c_api_diag_formatter(
     c_api_diag_reporter<Diagnostic, Locator> *reporter)
     : reporter_(reporter) {}
 
 template <class Diagnostic, class Locator>
-void c_api_error_formatter<Diagnostic, Locator>::write_before_message(
+void c_api_diag_formatter<Diagnostic, Locator>::write_before_message(
     std::string_view, diagnostic_severity sev, const source_code_span &) {
   if (sev == diagnostic_severity::note) {
     // Don't write notes. Only write the main message.
@@ -75,7 +75,7 @@ void c_api_error_formatter<Diagnostic, Locator>::write_before_message(
 }
 
 template <class Diagnostic, class Locator>
-void c_api_error_formatter<Diagnostic, Locator>::write_message_part(
+void c_api_diag_formatter<Diagnostic, Locator>::write_message_part(
     std::string_view, diagnostic_severity sev, string8_view message) {
   if (sev == diagnostic_severity::note) {
     // Don't write notes. Only write the main message.
@@ -85,7 +85,7 @@ void c_api_error_formatter<Diagnostic, Locator>::write_message_part(
 }
 
 template <class Diagnostic, class Locator>
-void c_api_error_formatter<Diagnostic, Locator>::write_after_message(
+void c_api_diag_formatter<Diagnostic, Locator>::write_after_message(
     std::string_view code, diagnostic_severity sev,
     const source_code_span &origin) {
   qljs_severity diag_severity = qljs_severity_error;
@@ -121,8 +121,7 @@ void c_api_error_formatter<Diagnostic, Locator>::write_after_message(
   diag.severity = diag_severity;
 }
 
-template class c_api_error_formatter<qljs_web_demo_diagnostic,
-                                     web_demo_locator>;
+template class c_api_diag_formatter<qljs_web_demo_diagnostic, web_demo_locator>;
 template class c_api_diag_reporter<qljs_web_demo_diagnostic, web_demo_locator>;
 }
 
diff --git a/src/emacs-lisp-diag-reporter.cpp b/src/emacs-lisp-diag-reporter.cpp
@@ -24,16 +24,16 @@ void emacs_lisp_diag_reporter::set_source(padded_string_view input) {
 
 void emacs_lisp_diag_reporter::report_impl(diag_type type, void *error) {
   QLJS_ASSERT(this->locator_.has_value());
-  emacs_lisp_error_formatter formatter(/*output=*/&this->output_,
-                                       /*locator=*/*this->locator_);
+  emacs_lisp_diag_formatter formatter(/*output=*/&this->output_,
+                                      /*locator=*/*this->locator_);
   formatter.format(get_diagnostic_info(type), error);
 }
 
-emacs_lisp_error_formatter::emacs_lisp_error_formatter(output_stream *output,
-                                                       emacs_locator &locator)
+emacs_lisp_diag_formatter::emacs_lisp_diag_formatter(output_stream *output,
+                                                     emacs_locator &locator)
     : output_(*output), locator_(locator) {}
 
-void emacs_lisp_error_formatter::write_before_message(
+void emacs_lisp_diag_formatter::write_before_message(
     std::string_view code, diagnostic_severity sev,
     const source_code_span &origin) {
   if (sev == diagnostic_severity::note) {
@@ -67,7 +67,7 @@ void write_elisp_stringp_escaped_message(output_stream &output,
 }
 }
 
-void emacs_lisp_error_formatter::write_message_part(
+void emacs_lisp_diag_formatter::write_message_part(
     [[maybe_unused]] std::string_view code, diagnostic_severity sev,
     string8_view message) {
   if (sev == diagnostic_severity::note) {
@@ -76,7 +76,7 @@ void emacs_lisp_error_formatter::write_message_part(
   write_elisp_stringp_escaped_message(this->output_, message);
 }
 
-void emacs_lisp_error_formatter::write_after_message(
+void emacs_lisp_diag_formatter::write_after_message(
     [[maybe_unused]] std::string_view code, diagnostic_severity sev,
     const source_code_span &) {
   if (sev == diagnostic_severity::note) {
diff --git a/src/lsp-diag-reporter.cpp b/src/lsp-diag-reporter.cpp
@@ -33,18 +33,18 @@ void lsp_diag_reporter::report_impl(diag_type type, void *error) {
     this->output_.append_copy(u8",\n"sv);
   }
   this->need_comma_ = true;
-  lsp_error_formatter formatter(/*output=*/this->output_,
-                                /*locator=*/this->locator_);
+  lsp_diag_formatter formatter(/*output=*/this->output_,
+                               /*locator=*/this->locator_);
   formatter.format(get_diagnostic_info(type), error);
 }
 
-lsp_error_formatter::lsp_error_formatter(byte_buffer &output,
-                                         lsp_locator &locator)
+lsp_diag_formatter::lsp_diag_formatter(byte_buffer &output,
+                                       lsp_locator &locator)
     : output_(output), locator_(locator) {}
 
-void lsp_error_formatter::write_before_message(std::string_view code,
-                                               diagnostic_severity sev,
-                                               const source_code_span &origin) {
+void lsp_diag_formatter::write_before_message(std::string_view code,
+                                              diagnostic_severity sev,
+                                              const source_code_span &origin) {
   char8 severity_type{};
   switch (sev) {
   case diagnostic_severity::error:
@@ -84,7 +84,7 @@ void lsp_error_formatter::write_before_message(std::string_view code,
       u8",\"message\":\""sv);
 }
 
-void lsp_error_formatter::write_message_part(
+void lsp_diag_formatter::write_message_part(
     [[maybe_unused]] std::string_view code, diagnostic_severity sev,
     string8_view message) {
   if (sev == diagnostic_severity::note) {
@@ -95,7 +95,7 @@ void lsp_error_formatter::write_message_part(
   write_json_escaped_string(this->output_, message);
 }
 
-void lsp_error_formatter::write_after_message(
+void lsp_diag_formatter::write_after_message(
     [[maybe_unused]] std::string_view code, diagnostic_severity sev,
     const source_code_span &) {
   if (sev == diagnostic_severity::note) {
diff --git a/src/quick-lint-js/c-api-diag-reporter.h b/src/quick-lint-js/c-api-diag-reporter.h
@@ -23,7 +23,7 @@ class lsp_locator;
 class web_demo_locator;
 
 template <class Diagnostic, class Locator>
-class c_api_error_formatter;
+class c_api_diag_formatter;
 
 template <class Diagnostic, class Locator>
 class c_api_diag_reporter final : public diag_reporter {
@@ -45,14 +45,14 @@ class c_api_diag_reporter final : public diag_reporter {
   const char8 *input_;
   monotonic_allocator string_allocator_;
 
-  friend c_api_error_formatter<Diagnostic, Locator>;
+  friend c_api_diag_formatter<Diagnostic, Locator>;
 };
 
 template <class Diagnostic, class Locator>
-class c_api_error_formatter
-    : public diagnostic_formatter<c_api_error_formatter<Diagnostic, Locator>> {
+class c_api_diag_formatter
+    : public diagnostic_formatter<c_api_diag_formatter<Diagnostic, Locator>> {
  public:
-  explicit c_api_error_formatter(
+  explicit c_api_diag_formatter(
       c_api_diag_reporter<Diagnostic, Locator> *reporter);
 
   void write_before_message(std::string_view code, diagnostic_severity,
@@ -70,8 +70,8 @@ class c_api_error_formatter
 QLJS_WARNING_PUSH
 QLJS_WARNING_IGNORE_CLANG("-Wweak-template-vtables")
 
-extern template class c_api_error_formatter<qljs_web_demo_diagnostic,
-                                            web_demo_locator>;
+extern template class c_api_diag_formatter<qljs_web_demo_diagnostic,
+                                           web_demo_locator>;
 extern template class c_api_diag_reporter<qljs_web_demo_diagnostic,
                                           web_demo_locator>;
 
diff --git a/src/quick-lint-js/emacs-lisp-diag-reporter.h b/src/quick-lint-js/emacs-lisp-diag-reporter.h
@@ -17,7 +17,7 @@
 #include <quick-lint-js/token.h>
 
 namespace quick_lint_js {
-class emacs_lisp_error_formatter;
+class emacs_lisp_diag_formatter;
 
 class emacs_lisp_diag_reporter final : public diag_reporter {
  public:
@@ -33,11 +33,11 @@ class emacs_lisp_diag_reporter final : public diag_reporter {
   std::optional<emacs_locator> locator_;
 };
 
-class emacs_lisp_error_formatter
-    : public diagnostic_formatter<emacs_lisp_error_formatter> {
+class emacs_lisp_diag_formatter
+    : public diagnostic_formatter<emacs_lisp_diag_formatter> {
  public:
-  explicit emacs_lisp_error_formatter(output_stream *output,
-                                      emacs_locator &locator);
+  explicit emacs_lisp_diag_formatter(output_stream *output,
+                                     emacs_locator &locator);
 
   void write_before_message(std::string_view code, diagnostic_severity,
                             const source_code_span &origin);
diff --git a/src/quick-lint-js/lsp-diag-reporter.h b/src/quick-lint-js/lsp-diag-reporter.h
@@ -21,7 +21,7 @@
 #include <string>
 
 namespace quick_lint_js {
-class lsp_error_formatter;
+class lsp_diag_formatter;
 
 class lsp_diag_reporter final : public diag_reporter {
  public:
@@ -37,9 +37,9 @@ class lsp_diag_reporter final : public diag_reporter {
   bool need_comma_ = false;
 };
 
-class lsp_error_formatter : public diagnostic_formatter<lsp_error_formatter> {
+class lsp_diag_formatter : public diagnostic_formatter<lsp_diag_formatter> {
  public:
-  explicit lsp_error_formatter(byte_buffer &output, lsp_locator &);
+  explicit lsp_diag_formatter(byte_buffer &output, lsp_locator &);
   void write_before_message(std::string_view code, diagnostic_severity,
                             const source_code_span &origin);
   void write_message_part(std::string_view code, diagnostic_severity,
diff --git a/src/quick-lint-js/text-diag-reporter.h b/src/quick-lint-js/text-diag-reporter.h
@@ -18,7 +18,7 @@
 #include <quick-lint-js/token.h>
 
 namespace quick_lint_js {
-class text_error_formatter;
+class text_diag_formatter;
 
 class text_diag_reporter final : public diag_reporter {
  public:
@@ -35,11 +35,10 @@ class text_diag_reporter final : public diag_reporter {
   bool format_escape_errors_;
 };
 
-class text_error_formatter : public diagnostic_formatter<text_error_formatter> {
+class text_diag_formatter : public diagnostic_formatter<text_diag_formatter> {
  public:
-  explicit text_error_formatter(output_stream *output, const char *file_path,
-                                cli_locator &locator,
-                                bool format_escape_errors);
+  explicit text_diag_formatter(output_stream *output, const char *file_path,
+                               cli_locator &locator, bool format_escape_errors);
 
   void write_before_message(std::string_view code, diagnostic_severity,
                             const source_code_span &origin);
diff --git a/src/quick-lint-js/vim-qflist-json-diag-reporter.h b/src/quick-lint-js/vim-qflist-json-diag-reporter.h
@@ -16,7 +16,7 @@
 #include <string>
 
 namespace quick_lint_js {
-class vim_qflist_json_error_formatter;
+class vim_qflist_json_diag_formatter;
 
 class vim_qflist_json_diag_reporter final : public diag_reporter {
  public:
@@ -41,13 +41,13 @@ class vim_qflist_json_diag_reporter final : public diag_reporter {
   bool need_comma_ = false;
 };
 
-class vim_qflist_json_error_formatter
-    : public diagnostic_formatter<vim_qflist_json_error_formatter> {
+class vim_qflist_json_diag_formatter
+    : public diagnostic_formatter<vim_qflist_json_diag_formatter> {
  public:
-  explicit vim_qflist_json_error_formatter(output_stream *output,
-                                           quick_lint_js::vim_locator &locator,
-                                           std::string_view file_name,
-                                           std::string_view bufnr);
+  explicit vim_qflist_json_diag_formatter(output_stream *output,
+                                          quick_lint_js::vim_locator &locator,
+                                          std::string_view file_name,
+                                          std::string_view bufnr);
   void write_before_message(std::string_view code, diagnostic_severity,
                             const source_code_span &origin);
   void write_message_part(std::string_view code, diagnostic_severity,
diff --git a/src/text-diag-reporter.cpp b/src/text-diag-reporter.cpp
@@ -31,24 +31,24 @@ void text_diag_reporter::set_source(padded_string_view input,
 void text_diag_reporter::report_impl(diag_type type, void *error) {
   QLJS_ASSERT(this->file_path_);
   QLJS_ASSERT(this->locator_.has_value());
-  text_error_formatter formatter(
+  text_diag_formatter formatter(
       /*output=*/&this->output_,
       /*file_path=*/this->file_path_,
       /*locator=*/*this->locator_,
       /*format_escape_errors=*/this->format_escape_errors_);
   formatter.format(get_diagnostic_info(type), error);
 }
 
-text_error_formatter::text_error_formatter(output_stream *output,
-                                           const char *file_path,
-                                           cli_locator &locator,
-                                           bool format_escape_errors)
+text_diag_formatter::text_diag_formatter(output_stream *output,
+                                         const char *file_path,
+                                         cli_locator &locator,
+                                         bool format_escape_errors)
     : output_(*output),
       file_path_(file_path),
       locator_(locator),
       format_escape_errors_(format_escape_errors) {}
 
-void text_error_formatter::write_before_message(
+void text_diag_formatter::write_before_message(
     [[maybe_unused]] std::string_view code, diagnostic_severity sev,
     const source_code_span &origin) {
   cli_source_range r = this->locator_.range(origin);
@@ -72,15 +72,15 @@ void text_error_formatter::write_before_message(
   }
 }
 
-void text_error_formatter::write_message_part(
+void text_diag_formatter::write_message_part(
     [[maybe_unused]] std::string_view code, diagnostic_severity,
     string8_view message) {
   this->output_.append_copy(message);
 }
 
-void text_error_formatter::write_after_message(std::string_view code,
-                                               diagnostic_severity,
-                                               const source_code_span &) {
+void text_diag_formatter::write_after_message(std::string_view code,
+                                              diagnostic_severity,
+                                              const source_code_span &) {
   if (this->format_escape_errors_) {
     this->output_.append_copy(
         u8" [\x1B]8;;https://quick-lint-js.com/errors/"sv);
diff --git a/src/vim-qflist-json-diag-reporter.cpp b/src/vim-qflist-json-diag-reporter.cpp
diff --git a/test/test-translation.cpp b/test/test-translation.cpp
diff --git a/test/test-vim-qflist-json-diag-reporter.cpp b/test/test-vim-qflist-json-diag-reporter.cpp
