Add `:npm-deps` to the JavaScript Modules guide

Open
#80 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript, node.js
Domain
documentation

Research direction

Start with the JavaScript Modules guide in the clojurescript-site documentation and locate the section covering :npm-deps. Add the stated package.json caveat for some NPM/Node versions, then verify that the guide clearly explains the resulting installation behavior.

Written by the indexing model from the issue text.

Description

minor

One particular caveat to mention is that, in some versions of NPM/Node, users need to have a package.json file present in the directory they're developing in or NPM will install modules to a parent directory.

Dominant language
Shell
Stars
107
Forks
130
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from clojure/clojurescript-site

All issues in clojure/clojurescript-site

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.