Add linting for insensitive and inconsiderate language #1337
Conversation
|
Deploy preview for react-native ready! Built with commit 1cda08e https://deploy-preview-1337--react-native.netlify.com Changes to Thank you for your contributions. |
|
Merge blocked on rickhanlonii#1, but feel free to review and approve this one first |
| "invalid", | ||
|
|
||
| // Unfortunately "watchman" is a library name that we depend on. | ||
| "watchman-watchwoman" |
There was a problem hiding this comment.
There are just two rules that we're opting out of
| ]; | ||
|
|
||
| // Use a "maybe" level of profanity instead of the default "unlikely". | ||
| exports.profanitySureness = 1; |
There was a problem hiding this comment.
When this is set to 0 it is too eager, it catches words like "color", "execute", and "fire" which in our context are super unlikely to be profane and highly likely to be valid
There was a problem hiding this comment.
Should you put your reasoning as a comment in the code?
|
Shout out @wooorm for the help and alexjs ✨ |
|
Wow, lots of warnings on the lint job! I'm glad we are cleaning this up. Thanks for setting this up. It would be great if you could also hook this up to also comment back on the PR at the line. We have a bot set up to do that on the main RN repo for eslint issues. |
rickhanlonii
changed the title
Fix lint issues in /docs
|
Update: I merged in the changes from rickhanlonii#1 and added a new |
This was added to React Native recently and I thought it was a good idea! facebook/react-native-website#1337 More information: https://alexjs.com/ I think the one piece of our API we could consider changing would be "disabled", but I have deferred that for now. This feels like a pretty harmless linter and is easy to configure as well, may be worth a shot giving it a try! Test plan: I ran `yarn alex` and it passed!
This was added to React Native recently and I thought it was a good idea! facebook/react-native-website#1337 More information: https://alexjs.com/ I think the one piece of our API we could consider changing would be "disabled", but I have deferred that for now. This feels like a pretty harmless linter and is easy to configure as well, may be worth a shot giving it a try! Test plan: I ran `yarn alex` and it passed!
|
I love the removal of "just" and "simply", but I don't think "easy" -> "quick" or "simple" -> "basic" is an improvement 😬 |
|
@pvinis I hear you. The way I think about it, "simple" seems to be a characteristic of knowledge while "basic" is a characteristic of form. Something can be "basic" (is made of few parts) but not "simple" (easily understood). By focusing on the form instead of the knowledge characteristic then the docs are more inclusive If you feel strongly I would recommend reaching out to the retext repo and getting it added there and we would address it in the repo here ✨ |
Summary: **Summary** This PR, similarly to facebook/react-native-website#1337, adds [alexjs](https://alexjs.com/) linting to Draft.js in order to identify and prevent insensitive and inconsiderate language from landing on master. - Adds Alex - Configures Alex rules - **TODO:** Run Alex in Travis CI **Test Plan** - Run `yarn lint-docs` - Verify there are no lint violations Pull Request resolved: #2223 Differential Revision: D18046996 Pulled By: claudiopro fbshipit-source-id: 66ac935720a0b13576e9a133a3d5f8e98cc539cf
* Add linting for insensitive and inconsiderate language * Add .alexrc.js * Update alex rules * Minor updates to formatting * Fix deploy_website job name * Update alex rules * Add lintv and .alexignore * Fix lint issues
…ve#2223) Summary: **Summary** This PR, similarly to facebook/react-native-website#1337, adds [alexjs](https://alexjs.com/) linting to Draft.js in order to identify and prevent insensitive and inconsiderate language from landing on master. - Adds Alex - Configures Alex rules - **TODO:** Run Alex in Travis CI **Test Plan** - Run `yarn lint-docs` - Verify there are no lint violations Pull Request resolved: facebookarchive#2223 Differential Revision: D18046996 Pulled By: claudiopro fbshipit-source-id: 66ac935720a0b13576e9a133a3d5f8e98cc539cf
…ve#2223) Summary: **Summary** This PR, similarly to facebook/react-native-website#1337, adds [alexjs](https://alexjs.com/) linting to Draft.js in order to identify and prevent insensitive and inconsiderate language from landing on master. - Adds Alex - Configures Alex rules - **TODO:** Run Alex in Travis CI **Test Plan** - Run `yarn lint-docs` - Verify there are no lint violations Pull Request resolved: facebookarchive#2223 Differential Revision: D18046996 Pulled By: claudiopro fbshipit-source-id: 66ac935720a0b13576e9a133a3d5f8e98cc539cf
Summary: **Summary** This PR, similarly to facebook/react-native-website#1337, adds [alexjs](https://alexjs.com/) linting to Draft.js in order to identify and prevent insensitive and inconsiderate language from landing on master. - Adds Alex - Configures Alex rules - **TODO:** Run Alex in Travis CI **Test Plan** - Run `yarn lint-docs` - Verify there are no lint violations Pull Request resolved: facebookarchive/draft-js#2223 Differential Revision: D18046996 Pulled By: claudiopro fbshipit-source-id: 66ac935720a0b13576e9a133a3d5f8e98cc539cf
5 participants
Overview
This PR number 1337, adds alexjs linting to the
/docsfolder to prevent insensitive and inconsiderate language from landing on master.Blocker
This PR fixes 193 lint issues that exist in the current docs. Once that PR is merged into this one, we can merge this PR into master.
PRs are separated to make reviewing this one easier.
What about versioned docs
Right now we're only linting the master docs in the
/docsfolder. Older docs in thewebsite/versioned_docsdirectory are not linted.Once we fix those docs, we can enable linting everywhere.