realm / realm/SwiftLint

Extended matching for `inclusive_language` rule and possible `disallowed_terminology` rule

Open
#3,838 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

rule-request
Dominant language
Swift
Stars
19.7k
Forks
2.3k
Avg merge
1d 1h
Merged PRs (30d)
11

Description

New Issue Checklist
Description

I wasn't sure whether it would be more appropriate to add a comment to #3243 or to make a new issue since it's slightly unrelated, but:

Has there been any discussion about adding checks for comments, strings, etc. for the inclusive_language rule, or has there been any more discussion about adding a more general rule for disallowed terminology (like the one suggested in #3243) that would exist alongside the inclusive_language rule?

I have a list of more general terms that I'd like to look for throughout the code. The functionality that the inclusive_language rule has is exactly what I want, but it appears that it only checks identifiers, and the use-case is specialized. Even if I wanted to only match identifiers and added to the additional_terms array in the inclusive_language rule, some of the words that could be disallowed aren't related to inclusivity and might lead to confusion about what the error is actually about.

Thanks!

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 inclusive_language rule and the related discussion in #3243. Clarify whether matching should include comments and strings, and whether general disallowed terminology belongs in a separate rule; the work is done when the scope and expected diagnostics are agreed and implemented.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.