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

Include src in npm package #2296

Open
Cretezy opened this issue Apr 14, 2022 · 2 comments
Open

Include src in npm package #2296

Cretezy opened this issue Apr 14, 2022 · 2 comments
Labels
proposal Applied to issues that are a proposal for an implementation stale This issue or PR has not had any activity recently

Comments

@Cretezy
Copy link

Cretezy commented Apr 14, 2022

Context

Sometimes while digging through code, it's useful to see the original implementation of a method.

Proposal

Include src in the published npm package, allowing "Go to implementation" in editor. Example change: ce8ec03

@eonarheim eonarheim added the proposal Applied to issues that are a proposal for an implementation label Apr 17, 2022
@eonarheim
Copy link
Member

I agree this would be very useful!

One way this could work in the current state would be to use Excalibur as a git submodule and import the main entry point (something like import * as ex from ./lib/excalibur/src/engine). Although git submodules are notoriously tricky and full of sharp corners.

I found an interesting concept mentioned online called a "source package", which would be a separate package that would contain the raw source files and allow users to opt-in to source files https://stackoverflow.com/a/57534667, CRA has a proposal

@kamranayub @jedeen What do you think about exploring and potentially publishing a "source package"? Or does it make sense to include all the source in the main package?

@github-actions
Copy link

This issue hasn't had any recent activity lately and is being marked as stale automatically.

@github-actions github-actions bot added the stale This issue or PR has not had any activity recently label Jun 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal Applied to issues that are a proposal for an implementation stale This issue or PR has not had any activity recently
Projects
None yet
Development

No branches or pull requests

2 participants