Installing from git dependency is broken

[grosmar]

When installing from git (i.e. npm i indic-transliteration/sanscript.js), then it's broken, as the prepare script is running transpile script, which will need the scheme files stored in the submodule, but npm doesn't handle submodules anymore.

Best proposal would be to reference schemes as npm package, and not a submodule.

What do you think?

[vvasuki]

https://github.com/indic-transliteration/common_maps is not specific to js or npm. So, I don't like the idea of adding npm packaging files there. What are the alternatives?

[grosmar]

I understand your concern, however beside the fact package.json would be a bit of "noise" there, it doesn't have any other effect on the repo itself.

Other options:

• Using napa, this way we still can use it as a depenency, even if it doesn't contain a package.json I don't like it, as you have control over the repo, so why? And also controlling dependency versions, etc. is way less common this way, no semver possibilites, etc.
• Pull the repo in a preinstall script and copy the contents of it to the src/schemes. This is pretty nasty imho and I would avoid it.

So I still would propose my first solution and introduce a package.json in the common_maps, unless you are extremely against it.

[vvasuki]

Is it just a matter of adding a single file (package.json)?

How would local development work? (Consider a workflow where you alter a schema definition, add and run some tests - what steps would be involved?)

[grosmar]

Yes, it would be just an extra package.json file

Check out the implementation proposal: https://github.com/grosmar/sanscript.js/blob/schema-dependecy/package.json#L117 https://github.com/grosmar/common_maps/tree/package-json

As you can see, there is a dependency to the github repository, submodule is removed, build file modified to point into the node_modules/common_maps

Regarding the local workflow, you can use npm link check out here Even simpler than modifying all the time the git submodule commit hash.

You simply work in your local directory of the dependency package and it's effect is immediate (of course only locally).

[vvasuki]

I suppose that since npm build and publish will continue to work fine? If so, please go ahead and send a PR. Also update README.md to remove "Adding new schemes" section and add a pointer to npm link.

[grosmar]

Sure, everything should work prefectly. Build already modified for this, I guess the publish is using the build script, so it should be fine, but that part should be checked by you after I send the PR, as I have no rights to publish to your npm repo.

I will finish the implementation and send the PRs

[grosmar]

Created 2 PR-s.

1. First need to merge common_maps PR,
2. Release common_maps to npm under the name @sanskrit-coders/common_maps
3. Merge the second PR I created for sanscript.js

[vvasuki]

Done and published to https://www.npmjs.com/org/indic-transliteration (old package location deprecated.)