https://github.com/kontent-ai/dprint-config
Dprint configuration shared for Kontent.ai repositories
https://github.com/kontent-ai/dprint-config
dprint kontent-ai
Last synced: 4 months ago
JSON representation
Dprint configuration shared for Kontent.ai repositories
- Host: GitHub
- URL: https://github.com/kontent-ai/dprint-config
- Owner: kontent-ai
- License: mit
- Created: 2023-05-19T13:17:41.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-25T16:41:05.000Z (about 1 year ago)
- Last Synced: 2025-01-12T00:25:41.160Z (5 months ago)
- Topics: dprint, kontent-ai
- Homepage: https://kontent.ai
- Size: 17.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
This repository provides a shared [dprint](dprint.dev) configuration for Kontent.ai repositories.
# How to use?
1) [Install dprint](https://dprint.dev/install/)
2) Create `dprint.json` file (usually in the root of your repository)
3) [Extend the `dprint.json` file](https://dprint.dev/config/#extending-a-different-configuration-file) from this repository. Add this property to your json to do that. `"extends": "https://raw.githubusercontent.com/kontent-ai/dprint-config/main/dprint.json"`
4) [Add `includes` and/or `excludes` properties](https://dprint.dev/config/#includes-and-excludes) to your `dprint.json` as needed, because the shared config cannot provide that.
5) Install dprint extension into your favourite IDE. https://dprint.dev/install/#editor-extensions
# How to check the formatting on CI with dprint?
There is a CLI command to do just that `dprint check`, but your can leverage [prepared scripts](https://dprint.dev/ci/) for GitHub Action or GitLab to do that for you.