dsafio / challenges

The main challenge repository of Dsafio

Dsafio 🤘

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

challenges's Issues

JavaScript Standard Style on CI

We need to lint challenges' source code during CI too.

See dsafio/dsafio#15.

Migrate to Prettier

Dsafio has been using Standard as its code formatting style, but since Prettier has become this popular beast, the project has moved on with the community. The command-line did it a few months ago, and now it's time to do it in the main challenges repository.

Migrate to Jest

We have been using Mocha for test cases due to its popularity and simplicity, but Jest has proven to be an interesting tool with most of the features a developer would need while testing a JavaScript project. We should replace Mocha with Jest for a better experience when writing tests.