Document check_path_length to default to False

CONSTRUCT.md

@@ -549,7 +549,7 @@ Only applies if `register_python` is true.
 
 Check the length of the path where the distribution is installed to ensure nodejs
 can be installed.  Raise a message to request shorter paths (less than 46 character)
-or enable long paths on windows > 10 (require admin right). Default is True. (Windows only).
+or enable long paths on windows > 10 (require admin right). Default is False. (Windows only).
 
 ### `check_path_spaces`
 

constructor/_schema.py

@@ -712,11 +712,11 @@ class ConstructorConfiguration(BaseModel):
 
     Only applies if `register_python` is true.
     """
-    check_path_length: bool | None = None
+    check_path_length: bool = False
     """
     Check the length of the path where the distribution is installed to ensure nodejs
     can be installed.  Raise a message to request shorter paths (less than 46 character)
-    or enable long paths on windows > 10 (require admin right). Default is True. (Windows only).
+    or enable long paths on windows > 10 (require admin right). Default is False. (Windows only).
     """
     check_path_spaces: bool = True
     """

constructor/data/construct.schema.json

@@ -456,17 +456,10 @@
       "type": "array"
     },
     "check_path_length": {
-      "anyOf": [
-        {
-          "type": "boolean"
-        },
-        {
-          "type": "null"
-        }
-      ],
-      "default": null,
-      "description": "Check the length of the path where the distribution is installed to ensure nodejs can be installed. Raise a message to request shorter paths (less than 46 character) or enable long paths on windows > 10 (require admin right). Default is True. (Windows only).",
-      "title": "Check Path Length"
+      "default": false,
+      "description": "Check the length of the path where the distribution is installed to ensure nodejs can be installed. Raise a message to request shorter paths (less than 46 character) or enable long paths on windows > 10 (require admin right). Default is False. (Windows only).",
+      "title": "Check Path Length",
+      "type": "boolean"
     },
     "check_path_spaces": {
       "default": true,

constructor/winexe.py

@@ -233,7 +233,7 @@ def make_nsi(
     variables["initialize_by_default"] = info.get("initialize_by_default", None)
     variables["register_python"] = info.get("register_python", True)
     variables["register_python_default"] = info.get("register_python_default", None)
-    variables["check_path_length"] = info.get("check_path_length", None)
+    variables["check_path_length"] = info.get("check_path_length", False)
     variables["check_path_spaces"] = info.get("check_path_spaces", True)
     variables["keep_pkgs"] = info.get("keep_pkgs") or False
     variables["pre_install_exists"] = bool(info.get("pre_install"))

docs/source/construct-yaml.md

@@ -549,7 +549,7 @@ Only applies if `register_python` is true.
 
 Check the length of the path where the distribution is installed to ensure nodejs
 can be installed.  Raise a message to request shorter paths (less than 46 character)
-or enable long paths on windows > 10 (require admin right). Default is True. (Windows only).
+or enable long paths on windows > 10 (require admin right). Default is False. (Windows only).
 
 ### `check_path_spaces`
 

news/1036-check-path-length-docs

@@ -0,0 +1,20 @@
+### Enhancements
+
+* <news item>
+
+### Bug fixes
+
+* <news item>
+
+### Deprecations
+
+* <news item>
+
+### Docs
+
+* Document that `check_path_length` defaults to `False` in line with prior behavior and declare
+  it as `bool` only in the schema. (#1036)
+
+### Other
+
+* <news item>