detekt/detekt

Create our own config self-hosted schema

Open

#4,162 opened on Oct 4, 2021

View on GitHub
 (9 comments) (2 reactions) (0 assignees)Kotlin (834 forks)batch import
featurehelp wanted

Repository metrics

Stars
 (6,942 stars)
PR merge metrics
 (Avg merge 4d 9h) (65 merged PRs in 30d)

Description

We should auto generate and publish our own JSON schema to help our users write their detekt configuration file. Here there are some documentation: https://github.com/SchemaStore/schemastore/blob/master/CONTRIBUTING.md#self-hosting-schemas

#4155 for more context

Contributor guide

Research direction
Read SchemaStore's self hosting guide and detekt's config format. Create a JSON schema file and integrate it into the build process to auto generate and publish.
Tech stack
kotlin
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Kotlin
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60