Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue #25: Ensure only needed files are packaged #44

Closed
wants to merge 1 commit into from

Conversation

matthieubosquet
Copy link
Contributor

This is a proposal to solve the issue of packaging unnecessary files.

It is achieved by moving the types to a src directory and building the types into a dist directory identified in package.json's files.

master...matthieubosquet:rdfjs-types:packaging

I updated the GitHub actions and simplified the tsconfig to accommodate those changes.

Running npm pack packages the files as shown in below screenshot:

Screenshot 2024-09-09 at 16 17 39

Copy link

changeset-bot bot commented Sep 9, 2024

🦋 Changeset detected

Latest commit: 0ca4d83

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@rdfjs/types Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

@tpluscode tpluscode left a comment

Choose a reason for hiding this comment

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

Wouldn't a simple solution be to add and .npmignore file or more precise list of files in package.json?

@matthieubosquet
Copy link
Contributor Author

It certainly would be a simple solution but making the configuration and packaging more complex seems detrimental to long term maintainability of this project. Hence my choice of moving files to a familiar and widespread directory structure.

@rubensworks
Copy link
Member

Thanks for the PR @matthieubosquet!

It does look like this PR does much more than just fixing #44.
I'm sure they are valuable, but in order to keep our commit history valid, we may want to apply these changes incrementally.

I'm also in favor of the files entry approach. I don't mind the current directory structure (without dist) tbh.

@matthieubosquet
Copy link
Contributor Author

As per suggestions: #47.

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