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

Document build process #123

Open
aral opened this issue Jul 26, 2019 · 0 comments
Open

Document build process #123

aral opened this issue Jul 26, 2019 · 0 comments

Comments

@aral
Copy link

aral commented Jul 26, 2019

To reproduce

  1. Fork express-ws

  2. Include your fork via its GitHub URL in your project (e.g., github:aral/express-ws#referential-routes – this will actually demonstrate the problem)

  3. Run your app/tests.

What should happen

It should work.

What actually happens

…/node_modules/express-ws/index.js:1
Error: Cannot find module './src/index'`

Why it happens

There is an .npmignore file that ignored the src/ directory.

The actual issue

There’s a pre-publish process that uses Babel that’s not documented or captured in the repository.

Suggested fix

Document build process and add any necessary configuration / dev-dependencies to the repository.

Workaround

Delete the .npmignore file.

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

No branches or pull requests

1 participant