mokkenstorm.dev
fork of hey-api/openapi-ts because I need some additional things
docs: add changelog
+67
-2
+29
.changeset/clean-apes-divide.md
+29
.changeset/clean-apes-divide.md
···
1
+
---
2
+
'@hey-api/openapi-ts': patch
3
+
---
4
+
5
+
**output**: add `nameConflictResolver` option
6
+
7
+
## Name Conflicts
8
+
9
+
As your project grows, the chances of name conflicts increase. We use a simple conflict resolver that appends numeric suffixes to duplicate identifiers. If you prefer a different strategy, you can provide your own `nameConflictResolver` function.
10
+
11
+
```js
12
+
export default {
13
+
input: 'hey-api/backend', // sign up at app.heyapi.dev
14
+
output: {
15
+
nameConflictResolver({ attempt, baseName }) {
16
+
return attempt === 0 ? baseName : `${baseName}_N${attempt + 1}`;
17
+
},
18
+
path: 'src/client',
19
+
},
20
+
};
21
+
```
22
+
23
+
Example output:
24
+
25
+
```ts
26
+
export type ChatCompletion = string;
27
+
28
+
export type ChatCompletion_N2 = number;
29
+
```
+21
.changeset/eight-rabbits-unite.md
+21
.changeset/eight-rabbits-unite.md
···
1
+
---
2
+
'@hey-api/openapi-ts': minor
3
+
---
4
+
5
+
**output**: add `preferExportAll` option
6
+
7
+
### Prefer named exports
8
+
9
+
This release changes the default for `index.ts` to prefer named exports. Named exports may lead to better IDE and bundler performance compared to asterisk (`*`) as your tooling doesn't have to inspect the underlying module to discover exports.
10
+
11
+
While this change is merely cosmetic, you can set `output.preferExportAll` to `true` if you prefer to use the asterisk.
12
+
13
+
```js
14
+
export default {
15
+
input: 'hey-api/backend', // sign up at app.heyapi.dev
16
+
output: {
17
+
path: 'src/client',
18
+
preferExportAll: true,
19
+
},
20
+
};
21
+
```
+5
.changeset/gentle-spoons-kneel.md
+5
.changeset/gentle-spoons-kneel.md
+9
.changeset/plenty-walls-repeat.md
+9
.changeset/plenty-walls-repeat.md
+3
-2
docs/openapi-ts/configuration/output.md
+3
-2
docs/openapi-ts/configuration/output.md
···
264
264
265
265
::: code-group
266
266
267
+
<!-- prettier-ignore-start -->
267
268
```js [config]
268
269
export default {
269
270
input: 'hey-api/backend', // sign up at app.heyapi.dev
270
271
output: {
271
-
nameConflictResolver({ attempt, baseName }) {
272
-
// [!code ++]
272
+
nameConflictResolver({ attempt, baseName }) { // [!code ++]
273
273
return attempt === 0 ? baseName : `${baseName}_N${attempt + 1}`; // [!code ++]
274
274
}, // [!code ++]
275
275
path: 'src/client',
276
276
},
277
277
};
278
278
```
279
+
<!-- prettier-ignore-end -->
279
280
280
281
```ts [example]
281
282
export type ChatCompletion = string;