MagicMirrorOrg / MagicMirrorOrg/MagicMirror-3rd-Party-Modules
Suggestion for module check: "npm install --omit=dev"
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 48
- Forks
- 10
- PR merge metrics
- No merged PRs in 30d
Description
I was just recently setting up a new mirror and had to reinstall all modules. I noticed that many had security warnings on npm install, and when I looked deeper, some could be avoided by not installing the dev dependencies. Given that most users don't dev, should we include a check that suggests to maintainers that they include npm install --omit=dev in their install and update instructions to avoid unnecessary dependency installs?
We could even go so far as to only offer this suggestion when there is a devDependencies section in the package.json
Maybe that gets too complicated given that we then need to include a dev section at the end that explains to install the dev dependencies.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing module checks and the install/update guidance, then inspect how package.json devDependencies are detected. Define whether the suggestion applies only when devDependencies exists and how developer installs are explained; done means the behavior and wording are agreed and covered by the relevant checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js, typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100