no-irregular-whitespace enforces strings/comments despite contrary documentation

[cjc343]

Bug Report

• TSLint version: 5.7.0
• TypeScript version: 2.5.2
• Running TSLint via: (pick one) CLI/NPM: tslint -p ./tsconfig.json -c ./tslint.json -e '**/node_modules/**/*'

TypeScript code being linted

Note - the claims in the 'code' below are untrue because GitHub is replacing nbsp chars with standard spaces. To repro, you must supply your own nbsp chars.

// this comment contains nbsp chars
const s = 'this string contains nbsp chars';

with tslint.json configuration:

{
  "rules": {
    "no-irregular-whitespace": true
  }
}

Actual behavior

Lint failures occur on nbsp chars in string literals and comments.

Expected behavior

Per docs: Disallow irregular whitespace outside of strings and comments

---

I'm less bothered by the actual behaviour & more-so by the incorrect documentation - disabling the rule when irregular whitespace belongs in a string literal is a perfectly acceptable solution to me.

[ajafff]

As you already noted: this is a bug in the docs and should be fairly easy to fix.