Skip to content

Add a spell checker to our lint task #1127

Description

@stephenplusplus

Cont'd from #1126 (comment)

We have words written all over the place that might not be correct grammatically.

@callmehiphop found a tool called write-good which we could add to our link task to catch such non-good writings. We would likely need a spell-checker as well, because it doesn't seem to do that.

We'd have to be precise in steering it only towards words and away from code. Sometimes they are mixed, such as our @examples. @callmehiphop, is there a good way to filter out only the text?

Activity

  1. callmehiphop commented on Feb 11, 2016

    @callmehiphop
    Contributor

    We could generate the JSON and run spellcheck/write-good on the description properties throughout? I think the trickier part will be parsing markdown and skipping code snippets and possibly markdown syntax.

  2. stephenplusplus commented on Feb 11, 2016

    @stephenplusplus
    ContributorAuthor
  3. callmehiphop commented on Feb 11, 2016

    @callmehiphop
    Contributor

    Nice!

  4. stephenplusplus commented on Mar 9, 2016

    @stephenplusplus
    ContributorAuthor

    I started to work on this and it seemed to be destined for failure from the start. I think the problem is we're trying to spell check tech sentences.

    I started by plugging in write-good. It's is a great tool, but in practicality, it might be more detailed than we need. So I scaled back the scope and just went for spell checking. I realized quickly that meant we'd need to have an extensive custom dictionary to define things like "SDK", "gcloud", "getFiles", etc.

    At this point, I'm not sure we'll be able to automate this. We might be better off just letting the users catch and contribute any grammar bugs we let seep through.

  5. callmehiphop commented on Mar 9, 2016

    @callmehiphop
    Contributor

    That sounds good to me

  6. stephenplusplus commented on Mar 9, 2016

    @stephenplusplus
    ContributorAuthor

    👍

  7. jgeewax commented on Mar 14, 2016

    @jgeewax
    Contributor
  8. stephenplusplus commented on Mar 14, 2016

    @stephenplusplus
    ContributorAuthor

    I think I found a way that's not too gross!: #1166

  9. added a commit that references this issue on Jul 23, 2025
  10. added 2 commits that reference this issue on Mar 5, 2026
    435bbee
    e8ab57f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions