Configuration of cargo-spellcheck #832

TomaszWaszczyk · 2021-03-17T21:28:53Z

My second try to configure the tool ;-)

HCastano · 2021-03-18T15:07:56Z

.config/lingua.dic

@@ -0,0 +1,88 @@
+90


Just curious, where'd you get this list from?

Also, what's with the /<letter> at the end of certain words?

It is kinda...it is called Hunspell and by that letters it is allowed to specify kind of dictionary like "en_US". Paste from the documentation:

If the .dic files contains incorrect rules for a word, then add the word with the correct rules to .dic_delta. For example, if en_US.dic contains the entry raccoon/M, but the rule should be /MS, then add raccoon/MS to en_US.dic_delta. Rules for entries in .dic_delta override the rules for entries in .dic.

Source: https://www.chromium.org/developers/how-tos/editing-the-spell-checking-dictionaries

What is the source of the list? Well, long story short, around 2 months ago I was thinking that the task will take me ~1h and started to do it, but it was not so simple and was needed to leave it, but I to follow and look at Parity's repositories and I found that PR: https://github.com/paritytech/polkadot/pull/1841/files and my dream is to do at least one merge/ed PR and when I saw the PR I immediately made my PR.

That is it, that's the story.

It is kinda...it is called Hunspell and by that letters it is allowed to specify kind of dictionary like "en_US". Paste from the documentation:

If the .dic files contains incorrect rules for a word, then add the word with the correct rules to .dic_delta. For example, if en_US.dic contains the entry raccoon/M, but the rule should be /MS, then add raccoon/MS to en_US.dic_delta. Rules for entries in .dic_delta override the rules for entries in .dic.

Source: https://www.chromium.org/developers/how-tos/editing-the-spell-checking-dictionaries

I still don't fully get it, but good to know there's a source for the strangeness 😅

What is the source of the list? Well, long story short, around 2 months ago I was thinking that the task will take me ~1h and started to do it, but it was not so simple and was needed to leave it, but I to follow and look at Parity's repositories and I found that PR: https://github.com/paritytech/polkadot/pull/1841/files and my dream is to do at least one merge/ed PR and when I saw the PR I immediately made my PR.

That is it, that's the story.

Haha, sounds good! Keep in mind that you will need to add some "bridge" specific words in there though (e.g our test networks Rialto and Millau). I'm not sure what other false positives you'll get, but I imagine there'll be a few.

spellcheck.mp4

@HCastano I wanted to check output from the commands like in recording but I got empty output, I have missed something all it works like supposed to work?

HCastano · 2021-04-07T17:56:20Z

@TomaszWaszczyk Hey, any updates here?

TomaszWaszczyk · 2021-04-07T18:11:17Z

I have added specific to the bridge words, within 36h will check if occurs some false positives and if needed commit. Is it a good direction?

tomusdrw · 2021-04-13T11:49:06Z

Looks good to me, can you add a job on CI to make sure it's being checked?

TomaszWaszczyk · 2021-04-13T11:51:36Z

Sure, will do that within coming days.

.github/workflows/lint.yml

Co-authored-by: Tomasz Drwięga <tomusdrw@users.noreply.github.com>

TomaszWaszczyk · 2021-04-15T12:20:52Z

I have changed a way how to install cargo-spellcheck on CI because via rustup component add cargo-spellcheck it was not working.

In case of any hints how can I improve the PR let me know, please ;-)

PS. Feel free to suggest me next issue that you know will learn me more about the project.

tomusdrw

Nice! I'm kind of suspicious that it didn't fail on anything - does it mean that our entire documentation is typo-free? I find it quite hard to believe, but 🤷 🎉.

PS. Feel free to suggest me next issue that you know will learn me more about the project.

I've recently created a separate milestone for small improvements like that, feel free to take a look.

HCastano

I'm pretty suspicious of the fact that we got no typos or anything of the sort.

It doesn't look like we've installed an en_US dictionary on the build machine. I figured hunspell would come with a default, but maybe I'm mistaken.

@drahnr Can you confirm if we need to install an external dictionary?

.github/workflows/lint.yml

Co-authored-by: Hernando Castano <HCastano@users.noreply.github.com>

.github/workflows/lint.yml

drahnr · 2021-04-16T05:50:12Z

I'm pretty suspicious of the fact that we got no typos or anything of the sort.

Depends on your configuration and the quality of your list, I'll take a peek into this at some point today :)

It doesn't look like we've installed an en_US dictionary on the build machine. I figured hunspell would come with a default, but maybe I'm mistaken.

This should yield an error for sure if there is no dictionary found.

@drahnr Can you confirm if we need to install an external dictionary?

Currently you need an external dictionary. This is going to change with the next release (v0.8.0 which also fixes a few other kinks) and the fedora local en_US.aff and en_US.dic will be used by default and can be overridden iff a local dictionary is found.

drahnr · 2021-04-16T06:22:31Z

It's very unlikely that cargo-spellcheck is happy on the first shot 😁

drahnr · 2021-04-16T07:52:29Z

This is a bug in cargo-spellcheck, it does not handle glob patterns in workspaces just yet drahnr/cargo-spellcheck#166 which I just fixed with v0.8.0-beta.2. It's on crates-io now :)

drahnr · 2021-04-16T10:43:39Z

Builtin dictionary and affix files are on their way: drahnr/cargo-spellcheck#168 should be ready at some point later today with v0.8.0-beta.3.

Edit: released

drahnr · 2021-04-16T11:11:41Z

.github/workflows/lint.yml

+        uses:           actions-rs/cargo@master
+        with:
+          command:      spellcheck
+          args:         check  -m 1


consider adding -vv to have some additional output in CI

I have looked at the docs and there is written:

To increase verbosity add -v (multiple) to increase verbosity.

That is why I added -v, correct me please if I am wrong with that one -v

-q nothing
- error
-v warn
-vv info
-vvv debug
and any more than that will probably kill the output buffer

Thanks! Oh, my goodness! There is around 400 places to improve:

But as I said A I will say Z, will deliver it, take few days but will deliver.

…ase verbosity.

drahnr · 2021-04-19T12:37:48Z

Had a brief peek into the results and they look good to me. There are a bunch of -> and <-> in the comments and the new tokenizer seems to happily chop around before > and < characters and then mark < as issues. This can be resolved by adding a single character quirk to hunspell.

…ease verbosity. - enable debug mode

This reverts commit c2d56b2.

HCastano · 2021-04-27T19:56:00Z

Closing this in favour of #924.

Tomasz Waszczyk added 2 commits March 17, 2021 22:09

feat: added initial configuration of cargo-spellcheck

3078ccd

feat: added initial configuration of cargo-spellcheck

93fea8c

HCastano added the A-feat New feature or request label Mar 18, 2021

HCastano changed the title ~~feat: (config): Proposal to configuration of cargo-spellcheck~~ Configuration of cargo-spellcheck Mar 18, 2021

HCastano reviewed Mar 18, 2021

View reviewed changes

feat: added specific words for a bridge

8f65bf9

feat(configuration): added cargo-spellcheck to CI as a new job

1596638

tomusdrw reviewed Apr 15, 2021

View reviewed changes

.github/workflows/lint.yml Outdated Show resolved Hide resolved

Tomasz Waszczyk and others added 3 commits April 15, 2021 13:23

Update .github/workflows/lint.yml

56d7187

Co-authored-by: Tomasz Drwięga <tomusdrw@users.noreply.github.com>

feat(config): change a way to install cargo-spellcheck on CI

57419c2

feat(configuration): better naming for the job: "Run spellcheck"

486a96f

TomaszWaszczyk marked this pull request as ready for review April 15, 2021 12:20

tomusdrw approved these changes Apr 15, 2021

View reviewed changes

HCastano reviewed Apr 15, 2021

View reviewed changes

.github/workflows/lint.yml Outdated Show resolved Hide resolved

Update .github/workflows/lint.yml

53cc84b

Co-authored-by: Hernando Castano <HCastano@users.noreply.github.com>

drahnr reviewed Apr 16, 2021

View reviewed changes

.github/workflows/lint.yml Outdated Show resolved Hide resolved

drahnr reviewed Apr 16, 2021

View reviewed changes

drahnr mentioned this pull request Apr 18, 2021

panic in Regex::regex() bminixhofer/nlprule#68

Closed

feat(config): added: to increase verbosity add -v (multiple) to incre…

2148246

…ase verbosity.

feat(config): added: to increase verbosity add -vv (multiple) to incr…

1e3947a

…ease verbosity. - enable debug mode

TomaszWaszczyk added 7 commits April 19, 2021 17:56

feat(config): first batch of real changes

2c9748e

feat(config): second batch of real changes

13e6331

feat(config): try to solve single hunspell quirk

91d06eb

Merge branch 'master' of github.com:paritytech/parity-bridges-common

d839709

feat(sparta): this is sparta

6d4f949

Merge remote-tracking branch 'upstream/master'

ac41edd

Revert "Add pruning to bechmarks & update weights. (#918)"

992d00b

This reverts commit c2d56b2.

HCastano mentioned this pull request Apr 27, 2021

Add backbone configuration of cargo-spellcheck #924

Merged

HCastano closed this Apr 27, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Configuration of cargo-spellcheck #832

Configuration of cargo-spellcheck #832

TomaszWaszczyk commented Mar 17, 2021

HCastano Mar 18, 2021

TomaszWaszczyk Mar 18, 2021

HCastano Mar 19, 2021

TomaszWaszczyk Apr 7, 2021

HCastano commented Apr 7, 2021

TomaszWaszczyk commented Apr 7, 2021

tomusdrw commented Apr 13, 2021

TomaszWaszczyk commented Apr 13, 2021

TomaszWaszczyk commented Apr 15, 2021

tomusdrw left a comment

HCastano left a comment

drahnr commented Apr 16, 2021

drahnr commented Apr 16, 2021

drahnr commented Apr 16, 2021 •

edited

drahnr commented Apr 16, 2021 •

edited

drahnr Apr 16, 2021

TomaszWaszczyk Apr 19, 2021

drahnr Apr 19, 2021 •

edited

TomaszWaszczyk Apr 19, 2021

drahnr commented Apr 19, 2021

HCastano commented Apr 27, 2021

Configuration of cargo-spellcheck #832

Configuration of cargo-spellcheck #832

Conversation

TomaszWaszczyk commented Mar 17, 2021

HCastano Mar 18, 2021

Choose a reason for hiding this comment

TomaszWaszczyk Mar 18, 2021

Choose a reason for hiding this comment

HCastano Mar 19, 2021

Choose a reason for hiding this comment

TomaszWaszczyk Apr 7, 2021

Choose a reason for hiding this comment

HCastano commented Apr 7, 2021

TomaszWaszczyk commented Apr 7, 2021

tomusdrw commented Apr 13, 2021

TomaszWaszczyk commented Apr 13, 2021

TomaszWaszczyk commented Apr 15, 2021

tomusdrw left a comment

Choose a reason for hiding this comment

HCastano left a comment

Choose a reason for hiding this comment

drahnr commented Apr 16, 2021

drahnr commented Apr 16, 2021

drahnr commented Apr 16, 2021 • edited

drahnr commented Apr 16, 2021 • edited

drahnr Apr 16, 2021

Choose a reason for hiding this comment

TomaszWaszczyk Apr 19, 2021

Choose a reason for hiding this comment

drahnr Apr 19, 2021 • edited

Choose a reason for hiding this comment

TomaszWaszczyk Apr 19, 2021

Choose a reason for hiding this comment

drahnr commented Apr 19, 2021

HCastano commented Apr 27, 2021

drahnr commented Apr 16, 2021 •

edited

drahnr commented Apr 16, 2021 •

edited

drahnr Apr 19, 2021 •

edited