PathTooLongException

[petermorlion]

Hi, I'm wondering if anyone else has experienced a PathTooLongException when generating docs, and if there is a workaround.

[simonmurdock]

I hit this issue all the time with all my tools. I just have to work out of C:\dev\branch\

[petermorlion]

Thanks, I'll give that a try.

[chenkennt]

Hi @petermorlion , PathTooLong is a restriction in Windows (maximum 260 characters). If you met this issue, please try to reduce the length of your working directory. We'll also improve the error message.

[gitting]

This just happened to me after updating some package with npm.

I found flatten-packages useful to fix this. Just install it as they say, then run in the directory where your offending project.json is.

[superzadeh]

I also face this problem, one possible workaround would be to use the BCL team's LongPath library. Would that be an acceptable workaround? If so, I could start working on a PR for this.

[superyyrrzz]

The exclude field in docfx.json can be used to filter out the unwanted folder since DocFX 1.9, e.g. "exclude": ["**/node_modules/", "**/bower_components/"]. Remember to exclude them in both metadata and build step if needed.

[superzadeh]

The problem is that some of these long paths are wanted (they're not node/jspm modules, they're actual code).