@hypersprite/hs-utils
v2.0.0
Published
Variouse utils for dealing with npm packaging
Downloads
4
Readme
hs-utils
Some utilities for managing npm packages.
For best results use npm 5.2 or later.
Usage
Install
This should be a dev dependency
npm i -D --save @hypersprite/hs-utils
Setup
Optional setup needed for --projects
commands.
Add a section for hsUtils
to the package.json file that contains.
projectDirs
is an array of related project directories you want to work with.
compareTo
is a usually a main or master project directory, will use installed directory if none is defined.
These are based on the location of the package.json file.
Example folder structure:
~/all-code $ tree -L 2
.
├── modules-code
│ ├── this-project
│ ├── project-one
│ └── project-two
├── main-project
└── project-three
The hsUtils of this-project
package.json might look like this:
"hsUtils": {
"projectDirs": [
"project-one",
"project-two",
"../project-three"
],
"compareTo": "../main-project"
},
Usage
Runs npm install
on each projectDirs project
npx hs-utils --projects install
Remove node_modules folders from each projectDirs project.
npx hs-utils --projects clean
Compares Prod and Dev dependencies based on the package.json file for each projectDir project to the compareTo project. The output will show you what is missing or different version than the compareTo
.
npx hs-utils --projects compare
Runs npm outdated on each projectDirs project. Same as running npm outdated in the projects directory.
npx hs-utils --projects outdated
Validate package.json file for basic things.
npx hs-utils --package validate
find/replace text in the package.json file
npx hs-utils --pacakge rename --old component-starter --new cool-component
All commands can take a --debug
flag for extra output, prefixed with hsUtils.
If npm 5.2 is not available, commands could be placed in the scripts section of the package.json file but this is less convenient.