feature: add misspell tool to check English words #1304
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
Author
|
In this test, we have already found: So it turns out that misspell works very well. |
Codecov Report
@@ Coverage Diff @@
## master #1304 +/- ##
==========================================
+ Coverage 16.42% 16.45% +0.02%
==========================================
Files 182 182
Lines 11303 11285 -18
==========================================
Hits 1857 1857
+ Misses 9310 9292 -18
Partials 136 136
|
zhuangqh
reviewed
May 11, 2018
.circleci/config.yml
Outdated
| find ./ -name "*.md" | grep -v vendor | grep -v extra | grep -v commandline | grep -v .github | grep -v swagger | grep -v api | xargs mdl -r ~MD010,~MD013,~MD024,~MD029,~MD033,~MD036 | ||
| - run: | ||
| name: use opensource tool client9/misspell to correct commonly misspelled English words | ||
| command: find ./ -name "*" | grep -v extra | grep -v vendor |
Contributor
There was a problem hiding this comment.
@allencloud Forgot to execute misspell? xargs misspell -error
Collaborator
Author
There was a problem hiding this comment.
Ah, Thanks goodness. I am afraid I made a mistake in git commit.
allencloud
force-pushed
the
add-misspell
branch
2 times, most recently
from
27ea329 to
87a2671
Compare
Signed-off-by: Allen Sun <[email protected]>
Collaborator
Author
|
LGTM |
pouchrobot
added
the
LGTM
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Allen Sun [email protected]
Ⅰ. Describe what this PR did
I add tool misspell to check incorrect English words spelling in this project.
I combined this feature in CI with test type of markdownlint.
In addition I use a new Dockerfile to construct new image
allencloud/mdlmisspell:v0.1:Ⅱ. Does this pull request fix one issue?
none
Ⅲ. Describe how you did it
Ⅳ. Describe how to verify it
This addition would checkout one typo.
Ⅴ. Special notes for reviews
none