From 774899f8b9a1f4c9a4e0148561fd88f71fe4b64f Mon Sep 17 00:00:00 2001 From: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com> Date: Fri, 4 Mar 2022 15:45:10 -0800 Subject: [PATCH] Note git's core.longpaths in CONTRIBUTING (#45069) * Note git's core.longpaths in CONTRIBUTING So people will be able to clone the repo on Windows. However, I'm not sure whether this addresses running tests. * Address PR comments --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d32388a1ff..741f329d86d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,6 +81,10 @@ If you prefer to develop using containers, this repository includes a [developme The TypeScript repository is relatively large. To save some time, you might want to clone it without the repo's full history using `git clone --depth=1`. +### Filename too long on Windows + +You might need to run `git config --global core.longpaths true` before cloning TypeScript on Windows. + ### Using local builds Run `gulp` to build a version of the compiler/language service that reflects changes you've made. You can then run `node /built/local/tsc.js` in place of `tsc` in your project. For example, to run `tsc --watch` from within the root of the repository on a file called `test.ts`, you can run `node ./built/local/tsc.js --watch test.ts`.