CodeEditApp / CodeEditApp/CodeEdit

🧰 SwiftLint: Global Parent Config for all Repositories

未关闭
#1,204 4 条评论 2 个 reaction 已指派 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 摘要。