Skip to content

Document build process #123

Open
Open
@aral

Description

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.

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions