kantord/SeaGOAT

Set up automated line length formatting for YAML files

Open

#275 opened on Sep 29, 2023

View on GitHubContributor guide
 (2 comments) (0 reactions) (1 assignee)Python (91 forks)github user discovery
good first issuehacktoberfestup for grabs

Repository metrics

Stars
 (1,302 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We have rules that limit line width for YAML files, which is good, but it is annoying because it is not an autofixable error. This can be implemented on an individual basis by configuring code editors to do it, but it's much better if it's done automatically the same way all the other autoformatting/linting is done.

Here is our configuration for pre-commit: https://github.com/kantord/SeaGOAT/blob/main/.pre-commit-config.yaml, which would be the tool we need to use to implement this autoformatting.

Here is the website of pre-commit: https://pre-commit.com/

A hook should already exists for this, but if not, it can probably be manually added as pre-commit should be able to run arbitrary commands.

Contributor guide

Research direction
Look for existing pre commit hooks for YAML line length formatting (e.g., yamllint with autofix or a custom script) and add the hook to .pre commit config.yaml. If not found, create a custom script that wraps yamllint or similar and registers it as a hook.
Tech stack
None
Domain
developer experiencebuild system
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
Gitpre commit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85