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

CONTRIBUTING.md Guide Lacking "make" Instruction #504

Open
psychemedia opened this issue Apr 6, 2022 · 4 comments
Open

CONTRIBUTING.md Guide Lacking "make" Instruction #504

psychemedia opened this issue Apr 6, 2022 · 4 comments

Comments

@psychemedia
Copy link

As a non-developer wanting to add FTS-5 support to my own build, I followed the instructions in https://github.com/sql-js/sql.js/blob/master/CONTRIBUTING.md and noted that:

  • step 6 of the Containerized Development Environment (Recommended) section ("Run $ npm test to ensure all tests pass") fails;
  • there is no explicit mention of running make to actually build the distribution assets.

Is there any particular reason why there is no explicit instruction to run make? This would be useful for folk who aren't developers but who may want to make use of a sql.js build with some custom sqlite extensions if there are exact and complete instructions available to do so. (The containerised build really helps in that respect.)

@twoxfh
Copy link

twoxfh commented Apr 6, 2022

As a non-developer wanting to add FTS-5 support to my own build, I followed the instructions in https://github.com/sql-js/sql.js/blob/master/CONTRIBUTING.md and noted that:

  • step 6 of the Containerized Development Environment (Recommended) section ("Run $ npm test to ensure all tests pass") fails;
  • there is no explicit mention of running make to actually build the distribution assets.

Is there any particular reason why there is no explicit instruction to run make? This would be useful for folk who aren't developers but who may want to make use of a sql.js build with some custom sqlite extensions if there are exact and complete instructions available to do so. (The containerised build really helps in that respect.)

The documentation refers to npm commands which are defined in the package.json file in the root directory which is common for npm modules. The npm commands can contain one or more system commands to perform the action. Make is performed when using npm run build and npm run rebuild. Hope this helps.

@psychemedia
Copy link
Author

Thanks, that's what I expected, but I used the dev container and ran the npm commands and the build didn't happen? But it did when I ran make?

@johncardiologs
Copy link

This sounds a little bit like my first experience building sql.js here: #526

Perhaps the instructions should clarify that an initial npm run rebuild (i.e. make) is needed!

@llimllib
Copy link
Contributor

llimllib commented Sep 4, 2022

oddly, npm rebuild managed to not run make for me - even though I can't figure out exactly why

$ npm rebuild
rebuilt dependencies successfully

then,

$ npm test

> sql.js@1.7.0 test
> npm run lint && npm run test-asm && npm run test-asm-debug && npm run test-wasm && npm run test-wasm-debug && npm run test-asm-memory-growth
...snip...
Error: Cannot find module '../dist/sql-asm.js'

After that I ran make myself, and everything started working

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

4 participants