npm

Need private packages and team management tools?Check out npm Orgs. »

dx-scanner

1.7.0 • Public • Published

Version Travis (.org) Codecov last commit GitHub commit activity Downloads/week GitHub contributors All Contributors License: CC BY-NC-SA 4.0 oclif TypeScript Twitter Follow

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.

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 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 Attribution-NonCommercial-ShareAlike 4.0 International License.

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!

install

npm i dx-scanner

Downloadsweekly downloads

63

version

1.7.0

license

CC-BY-NC-SA-4.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability