diff --git a/CONSTRUCT.md b/CONSTRUCT.md index d368e486b..77155d3e9 100644 --- a/CONSTRUCT.md +++ b/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` diff --git a/constructor/_schema.py b/constructor/_schema.py index f71acc9f3..c77a00cf2 100644 --- a/constructor/_schema.py +++ b/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 """ diff --git a/constructor/data/construct.schema.json b/constructor/data/construct.schema.json index 676cfe269..5914be40e 100644 --- a/constructor/data/construct.schema.json +++ b/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, diff --git a/constructor/winexe.py b/constructor/winexe.py index 913b07b17..f4ef11335 100644 --- a/constructor/winexe.py +++ b/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")) diff --git a/docs/source/construct-yaml.md b/docs/source/construct-yaml.md index d368e486b..77155d3e9 100644 --- a/docs/source/construct-yaml.md +++ b/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` diff --git a/news/1036-check-path-length-docs b/news/1036-check-path-length-docs new file mode 100644 index 000000000..097b13c83 --- /dev/null +++ b/news/1036-check-path-length-docs @@ -0,0 +1,20 @@ +### Enhancements + +* + +### Bug fixes + +* + +### Deprecations + +* + +### 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 + +*