Skip to content

Commit 6ea062b

Browse files
committed
docs: update readme
1 parent 2378133 commit 6ea062b

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

packages/cli/README.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,25 @@ attw --pack . --exclude-entrypoints styles.css # Auto-discovered entrypoints exc
154154
attw --pack . --entrypoints-legacy # All published code files
155155
```
156156

157+
#### Profiles
158+
159+
Profiles select a set of resolution modes to require/ignore. All are evaluated but failures outside of those required are ignored.
160+
161+
The available profiles are:
162+
163+
- `strict` - requires all resolutions
164+
- `node16` - ignores node10 resolution failures
165+
- `esm-only` - ignores CJS resolution failures
166+
- `node16-only` - requires exactly node16 resolutions
167+
168+
In the CLI: `--profile`
169+
170+
```shell
171+
attw <file-name> --profile <profile>
172+
```
173+
174+
In the config file, `profile` can be a string value.
175+
157176
#### Ignore Rules
158177

159178
Specifies rules/problems to ignore (i.e. not raise an error for).
@@ -181,25 +200,6 @@ attw <file-name> --ignore-rules <rules...>
181200

182201
In the config file, `ignoreRules` can be an array of strings.
183202

184-
#### Ignore Resolutions
185-
186-
Specifies resolution modes to ignore (i.e. do not evaluate).
187-
188-
The available values are:
189-
190-
- `node10`
191-
- `node16-cjs`
192-
- `node16-esm`
193-
- `bundler`
194-
195-
In the CLI: `--ignore-resolutions`
196-
197-
```shell
198-
attw <file-name> --ignore-resolutions <resolutions...>
199-
```
200-
201-
In the config file, `ignoreResolutions` can be an array of strings.
202-
203203
#### Summary/No Summary
204204

205205
Whether to display a summary of what the different errors/problems mean. Defaults to showing the summary (`--summary`).

0 commit comments

Comments
 (0)