Skip to content

Commit 2238c68

Browse files
committed
docs: simplify CLI examples and explain brace expansion
1 parent 23bed08 commit 2238c68

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,12 +115,15 @@ npx tsslint --project path/to/tsconfig.json
115115
npx tsslint --project path/to/tsconfig.json --fix
116116

117117
# Lint multiple projects
118-
npx tsslint --project 'packages/*/tsconfig.json' --vue-project 'apps/web/tsconfig.json'
118+
npx tsslint --project packages/*/tsconfig.json --vue-project apps/web/tsconfig.json
119119

120120
# Using brace expansion for multiple patterns
121-
npx tsslint --project '{tsconfig.json,packages/*/tsconfig.json,extensions/*/tsconfig.json}'
121+
npx tsslint --project {tsconfig.json,packages/*/tsconfig.json,extensions/*/tsconfig.json}
122122
```
123123

124+
> [!NOTE]
125+
> Brace expansion (e.g., `{a,b}`) is a feature of your shell (like bash or zsh). The shell expands these patterns into multiple arguments before passing them to TSSLint. For glob patterns (e.g., `*`), TSSLint uses the `glob` library to resolve them internally.
126+
124127
> [!TIP]
125128
> TSSLint focuses on diagnostic fixes and does not include a built-in formatter. It is recommended to run a dedicated formatter like **Prettier**, **dprint**, or **oxfmt** after running TSSLint with `--fix`.
126129

0 commit comments

Comments
 (0)