project scaffolding, opinion enforcer, and build tooling!
npm install --save-dev ripcord
ripcord really do?
what rules & opinions does ripcord apply? see module.exports.rules.
here are some hypothetical use cases:
ripcordrules into to your project, simply install it or update it into your project!
ripcord report [-o /path/to/report]
pro tip: if you install ripcord globally (
[sudo] npm i -g ripcord) and have
ripcord installed locally, you can simply run
ripcord [cmd] in your project.
ripcord will detect a local copy and run that version. rad+!
what else can it do?
api docs found here
generate dependency report. operates in two modes:
package.jsondepedencies & devDependencies as sole source of external depedencies
dependenciesare used, and uses remaining
devDependenciesas source of external devDependencies
ripcord report --helpfor more info
deploy or check project conventions thanks to counsel.
check or dump (output) project licenses. only outputs licenses for
devDependencies by default.
licenses [options] <check|dump>
sync packages from npm repo to repo. current implementation assumes artifactory API present to successfully copy!
ripcord sync-packages --help
.ts, be mindful that they must be compiled. simply running
node_modules/.bin/tsc --watchwill fire off the compiler and auto-watch the ts files. fear not, the compiled files include source maps, so you can debug the TypeScript content naturally.
VSCode. this package bundles some helpful workspace settings:
this modules digs deep into your
node_modules. hence, consistent structure and content are imperative for reporting and license features to work. consequently, we recommend only officially using npm, at least for builds.