Skip to content
CLI tool that allows you to measure quality of an app based on your source code.
TypeScript JavaScript Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
.vscode
bin
src
test
typings
.all-contributorsrc
.dxscannerrc.yaml
.editorconfig
.eslintrc.json
.gitignore
.nvmrc
.prettierrc
.releaserc
.renovaterc
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE
README.md
codecov.yml
demo.svg
jest.config.js
package.json
tsconfig.json
yarn.lock

README.md

Tweet

DX Scanner

Version Travis (.org) Codecov last commit GitHub commit activity Downloads/week GitHub contributors All Contributors NPM oclif TypeScript

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.

DX Scanner Demo

What language is supported?

Language Supported
JavaScript/TypeScript
Java
Python 🚧
PHP 🚧
C++ 🚧
C# 🚧
Ruby 🚧

Getting Started 🏁

Installation

  • with NPM

    npm install -g dx-scanner

  • with Yarn

    yarn global add dx-scanner

Usage

Scan your project for possible DX recommendations.

USAGE
  $ dx-scanner [PATH] [OPTIONS]

OPTIONS
  -a, --authorization=authorization  Credentials to the repository.
  -h, --help                         Help
  -i, --init                         Initialize DX Scanner configuration
  -j, --json                         Print report in JSON
  -r, --recursive                    Scan all components recursively in all sub folders
  -v, --version                      Output the version number
  --fail=high|medium|small|off|all   Run scanner in failure mode. Exits process with code 1 for any non-practicing condition of
                                     given level.

ALIASES
  $ dx-scanner dxs
  $ dx-scanner dxscanner

EXAMPLES
  dx-scanner
  dx-scanner ./ --fail=high
  dx-scanner github.com/DXHeroes/dx-scanner

Configuration ⚙️

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

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

Possible impact:

high

medium

small

hint

off

Example :

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

Score Computation 💯

Impact of each practice is represented by a specific value. DX Scanner uses the values to count the overall DX Score.

high = 100 points

medium = 75 points

small = 50 points 

hint = 25 points

The practices you have switched off are not included in the calculation (0 points).

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
Prokop Simek

💻 🚧
adelkah
adelkah

💻 🚧
Radek Holý
Radek Holý

💻
Vratislav Kalenda
Vratislav Kalenda

💻 🤔
Petr Vnenk
Petr Vnenk

💻

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

You can’t perform that action at this time.