(#) Use inclusive naming !!! ERROR: Use inclusive naming This is an error. Id : `InclusiveNaming` Summary : Use inclusive naming Severity : Error Category : Correctness Platform : Android Vendor : slack Identifier : slack-lint Contact : https://github.com/slackhq/slack-lints Feedback : https://github.com/slackhq/slack-lints Min : Lint 8.7+ Compiled : Lint 8.7+ Artifact : [com.slack.lint:slack-lint-checks](com_slack_lint_slack-lint-checks.md.html) Since : 0.1.0 Affects : Resource files Editing : This check runs on the fly in the IDE editor Implementation : [Source Code](https://github.com/slackhq/slack-lints/tree/main/slack-lint-checks/src/main/java/slack/lint/inclusive/InclusiveNamingResourceScanner.kt) Copyright Year : 2021 We try to use inclusive naming at Slack. Terms such as blacklist, whitelist, master, slave, etc, while maybe widely used today, can be socially charged and make others feel excluded or uncomfortable. (##) Options You can configure this lint checks using the following options: (###) block-list A comma-separated list of words that should not be used in source code.. This property should define a comma-separated list of words that should not be used in source code. Example `lint.xml`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers <lint> <issue id="InclusiveNaming"> <option name="block-list" value="some string" /> </issue> </lint> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ (##) Conflicts This issue id has also been used by other, unrelated lint checks. Issue id's must be unique, so you cannot combine these libraries. Also defined in: * InclusiveNaming: Use inclusive naming (this issue) * [InclusiveNaming from com.slack.lint:slack-lint-checks:0.9.0](InclusiveNaming.md.html) * [InclusiveNaming from com.slack.lint:slack-lint-checks:0.9.0](InclusiveNaming.md.html) (##) Including !!! This is not a built-in check. To include it, add the below dependency to your project. This lint check is included in the lint documentation, but the Android team may or may not agree with its recommendations. ``` // build.gradle.kts lintChecks("com.slack.lint:slack-lint-checks:0.9.0") // build.gradle lintChecks 'com.slack.lint:slack-lint-checks:0.9.0' // build.gradle.kts with version catalogs: lintChecks(libs.slack.lint.checks) # libs.versions.toml [versions] slack-lint-checks = "0.9.0" [libraries] # For clarity and text wrapping purposes the following declaration is # shown split up across lines, but in TOML it needs to be on a single # line (see https://github.com/toml-lang/toml/issues/516) so adjust # when pasting into libs.versions.toml: slack-lint-checks = { module = "com.slack.lint:slack-lint-checks", version.ref = "slack-lint-checks" } ``` 0.9.0 is the version this documentation was generated from; there may be newer versions available. [Additional details about com.slack.lint:slack-lint-checks](com_slack_lint_slack-lint-checks.md.html). (##) Suppressing You can suppress false positives using one of the following mechanisms: * Adding the suppression attribute `tools:ignore="InclusiveNaming"` on the problematic XML element (or one of its enclosing elements). You may also need to add the following namespace declaration on the root element in the XML file if it's not already there: `xmlns:tools="http://schemas.android.com/tools"`. * Using a special `lint.xml` file in the source tree which turns off the check in that folder and any sub folder. A simple file might look like this: ```xml <?xml version="1.0" encoding="UTF-8"?> <lint> <issue id="InclusiveNaming" severity="ignore" /> </lint> ``` Instead of `ignore` you can also change the severity here, for example from `error` to `warning`. You can find additional documentation on how to filter issues by path, regular expression and so on [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html). * In Gradle projects, using the DSL syntax to configure lint. For example, you can use something like ```gradle lintOptions { disable 'InclusiveNaming' } ``` In Android projects this should be nested inside an `android { }` block. * For manual invocations of `lint`, using the `--ignore` flag: ``` $ lint --ignore InclusiveNaming ...` ``` * Last, but not least, using baselines, as discussed [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).