thlorenz / brace

📔 browserify compatible version of the ace editor.
http://thlorenz.github.io/brace/
MIT License
1.06k stars 302 forks source link

Remove example/node_modules folder to fix npm install issues #154

Open cstigler opened 5 years ago

cstigler commented 5 years ago

Summary

Removes the example/node_modules folder in order to fix some issues I found - specifically, I was unable to install brace from the GitHub repo using a recent version of npm.

Backstory

Using node 10.15.0 and npm 6.4.1, I was having issues installing brace. Specifically, it worked when I just used npm install brace, but not when I ran npm install brace@thlorenz/brace which should install the version on GitHub. I verified that this was the case even using alternative parameters, for example the https:// and git:// URLs.

When trying to install this repo from GitHub, I received a premature close error from npm, and upon further digging in the logs found the relevant error message: silly fetchPackageMetaData error for brace@github:thlorenz/brace premature close. Although this looks like a problem with the package.json file, I didn't see any.

After some investigation, it looks like the example/node_modules folder was causing the issues installing from GitHub. While I don't understand the npm install internals, my guess is that the symlinks are the cause of the issues.

Luckily, these seem to be very non-essential files - anybody looking to use the example can just run npm install themselves if they'd like - so deleting them seems like a good option to save frustration in the future!

Testing

Not much should be required, since this is only touching example files.