README.md

TypeScript Example

The @typescript-eslint parser and the recommended config's rules will work in ts code blocks. However, type-aware rules will not work because the code blocks are not part of a compilable tsconfig.json project.

function hello(name: String) {
    console.log(`Hello, ${name}!`);
}

hello(42 as any);

$ git clone https://github.com/eslint/eslint-plugin-markdown.git
$ cd eslint-plugin-markdown/examples/typescript
$ npm install
$ npm test

eslint-plugin-markdown/examples/typescript/README.md
   6:22  error    Don’t use `String` as a type. Use string instead  @typescript-eslint/ban-types
  10:13  warning  Unexpected any. Specify a different type          @typescript-eslint/no-explicit-any

✖ 2 problems (1 error, 1 warning)
  1 error and 0 warnings potentially fixable with the `--fix` option.