swiftlang / swiftlang/github-workflows

Add soundness check for validating .editorconfig compliance

Open
#189 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Swift
Stars
115
Forks
57
Avg merge
1d 8h
Merged PRs (30d)
3

Description

https://editorconfig-checker.github.io

In Swift Build we have a check to verify there are no files without a trailing newline or files with trailing whitespaces. It would be great to generalize this to an .editorconfig verifier -- we could add a soundness check that uses the python editorconfig-checker package installed via pip to achieve this.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Swift Build soundness check for missing trailing newlines and trailing whitespace, then read the editorconfig-checker documentation and its Python package. Add a generalized .editorconfig compliance check using the package, with completion indicated by validation of repository files against the configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, swift
Domain
build-system, ci-cd
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.