textlint-rule-azure-service-name

The rule of Textlint for checking the name of Azure service.

This rule uses Jaro–Winkler distance. So this rule can detect multiple types of typo. But on the other hands, this rule may detect unrelated words as false-positive.

Install

Install with npm:

npm install textlint-rule-azure-service-name

Usage

Via .textlintrc.json(Recommended)

{
    "rules": {
      "textlint-rule-azure-service-name": {
        "severity": "warning",
        "strictWithAzure": false,
        "strictWithMicrosotft": false
      }
    }
}

Via CLI

textlint --rule azure-service-name README.md

Limitation

This rule ignores the sentence contains the following words.

• Blockquotes(> )
• Link([]())
• highlighting code blocks(```)

Options

ignorePattern

If you ignore some results of this rule, you need to add ignorePattern. The format of ignorePattern is <keyward you want to ignore>:<Azure Service Name this rule detects>. You can confirm these parameters in the error message.

{
  "rules": {
    "textlint-rule-azure-service-name": {
      "ignorePattern": [
        "Network Manager:Network Watcher",
        "Azure Virtual Network:Azure Active Directory",
        "Microsoft Defender for cloud:Microsoft Defender for Cloud"
      ]
    }
  }
}

strict mode

By default, this rule doesn't check whether a service name contains "Azure" or "Microsoft". So this rule detects "ExpressRoute" is OK although the correct service name is "Azure ExpressRoute". If you want to check an error of this type, you can use strictWithAzure and strictWithMicrosoft. When you set "strictWithAzure" as "true", this rule detects "ExpressRoute" is NG.

{
  "rules": {
    "textlint-rule-azure-service-name": {
      "strictWithAzure": true,
      "strictWithMicrosotft": true
    }
  }
}

Build

Builds source codes for publish to the lib folder. You can write ES2015+ source codes in src/ folder.

npm run build

Tests

Run test code in test folder. Test textlint rule by textlint-tester.

npm test

License

MIT © kongou-ae