CodeEditApp / CodeEditApp/CodeEdit

🧰 SwiftLint: Global Parent Config for all Repositories

オープン
#1,204 コメント 4 件 リアクション 2 件 担当者 1 名 @lukepistrol が担当を希望しています GitHub で見る
chore
主要言語
Swift
スター
23k
フォーク
1.2k
PR マージ指標
30日以内にマージされた PR はありません

説明

As discussed in our [Discord](https://discord.com/channels/951544472238444645/987416899816149024/1088930464171053138) we might use a global SwiftLint configuration across all our repos to have the styling guidelines applied everywhere.

This is already possible by SwiftLint itself: [Reference](https://github.com/realm/SwiftLint#child--parent-configs-remote)

## Proposed Solution

My suggestion is to add a new Repository in the organization called something similar to `CodeStyle` (open for suggestions though on the naming).

There we could host the `.swiftlint.yml` file which we can then include in each repo adding

```yaml
parent_config: https://raw.githubusercontent.com/CodeEditApp/{REPO_NAME}/main/.swiftlint.yml
```

This would fetch the config automatically when running SwiftLint. It also caches the latest version for situations where no internet connection is available.

If there are special needs, for example excluding some file paths, on a per repo basis, this could be overridden in the project's `.swiftlint.yml`.

## Attention Needed

When implementing this change it also is important to update the code on each repo to conform to this code style. The `CodeEdit` repo should be fine already since we already implemented the proper rules. The major task will be updating the relatively large codebase of `CodeEditTextView`.

## Future Additions

In the future we could also investigate how to add other configurations to this repo which might be needed on all the different repos.

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。