Skip to content

Commit ae68c4e

Browse files
committed
chore: wip
1 parent 8cad5b6 commit ae68c4e

File tree

3 files changed

+73
-8
lines changed

3 files changed

+73
-8
lines changed

.cursor/rules/readme.mdc

Lines changed: 71 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
---
22
description: General information based on the latest ./README.md content
3-
globs:
3+
globs:
4+
alwaysApply: false
45
---
5-
Update it if APIs change:
6+
<p align="center"><img src="https://github.com/stacksjs/dtsx/blob/main/.github/art/cover.jpg?raw=true" alt="Social Card of this repo"></p>
7+
8+
[![npm version][npm-version-src]][npm-version-href]
9+
[![GitHub Actions][github-actions-src]][github-actions-href]
10+
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
11+
<!-- [![npm downloads][npm-downloads-src]][npm-downloads-href] -->
12+
<!-- [![Codecov][codecov-src]][codecov-href] -->
613

714
# dtsx
815

@@ -21,7 +28,7 @@ Update it if APIs change:
2128
bun install -d @stacksjs/dtsx
2229
```
2330

24-
<[email protected]>, please allow us to use the `dtsx` package name 🙏_
31+
[email protected], please allow us to use the `dtsx` package name 🙏_
2532

2633
<!-- _Alternatively, you can install:_
2734

@@ -61,7 +68,7 @@ const options: DtsGenerationOptions = {
6168
outdir: './dist', // default: './dist'
6269
clean: true, // default: false
6370
verbose: true, // default: false
64-
// keepComments: true, // coming soon
71+
keepComments: true, // default: true
6572
}
6673

6774
await generate(options)
@@ -123,11 +130,68 @@ _Available options:_
123130

124131
- `--cwd <path>`: Set the current working directory _(default: current directory)_
125132
- `--root <path>`: Specify the root directory of the project _(default: './src')_
126-
- `--entrypoints <files>`: Define entry point files _(comma-separated, default: '**/*.ts')_
133+
- `--entrypoints <files>`: Deft files _(comma-separated, default: '**/*.ts')_
127134
- `--outdir <path>`: Set the output directory for generated .d.ts files _(default: './dist')_
128135
- `--keep-comments`: Keep comments in generated .d.ts files _(default: true)_
129136
- `--clean`: Clean output directory before generation _(default: false)_
130-
- `--tsconfig <path>`: Speci tsconfig.json _(default: 'tsconfig.json')_
137+
- `--tsconfig <path>`: Specify the path to tsconfig.json _(default: 'tsconfig.json')_
131138
- `--verbose`: Enable verbose output _(default: false)_
132139

133-
To learn more, head over to the [documentation](mdc:https:/dtsx.stacksjs.org).
140+
To learn more, head over to the [documentation](https://dtsx.stacksjs.org/).
141+
142+
## Testing
143+
144+
```bash
145+
bun test
146+
```
147+
148+
## Changelog
149+
150+
Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
151+
152+
## Contributing
153+
154+
Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
155+
156+
## Community
157+
158+
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
159+
160+
[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
161+
162+
For casual chit-chat with others using this package:
163+
164+
[Join the Stacks Discord Server](https://discord.gg/stacksjs)
165+
166+
## Postcardware
167+
168+
“Software that is free, but hopes for a postcard.” We love receiving postcards from around the world showing where `dtsx` is being used! We showcase them on our website too.
169+
170+
Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎
171+
172+
## Sponsors
173+
174+
We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.
175+
176+
- [JetBrains](https://www.jetbrains.com/)
177+
- [The Solana Foundation](https://solana.com/)
178+
179+
## Credits
180+
181+
- [Chris Breuer](https://github.com/chrisbbreuer)
182+
- [All Contributors](../../contributors)
183+
184+
## License
185+
186+
The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/dtsx/tree/main/LICENSE.md) for more information.
187+
188+
Made with 💙
189+
190+
<!-- Badges -->
191+
[npm-version-src]: https://img.shields.io/npm/v/@stacksjs/dtsx?style=flat-square
192+
[npm-version-href]: https://npmjs.com/package/@stacksjs/dtsx
193+
[github-actions-src]: https://img.shields.io/github/actions/workflow/status/stacksjs/dtsx/ci.yml?style=flat-square&branch=main
194+
[github-actions-href]: https://github.com/stacksjs/dtsx/actions?query=workflow%3Aci
195+
196+
<!-- [codecov-src]: https://img.shields.io/codecov/c/gh/stacksjs/dtsx/main?style=flat-square
197+
[codecov-href]: https://codecov.io/gh/stacksjs/dtsx -->

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ const options: DtsGenerationOptions = {
6363
outdir: './dist', // default: './dist'
6464
clean: true, // default: false
6565
verbose: true, // default: false
66-
// keepComments: true, // coming soon
66+
keepComments: true, // default: true
6767
}
6868

6969
await generate(options)

packages/dtsx/build.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ await Bun.build({
1111
format: 'esm',
1212
target: 'bun',
1313
minify: true,
14+
splitting: true,
1415
plugins: [
1516
dts(),
1617
],

0 commit comments

Comments
 (0)