@dhis2/cli-style/README.md

The code and commit style for DHIS2.

# cli-style

> This package is part of the [@dhis2/cli](https://github.com/dhis2/cli)
> commandline interface.

[![dhis2-cli Compatible](https://img.shields.io/badge/dhis2-cli-ff69b4.svg)](https://github.com/dhis2/cli)
[![@dhis2/cli-style on npm](https://img.shields.io/npm/v/@dhis2/cli-style.svg)](https://www.npmjs.com/package/@dhis2/cli-style)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

Docs are available at [cli-style.dhis2.nu](https://cli-style.dhis2.nu).

## Batteries included

This tool is part of the [dhis2/cli](https://github.com/dhis2/cli)
suite, but can also be used standalone which is useful for project level
integration.

As a terminal user check out the full CLI. :rocket:

This tool includes the following tools as runtime dependencies, so they
are not necessary to explicitly install:

-   [Commitlint](https://commitlint.js.org)
-   [ESLint](https://eslint.org/)
-   [Prettier](https://prettier.io)
-   [Husky](https://github.com/typicode/husky)
-   [ls-lint](https://ls-lint.org/)

## Usage

```
yarn d2-style --help

yarn d2-style install --help

yarn d2-style check --help
yarn d2-style check js --help

yarn d2-style apply --help
yarn d2-style apply text --help
```

## Report an issue

The issue tracker can be found in [DHIS2 JIRA](https://jira.dhis2.org)
under the [CLI](https://jira.dhis2.org/projects/CLI) project.

Deep links:

-   [Bug](https://jira.dhis2.org/secure/CreateIssueDetails!init.jspa?pid=10703&issuetype=10006&components=11020)
-   [Feature](https://jira.dhis2.org/secure/CreateIssueDetails!init.jspa?pid=10703&issuetype=10300&components=11020)
-   [Task](https://jira.dhis2.org/secure/CreateIssueDetails!init.jspa?pid=10703&issuetype=10003&components=11020)