doc

Author: HerrCai0907

clang-tools-extra/clang-tidy/ClangTidyOptions.cpp

@@ -228,7 +228,7 @@ template <> struct MappingTraits<ClangTidyOptions> {
     IO.mapOptional("InheritParentConfig", Options.InheritParentConfig);
     IO.mapOptional("UseColor", Options.UseColor);
     IO.mapOptional("SystemHeaders", Options.SystemHeaders);
-    IO.mapOptional("CustomeChecks", Options.CustomChecks);
+    IO.mapOptional("CustomChecks", Options.CustomChecks);
   }
 };
 

clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp

@@ -60,6 +60,8 @@ Configuration files:
   Checks                       - Same as '--checks'. Additionally, the list of
                                  globs can be specified as a list instead of a
                                  string.
+  CustomChecks                 - Array of user defined checks based on
+                                 clang-query syntax.
   ExcludeHeaderFilterRegex     - Same as '--exclude-header-filter'.
   ExtraArgs                    - Same as '--extra-arg'.
   ExtraArgsBefore              - Same as '--extra-arg-before'.

clang-tools-extra/docs/ReleaseNotes.rst

@@ -96,6 +96,9 @@ Improvements to clang-tidy
   `SystemHeaders` option is enabled.
   Note: this may lead to false negatives; downstream users may need to adjust
   their checks to preserve existing behavior.
+- :program:`clang-tidy` now supports query based custom checks by `CustomChecks`
+  configuration option.
+  :doc:`Query Based Custom Check Document <clang-tidy/QueryBasedCustomChecks>`
 
 New checks
 ^^^^^^^^^^

clang-tools-extra/docs/clang-tidy/QueryBasedCustomChecks.rst

@@ -0,0 +1,57 @@
+====================================
+Query Based Custom Clang-Tidy Checks
+====================================
+
+Introduction
+============
+
+This page provides examples of how to add query based custom checks for
+:program:`clang-tidy`.
+
+Custom checks are based on clang-query syntax. Every custom checks will be
+registered in `custom` module to avoid name conflict. They can be enabled or
+disabled by the checks option like the builtin checks.
+
+Custom checks support inheritance from parent configurations like other
+configuration items.
+
+Configuration
+=============
+
+`CustomChecks` is a list of custom checks. Each check must contain
+  - Name: check name can been used in `-checks` option.
+  - Query: query string
+  - Diagnostic: list of diagnostics to be reported.
+     - BindName: name of the node to be bound in `Query`.
+     - Message: message to be reported.
+     - Level: severity of the diagnostic, the possible values are `Note`, `Warning`, `Error`.
+
+Example
+=======
+
+.. code-block:: yaml
+
+  Checks: -*,custom-call-main-function
+  CustomChecks:
+    - Name: call-main-function
+      Query: |
+          match callExpr(
+            callee(
+              functionDecl(isMain()).bind("fn")
+            )
+          ).bind("callee")
+      Diagnostic:
+        - BindName: fn
+          Message: main function.
+          Level: Note
+        - BindName: callee
+          Message: call to main function.
+          Level: Warning
+
+.. code-block:: c++
+
+  int main(); // note: main function.
+
+  void bar() {
+    main(); // warning: call to main function. [custom-call-main-function]
+  }

clang-tools-extra/docs/clang-tidy/index.rst

@@ -10,6 +10,7 @@ See also:
    :maxdepth: 1
 
    List of Clang-Tidy Checks <checks/list>
+   Query Based Custom Clang-Tidy Checks <QueryBasedCustomChecks>
    Clang-tidy IDE/Editor Integrations <Integrations>
    Getting Involved <Contributing>
    External Clang-Tidy Examples <ExternalClang-TidyExamples>
@@ -292,6 +293,8 @@ An overview of all the command-line options:
     Checks                       - Same as '--checks'. Additionally, the list of
                                    globs can be specified as a list instead of a
                                    string.
+    CustomChecks                 - Array of user defined checks based on
+                                   clang-query syntax.
     ExcludeHeaderFilterRegex     - Same as '--exclude-header-filter'.
     ExtraArgs                    - Same as '--extra-arg'.
     ExtraArgsBefore              - Same as '--extra-arg-before'.

clang-tools-extra/test/clang-tidy/checkers/custom/Inputs/clang-tidy.yml

@@ -1,4 +1,4 @@
-CustomeChecks:
+CustomChecks:
   - Name: test-diag-level
     Query: |
       match varDecl(

clang-tools-extra/test/clang-tidy/checkers/custom/Inputs/incorrect-clang-tidy.yml

@@ -1,4 +1,4 @@
-CustomeChecks:
+CustomChecks:
   - Name: test-let-bind
     Query: |
       let expr varDecl(isStaticStorageClass()).bind("vd")

clang-tools-extra/test/clang-tidy/infrastructure/Inputs/custom-query-check/append-clang-tidy.yml

@@ -1,5 +1,5 @@
 InheritParentConfig: true
-CustomeChecks:
+CustomChecks:
   - Name: function-decl
     Query: match functionDecl().bind("func")
     Diagnostic:

clang-tools-extra/test/clang-tidy/infrastructure/Inputs/custom-query-check/override-clang-tidy.yml

@@ -1,4 +1,4 @@
-CustomeChecks:
+CustomChecks:
   - Name: avoid-long-type
     Query: |
       match varDecl(

clang-tools-extra/test/clang-tidy/infrastructure/Inputs/custom-query-check/root-clang-tidy.yml

@@ -1,4 +1,4 @@
-CustomeChecks:
+CustomChecks:
   - Name: avoid-long-type
     Query: |
       match varDecl(

clang-tools-extra/test/clang-tidy/infrastructure/custom-query-check.cpp

@@ -23,7 +23,7 @@ void f();
 // LIST-CHECK:   custom-avoid-long-type
 // LIST-CHECK:   custom-function-decl
 
-// DUMP-CONFIG: CustomeChecks:
+// DUMP-CONFIG: CustomChecks:
 // DUMP-CONFIG: - Name: avoid-long-type
 // DUMP-CONFIG:   Query: |
 // DUMP-CONFIG:     match varDecl(