Skip to content

Commit

Permalink
Update Textlint rules
Browse files Browse the repository at this point in the history
  • Loading branch information
sapegin committed Jun 21, 2024
1 parent 0bb0c2c commit 9179b85
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion manuscript/070_Naming_is_hard.md
Original file line number Diff line number Diff line change
Expand Up @@ -1505,7 +1505,7 @@ One thing that developers often disagree on is how to spell acronyms (for exampl
- Do something weird: `XMLHttpRequest`, `DatePickerIOS`, `HTMLHRElement`;
- Normalize the words: `WebIos`, `HtmlHrElement`.
Unfortunately, the most readable approach, normalization, seems to be the least popular. Since we can’t use spaces in names, it can be hard to separate words: `WebiOS` could be read as webi os instead of web ios, and it takes extra time to read it right. Such names also don’t work well with code spell checkers: they mark webi and htmlhr as incorrect words.
Unfortunately, the most readable approach, normalization, seems to be the least popular. Since we can’t use spaces in names, it can be hard to separate words: `WebiOS` could be read as `webi os` instead of `web ios`, and it takes extra time to read it right. Such names also don’t work well with code spell checkers: they mark `webi` and `htmlhr` as incorrect words.
<!-- cspell:enable -->
Expand Down
2 changes: 1 addition & 1 deletion manuscript/120_Linting.md
Original file line number Diff line number Diff line change
Expand Up @@ -673,7 +673,7 @@ export default tseslint.config({

Here, we allow only [@ts-expect-error](https://typescript-eslint.io/rules/prefer-ts-expect-error/) comments and require an explanation for each of them.

Then we can write something like this, and it won’t trigger a lint error:
Then we can write something like this, and it won’t trigger a linting error:

<!-- let makePizza = () => {}, dough, sauce, salami -->

Expand Down
2 changes: 1 addition & 1 deletion manuscript/150_Editing.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ The **fuzzy file opener** is one of my favorite tools. I use it all the time to

![Fuzzy file opener in Visual Studio Code](images/fuzzy-file-opener.png)

TODO: search (regexps?)
TODO: search (regular expressions?)

{#spell-checking}

Expand Down
14 changes: 7 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
"textlint-rule-no-todo": "^2.0.1",
"textlint-rule-quotes": "^1.0.0",
"textlint-rule-stop-words": "^5.0.7",
"textlint-rule-terminology": "^5.0.13",
"textlint-rule-terminology": "^5.0.15",
"textlint-rule-write-good": "^2.0.0",
"unist-util-visit": "^5.0.0",
"vitest": "^1.6.0",
Expand Down

0 comments on commit 9179b85

Please # to comment.