From 1012e0b2e9fea2befe2215dc7fdca7276a6bc06e Mon Sep 17 00:00:00 2001 From: Brandon Mills Date: Mon, 23 May 2022 11:41:17 -0400 Subject: [PATCH] docs(eslint-plugin): add triple-slash-reference options schema and defaults (#5039) --- .../docs/rules/triple-slash-reference.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/packages/eslint-plugin/docs/rules/triple-slash-reference.md b/packages/eslint-plugin/docs/rules/triple-slash-reference.md index 2488d28ab13..d15d1cc5e12 100644 --- a/packages/eslint-plugin/docs/rules/triple-slash-reference.md +++ b/packages/eslint-plugin/docs/rules/triple-slash-reference.md @@ -44,6 +44,22 @@ import * as foo from 'foo'; import foo = require('foo'); ``` +## Options + +```ts +type Options = { + lib?: 'always' | 'never'; + path?: 'always' | 'never'; + types?: 'always' | 'never' | 'prefer-import'; +}; + +const defaultOptions: Options = { + lib: 'always', + path: 'never', + types: 'prefer-import', +}; +``` + ## When To Use It If you want to ban use of one or all of the triple slash reference directives, or any time you might use triple-slash type reference directives and ES6 import declarations in the same file.