Skip to content

Track generated dist/*.d.ts alongside the other artifacts - #159

Merged
botandrose merged 1 commit into
bigskysoftware:mainfrom
myabc:fix/track-generated-dts
Aug 26, 2026
Merged

Track generated dist/*.d.ts alongside the other artifacts#159
botandrose merged 1 commit into
bigskysoftware:mainfrom
myabc:fix/track-generated-dts

Conversation

@myabc

@myabc myabc commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Note

Missed as part of #153.

Running the build leaves dist/idiomorph.d.ts and dist/idiomorph-ext.d.ts permanently untracked, so git status is never clean afterwards:

$ git status --short
?? dist/idiomorph-ext.d.ts
?? dist/idiomorph.d.ts

They are the only thing npm run dist produces that was never added to git. Nothing ignores them either, so they just sit there as noise. This adds both files.

Tracking them because they are generated from dist/*.esm.js rather than from src/ means they move in lockstep with the artifacts already committed. They add no churn outside the release commit, which already touches all of dist/. It also keeps types working for anyone installing straight from the repository, since package.json points "types" at dist/idiomorph.d.ts.

The alternative was dist/*.d.ts in .gitignore. I checked that would not break publishing because the files allow-list wins over .gitignore, so npm pack still includes both. This splits dist/ into some artifacts tracked and some ignored. I will switch if you would rather not carry the files.

Copilot AI lite review requested due to automatic review settings August 26, 2026 01:50

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review any files in this pull request.


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@myabc myabc changed the title track generated dist/*.d.ts alongside the other artifacts Track generated dist/*.d.ts alongside the other artifacts Aug 26, 2026
The only artifact `npm run dist` produces that was never added to git,
so it sat untracked and dirtied the working tree after every build.

Generated from dist/*.esm.js rather than src/, so these move in
lockstep with the artifacts already committed, and add no churn
outside the release commit.
@myabc
myabc force-pushed the fix/track-generated-dts branch from abd4a04 to d073b74 Compare August 26, 2026 01:52
@myabc

myabc commented Aug 26, 2026

Copy link
Copy Markdown
Contributor Author

@botandrose In line with your comment on build artifacts, I didn't end up committing any files in dist/, but I think it probably does make sense to go ahead and track dist/*.d.ts until a release comes out (the churn should be minimal).

@botandrose
botandrose merged commit 9f247ec into bigskysoftware:main Aug 26, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants