Skip to content

Commit 786ae30

Browse files
committed
docs: add vuejs/language-tools config example and clarify brace expansion vs glob
1 parent 54310e3 commit 786ae30

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ npm install @tsslint/config --save-dev
5454

5555
### 2. Configure `tsslint.config.ts`
5656

57+
A minimal configuration looks like this. For a complete, real-world example, see the [vuejs/language-tools tsslint.config.ts](https://github.com/vuejs/language-tools/blob/master/tsslint.config.ts).
58+
5759
```ts
5860
import { defineConfig } from '@tsslint/config';
5961

@@ -119,6 +121,12 @@ npx tsslint --project packages/*/tsconfig.json --vue-project apps/web/tsconfig.j
119121

120122
# Using brace expansion for multiple patterns
121123
npx tsslint --project {tsconfig.json,packages/*/tsconfig.json,extensions/*/tsconfig.json}
124+
125+
126+
> [!NOTE]
127+
> The brace expansion pattern (`{a,b}`) is handled by your shell (e.g., bash, zsh) before the command is executed. The CLI receives a list of arguments.
128+
>
129+
> For glob patterns (`*`), TSSLint uses an internal `glob` library to ensure cross-platform compatibility (especially on Windows) and to support advanced features like file watching, where the original pattern is needed.
122130
```
123131

124132
> [!TIP]

0 commit comments

Comments
 (0)