Give reasoning for using ts_project#validate

bazel-contrib · Jun 6, 2021 · 07dd8d4 · 07dd8d4
1 parent a79ad82
commit 07dd8d4
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/packages/typescript/internal/ts_project.bzl b/packages/typescript/internal/ts_project.bzl
@@ -541,7 +541,10 @@ def ts_project_macro(
 
             For example, `typescript_require_path = "typescript"`
 
-        validate: boolean; whether to check that the tsconfig settings match the attributes.
+        validate: boolean; whether to check that the tsconfig JSON settings match the attributes on this target.
+            
+            Set this to `False` to skip running our validator, in case you have a legitimate reason for these to differ,
+            e.g. you have a setting enabled just for the editor but you want different behavior when Bazel runs `tsc`.
 
         supports_workers: Experimental! Use only with caution.