Skip to content
This repository has been archived by the owner on Feb 6, 2021. It is now read-only.

dsafio/dsafio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Dsafio 🀘

Travis CI Snyk

Practicing tool for coders.

Up and Running πŸƒ

It's a Commander.js powered Node.js CLI.

Requirements

You need Node.js to run the CLI. We recommend asdf to manage your Node.js environment.

Install the CLI

npm install -g dsafio

Contributing πŸ‘·

Dsafio is a Node.js command-line tool. You'll want to have the development version of the dsafio command in your $PATH. Besides it, it will feel like a normal Node.js project for you. It's built with Commander.js, tested with Mocha, Chai and Sinon.JS, with Prettier as coding standard.

Development environment

Depending on how is your $PATH, you might need to uninstall dsafio as global:

npm uninstall -g dsafio

It's a typical Node.js project. Dependencies are managed via npm:

npm install

Now, just link the development executables:

npm link

dsafio command should now be available in your shell.

Unlinking the development version

If you ever need to unlink the global version (eg.: you want to install the production version directly from npm), you will want to unlink the development version first:

npm unlink

Conventional Commits

We use Conventional Commits in our commit history. It is a specification for commit messages that help us automate versioning processes. Please refer to its website for more information.

Testing βœ…

Test can be run with the following command:

npm test

It's possible to run them in watch mode:

npm run test:watch

Style Guide 🌷

We use Prettier.

License πŸ“„

MIT