[api-extractor] #3465 incorrectly changed defaults for `reportFolder` in the template
mcdurdin opened this issue · comments
Summary
The default for reportFolder is etc
:
The change in #3465 changed this to temp
. This is wrong, and it makes the template comments confusing, because the temp
folder should not be committed to git. The report file is written to both temp and etc on first run.
Details
#3465 should be rolled back.
Standard questions
Please answer these questions to help us investigate your issue more quickly:
Question | Answer |
---|---|
@microsoft/api-extractor version? |
7.41.0 |
Operating system? | Windows |
API Extractor scenario? | reporting |
Would you consider contributing a PR? | Yes |
TypeScript compiler version? | 4.9.5 / 5.3.3 |
Node.js version (node -v )? |
18.14.1 |
@octogonz - Which should be correct here?
Hi all, just chiming in here because I stumbled on this in a new project I created. @mcdurdin is correct that the change made in #3465 is wrong and the PR should be rolled back.
The default value as specified in the defaults is "<projectFolder>/etc/"
, see in code here.
I suspect the confusion is coming from the fact that running api-extractor without the --local
flag will only write the .api.md
file to the reportTempFolder
, which by default is "<projectFolder>/temp/"
. Including the --local
flag will write the file to both folders. This behavior is described in the API report documentation, found here.