DX Scanner

DX Scanner is an open source CLI tool that allows you to “measure” Developer Experience directly based on your source code. DX Scanner recommends practices that can help you with improving your product development.

What language is supported?

Getting Started 🏁

Installation

• with NPM

  npm install -g dx-scanner

• with Yarn

  yarn global add dx-scanner

Usage

Scan repository

dx-scanner https://github.com/DXHeroes/dx-scanner

Scan local path

dx-scanner ~/my-project

All options

dx-scanner [path]

Aliases

dx-scanner [path]

dxscanner [path]

dxs [path]

Configuration ⚙️

Add dxscannerrc.* config file to change default configuration. It can be a .json, .yml, and even a dotfile!

Practices
You can switch off practices you do not want to scan or change its impact. Use the id of the practice.

Possible impact:

high

medium

small

hint

off

Example :

{
    "practices": {
        "JavaScript.GitignoreCorrectlySet": "medium",
        "JavaScript.LoggerUsed": "off"
    }
}

Contributing 👩‍💻 👨‍💻

Feel free to contribute to our DX Scanner. Please follow the Contribution Guide.

License 📝

The DX Scanner open source project is licensed under the MIT.

Contributors ✨

Many thanks to these wonderful people (emoji key):

Prokop Simek 💻 🚧

adelkah 💻 🚧

Radek Holý 💻

Vratislav Kalenda 💻 🤔

Petr Vnenk 💻

This project follows the all-contributors specification. Any kind of contributions are welcome!