Skip to content

Commit

Permalink
docs(experimental-utils): fix table links (#545)
Browse files Browse the repository at this point in the history
  • Loading branch information
bradzacher committed May 28, 2019
1 parent bba42eb commit e6b2eff
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions packages/experimental-utils/README.md
Expand Up @@ -14,20 +14,19 @@ Once it is stable, it will be renamed to `@typescript-eslint/util` for a `2.0.0`

## Exports

| Name | Description |
| --------------------------- | ---------------------------------------------------------------------------------------------- |
| [`TSESTree`] | Types for the TypeScript flavour of ESTree created by `@typescript-eslint/typescript-estree`. |
| [`AST_NODE_TYPES`] | An enum with the names of every single _node_ found in `TSESTree`. |
| [`AST_TOKEN_TYPES`] | An enum with the names of every single _token_ found in `TSESTree`. |
| [`TSESLint`] | Types for ESLint, correctly typed to work with the types found in `TSESTree`. |
| [`ESLintUtils`] | Tools for creating eslint rules with TypeScript. |
| [`ESLintUtils.RuleCreator`] | A function for creating strictly typed eslint rules with TypeScript. |
| [`ParserServices`] | The parser services provided when parsing a file using `@typescript-eslint/typescript-estree`. |

[`AST_NODE_TYPES`](../packages/typescript-estree/src/ts-estree/ast-node-types.ts)
[`AST_TOKEN_TYPES`](../packages/typescript-estree/src/ts-estree/ast-node-types.ts)
[`ESLintUtils`](./src/eslint-utils)
[`ESLintUtils.createRule`](./src/eslint-utils/createRule.ts)
[`ParserServices`](../packages/typescript-estree/src/ts-estree/parser.ts)
[`TSESTree`](../packages/typescript-estree/src/ts-estree/ts-estree.ts)
[`TSESLint`](./src/ts-eslint)
| Name | Description |
| ------------------- | ---------------------------------------------------------------------------------------------- |
| [`TSESTree`] | Types for the TypeScript flavour of ESTree created by `@typescript-eslint/typescript-estree`. |
| [`AST_NODE_TYPES`] | An enum with the names of every single _node_ found in `TSESTree`. |
| [`AST_TOKEN_TYPES`] | An enum with the names of every single _token_ found in `TSESTree`. |
| [`TSESLint`] | Types for ESLint, correctly typed to work with the types found in `TSESTree`. |
| [`ESLintUtils`] | Tools for creating eslint rules with TypeScript. |
| [`ParserServices`] | The parser services provided when parsing a file using `@typescript-eslint/typescript-estree`. |

[`ast_node_types`]: ../packages/typescript-estree/src/ts-estree/ast-node-types.ts
[`ast_token_types`]: ../packages/typescript-estree/src/ts-estree/ast-node-types.ts
[`eslintutils`]: ./src/eslint-utils
[`eslintutils.createrule`]: ./src/eslint-utils/createRule.ts
[`parserservices`]: ../packages/typescript-estree/src/ts-estree/parser.ts
[`tsestree`]: ../packages/typescript-estree/src/ts-estree/ts-estree.ts
[`tseslint`]: ./src/ts-eslint

0 comments on commit e6b2eff

Please sign in to comment.