Shareable configuration for textlint — a tool for linting and fixing text written in natural language.

Install

npm install --dev-save @anolilab/textlint-config textlint

yarn add -D @anolilab/textlint-config textlint

pnpm add -D @anolilab/textlint-config textlint

Usage

If you don’t have a .textlintrc, we will create the file for you after installing @anolilab/textlint-config.

If you already have a .textlintrc, then you can extend the .textlintrc, with @anolilab/textlint-config.

{
    "@textlint/markdown": {
        "extensions": [".md", ".mdx"]
    },
    "filters": {
        "comments": true
    },
    "rules": {
        "en-capitalization": true,
        "footnote-order": true,
        "no-todo": true,
        "no-dead-link": {
            "ignore": ["bc_data_*"]
        },
        "no-empty-section": true,
        "terminology": true,
        "apostrophe": true,
        "diacritics": true,
        "@textlint-rule/no-invalid-control-character": true,
        "@textlint-rule/no-unmatched-pair": true,
        "abbr-within-parentheses": true,
        "alex": {
            "allow": ["period", "european", "failure", "fore", "attack", "execution", "executed", "remain", "execute"]
        },
        "@textlint-rule/preset-google": true,
        "write-good": {
            "passive": false,
            "eprime": false
        },
        "common-misspellings": true,
        "terminology": {
            "defaultTerms": false,
            "terms": [
                // Abbreviations
                "API",
                ["API['’]?s", "APIs"],
                "Ajax",
                "CLI",
                "CSS",
                "CORS",
                ["^E2E", "E2E"],
                "gif",
                ["^HTML", "HTML"],
                ["^URL(s?)", "URL$1"],
                ["^HTTP", "HTTP"],
                ["^HTTPS", "HTTPS"],
                "SSO",
                ["^XHR(s?)", "XHR$1"],
                ["^XHR['’]?s", "XHRs"],
                "Xvfb",
                "YAML",

                // Words and phrases
                ["\\(s\\)he", "they"],
                ["he or she", "they"],
                ["he/she", "they"],
                ["crazy", "complex"],
                ["crazier", "more complex"],
                ["craziest", "most complex"],
                ["dumb", "unintended"],
                ["insane", "outrageous"],

                // Prefer American spelling
                ["behaviour", "behavior"],
                ["cancelled", "canceled"],
                ["cancelling", "canceling"],
                ["centre", "center"],
                ["colour", "color"],
                ["customise", "customize"],
                ["customisation", "customization"],
                ["favourite", "favorite"],
                ["labelled", "labeled"],
                ["licence", "license"],
                ["organise", "organize"],

                // Common misspellings
                ["gaurantee", "guarantee"],

                // Words we would like to not use altogether
                ["simply", ""],

                // Single word
                ["change[- ]log(s?)", "changelog$1"],
                ["code[- ]base(es?)", "codebase$1"],
                ["e[- ]mail(s?)", "email$1"],
                ["end[- ]point(s?)", "endpoint$1"],
                ["file[- ]name(s?)", "filename$1"],
                ["can[- ]not", "cannot$1"],

                // Multiple words
                ["back-?end(s?)", "back end$1"],
                ["front-?end(s?)", "front end$1"],
                ["full-?stack(s?)", "full stack$1"],
                ["open-?source(ed?)", "open source$1"],
                ["web-?page(s?)", "web page$1"],

                // Hyphenated
                ["end ?to ?end", "end-to-end"],
                ["retryability", "retry-ability"],
                ["retriability", "retry-ability"],

                ["some", ""],
                ["filetype", "file type"],
                ["stylesheet", "style sheet"],
                ["like this", ""],
                ["probably", ""],
                ["known as", ""],
                ["really", ""],
                ["just", ""],
                ["simple", ""],
                ["obvious", ""],
                ["straightforward", ""],
                ["very", ""],
                ["a little", ""],
                ["note that", ""],
                ["good to note", ""],
                ["good to remember", ""],
                ["basically", ""],
                ["actually", ""],
                ["pretty", ""],
                ["easy", ""],
                ["interesting", ""],
                ["way to", ""],
                ["In order to", "To"],
                ["in order to", "to"],
                ["might", ""],
                ["us", ""],
                ["I'll", ""],
                ["I've", ""],
                ["they'll", ""],
                ["it is", "it's"],
                ["It is", "It's"]
            ]
        }
    }
}

Supported Node.js Versions

Libraries in this ecosystem make the best effort to track Node.js’ release schedule. Here’s a post on why we think this is important.

Contributing

If you would like to help take a look at the list of issues and check our Contributing guild.

Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Credits

• Daniel Bannert
• All Contributors

License

The anolilab javascript-style-guide is open-sourced software licensed under the MIT license