build: stop formatting api files

[johnhooks]

I finally figured out why the *.api.md files kept being reformatted! api-extractor uses the code in the lib folder to build the api files, but it wasn't ignored by Prettier so anytime the script format ran it would format all the files in the lib folders, then on the next run of build:types the reformatted code was used!

Changes in this PR

• Add lib to .prettierignore
• Rebuild all the *.api.md files to original output from api-extractor

Now the *.api.md files should only change if the api does.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
dinerojs	✅ Ready (Inspect)	Visit Preview	Nov 30, 2022 at 8:31PM (UTC)

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 2432bc2:

Sandbox	Source
@dinero.js/example-cart-react	Configuration
@dinero.js/example-cart-vue	Configuration
@dinero.js/example-pricing-react	Configuration
@dinero.js/example-starter	Configuration

[sarahdayan]

Uh! How comes this line didn't work? 🤨

[johnhooks]

@sarahdayan because api-extractor must use the declaration files as is and doesn't reformat it.

Steps for issue to happen

• tsc outputs to lib
• api-extractor rolls up declarations using code in lib
• code is committed
• lib isn't removed because leaving it allows for incremental builds, tsc won't rebuild what hasn't changed.
• later on someone runs the script format and the lib directory is formatted because it isn't excluded in .prettierignore
• then someone runs build or build:types
• tsc runs but the code in src hasn't changed, so it doesn't output new files to lib, they are still the reformatted files.
• api-extractor runs using the reformatted code, and rolls up the declaration and *.api.md with the code that was reformatted by Prettier!

Does that make sense... it's a pretty convoluted, multistep issue.

[sarahdayan]

@johnhooks I think what I still don't get is, since Prettier is supposed to ignore all **/*.md files, why it did format them to begin with. No matter where the files are, Prettier should always ignore it, no?

[johnhooks]

@sarahdayan Prettier didn't touch the *.api.md files, it touched all the lib/**/*.d.ts files that api-extractor used to generate the *.api.md files. We could always clean the lib folders, but we would lose incremental build, but we shouldn't let Prettier build artifacts either, otherwise the problem can happen again when build step are used individually.

Sorry, I tried to be detailed in the explanation before, and must have done a bad job describing the issue.

[johnhooks]

@sarahdayan if you want to see exactly what happens.

$ rm -rf packages/*/lib
$ yarn build:types # if your local *.api.md files have been previously modified some of them will have changed
$ git add -A # so you can see what happens next
$ yarn format # watch the output, it formats all the packages/*/lib/**/*.d.ts files, but that didn't modify the git status
$ yarn build:types # *.api.md files have now been generated with the reformatted files

[sarahdayan]

Ah, gotcha now 👍 I was missing that it's not .md files right away.