Skip to content

Pre-commit hook prevents workshops with common words #960

@oliverjam

Description

@oliverjam

This is probably my fault since I suggested adding a markdown linter in #467, but the Alex setup appears to be a bit too strict. I assume no one has tried to commit new workshops in a while, because the pre-commit hook blocks commits for "warnings" in content like:

Be careful with `reject`, it’s profane in some cases
Be careful with `crash`, it’s profane in some cases
Be careful with `execute`, it’s profane in some cases
`invalid` may be insensitive
`just` may be insensitive, try not to use it

It's pretty hard to talk about code without these words 😅. I ran Alex on the whole workshop folder and nearly every file would technically be failing now.

I can bypass the hook for the workshop I'm currently writing but it might be a good idea for someone to look into maybe making warnings not a failure?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions