feat(learn): add article for publishing a typescript package

[JakobJingleheimer]

Description

Document the recommended way to publish a typescript package

Validation

Related Issues

nodejs/typescript#19

Depends on #7229

Check List

• I have read the Contributing Guidelines and made commit messages that follow the guideline.
• I have run npm run format to ensure the code follows the style guide.
• I have run npm run test to check if all tests are passing.
• I have run npx turbo build to check if the website builds without errors.
• I've covered new added functionality with unit tests if necessary.

[vercel]

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

Name	Status	Preview	Updated (UTC)
nodejs-org	✅ Ready (Inspect)	Visit Preview	Feb 2, 2025 2:15pm

[AugustinMauroy]

Jacob you should:

• remove lint thing
• explain tsc cli (may be redirect to the previous page)
• link to --run https://nodejs.org/en/learn/command-line/run-nodejs-scripts-from-the-command-line#run-a-task-with-nodejs
• remove comment on GA example # glob is not backported below 22.x that from nodejs-loaders 😁
• Also on GA example you put node --run test, but on package.json example it's missing
• If you keep test thing maybe add link to the test runner part.

[jakebailey]

All of the threads about it appear to have been marked "resolved", but I really can't express enough how much I do not like the idea of having a src dir but then also tell tsc to dump its output into the package root above src. There are so many downsides with that approach, and I have never seen that in the wild in any TypeScript project.

I do not think a publishing guide we'd write for our own website would suggest something like it. And in a future release, we are expecting to simplfiy tsc --init and have it pre-populate tsconfig.json with rootDir=./src, outDir=./dist (microsoft/TypeScript#58420). That is the least problematic way to do it (both for TS's handling but also when dealing with other tools).

I would even prefer not having a src dir and just letting the JS files be dumped next to the TS, becuase that would be easier to explain / avoid problems with than the mismatch.

[JakobJingleheimer]

@jakebailey I don't understand: there are examples with src/ + test/ + dist/. Here are screenshots from the deployed article:

---

@AugustinMauroy do you have any idea why the vertical line characters are rendering weirdly?

[jakebailey]

I don't understand: there are examples with src/ + test/ + dist/. Here are screenshots from the deployed article:

There's one example as a tree, yes, but that is not the tsconfig provided in the post, which the one people are going to copy without really understanding the impliciations (since dist is not mentioned anywhere else except the ASCII diagram). The npmignore doesn't reflect dist, and still don't handle .mts/.cts.

[JakobJingleheimer]

not the tsconfig provided in the post, […]. The npmignore doesn't reflect dist, and still don't handle .mts/.cts.

Ahh, I'll add those (hopefully either tomorrow or Sunday).

[AugustinMauroy]

@AugustinMauroy do you have any idea why the vertical line characters are rendering weirdly?

Strange I'll dedicate time on that

[AugustinMauroy]

Bump for codetab, I'll open an issue because it's an error on our side not on shiky or your docs