@stacksjs/dtsx 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +133 -0
- package/dist/cli.js +85544 -0
- package/dist/config.d.ts +3 -0
- package/dist/extract.d.ts +59 -0
- package/dist/generate.d.ts +5 -0
- package/dist/index.d.ts +15 -0
- package/dist/index.js +65069 -0
- package/dist/types.d.ts +28 -0
- package/dist/utils.d.ts +11 -0
- package/package.json +86 -0
package/README.md
ADDED
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
<p align="center"><img src="https://github.com/stacksjs/dts-generation/blob/main/.github/art/cover.png?raw=true" alt="Social Card of this repo"></p>
|
|
2
|
+
|
|
3
|
+
[![npm version][npm-version-src]][npm-version-href]
|
|
4
|
+
[![GitHub Actions][github-actions-src]][github-actions-href]
|
|
5
|
+
[](http://commitizen.github.io/cz-cli/)
|
|
6
|
+
<!-- [![npm downloads][npm-downloads-src]][npm-downloads-href] -->
|
|
7
|
+
<!-- [![Codecov][codecov-src]][codecov-href] -->
|
|
8
|
+
|
|
9
|
+
## Features
|
|
10
|
+
|
|
11
|
+
- Fast .d.ts generation _(via isolatedDeclaration)_
|
|
12
|
+
- Highly configurable
|
|
13
|
+
- Cross-platform binary
|
|
14
|
+
- Dependency-free
|
|
15
|
+
- Bun-powered
|
|
16
|
+
|
|
17
|
+
## Install
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
bun install -d @stacksjs/dtsx
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
_@npm.js, please allow us to use the `dtsx` package name 🙏_,
|
|
24
|
+
|
|
25
|
+
<!-- _Alternatively, you can install:_
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
brew install dts-generation # wip
|
|
29
|
+
pkgx install dts-generation # wip
|
|
30
|
+
``` -->
|
|
31
|
+
|
|
32
|
+
## Get Started
|
|
33
|
+
|
|
34
|
+
There are two ways of using this dts generation tool: _as a library or as a CLI._
|
|
35
|
+
|
|
36
|
+
### Library
|
|
37
|
+
|
|
38
|
+
Given the npm package is installed:
|
|
39
|
+
|
|
40
|
+
```js
|
|
41
|
+
import { generate } from 'dts-generation'
|
|
42
|
+
|
|
43
|
+
generate()
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### CLI
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
dts-generation ...
|
|
50
|
+
dts-generation --help
|
|
51
|
+
dts-generation --version
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Configuration
|
|
55
|
+
|
|
56
|
+
The Reverse Proxy can be configured using a `dts.config.ts` _(or `dts.config.js`)_ file and it will be automatically loaded when running the `dts-generation` command.
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
// dts.config.ts (or dts.config.js)
|
|
60
|
+
export default {
|
|
61
|
+
cwd: './',
|
|
62
|
+
root: './src',
|
|
63
|
+
entrypoints: ['**/*.ts'],
|
|
64
|
+
outdir: './dist',
|
|
65
|
+
keepComments: true,
|
|
66
|
+
clean: true,
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
_Then run:_
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
dts-generation generate
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
To learn more, head over to the [documentation](https://dts-generation.sh/).
|
|
77
|
+
|
|
78
|
+
## Testing
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
bun test
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Changelog
|
|
85
|
+
|
|
86
|
+
Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
|
|
87
|
+
|
|
88
|
+
## Contributing
|
|
89
|
+
|
|
90
|
+
Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
|
|
91
|
+
|
|
92
|
+
## Community
|
|
93
|
+
|
|
94
|
+
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
|
|
95
|
+
|
|
96
|
+
[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
|
|
97
|
+
|
|
98
|
+
For casual chit-chat with others using this package:
|
|
99
|
+
|
|
100
|
+
[Join the Stacks Discord Server](https://discord.gg/stacksjs)
|
|
101
|
+
|
|
102
|
+
## Postcardware
|
|
103
|
+
|
|
104
|
+
Two things are true: Stacks OSS will always stay open-source, and we do love to receive postcards from wherever Stacks is used! 🌍 _We also publish them on our website. And thank you, Spatie_
|
|
105
|
+
|
|
106
|
+
Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094
|
|
107
|
+
|
|
108
|
+
## Sponsors
|
|
109
|
+
|
|
110
|
+
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.
|
|
111
|
+
|
|
112
|
+
- [JetBrains](https://www.jetbrains.com/)
|
|
113
|
+
- [The Solana Foundation](https://solana.com/)
|
|
114
|
+
|
|
115
|
+
## Credits
|
|
116
|
+
|
|
117
|
+
- [Chris Breuer](https://github.com/chrisbbreuer)
|
|
118
|
+
- [All Contributors](../../contributors)
|
|
119
|
+
|
|
120
|
+
## License
|
|
121
|
+
|
|
122
|
+
The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
|
|
123
|
+
|
|
124
|
+
Made with 💙
|
|
125
|
+
|
|
126
|
+
<!-- Badges -->
|
|
127
|
+
[npm-version-src]: https://img.shields.io/npm/v/@stacksjs/reverse-proxy?style=flat-square
|
|
128
|
+
[npm-version-href]: https://npmjs.com/package/@stacksjs/reverse-proxy
|
|
129
|
+
[github-actions-src]: https://img.shields.io/github/actions/workflow/status/stacksjs/reverse-proxy/ci.yml?style=flat-square&branch=main
|
|
130
|
+
[github-actions-href]: https://github.com/stacksjs/reverse-proxy/actions?query=workflow%3Aci
|
|
131
|
+
|
|
132
|
+
<!-- [codecov-src]: https://img.shields.io/codecov/c/gh/stacksjs/reverse-proxy/main?style=flat-square
|
|
133
|
+
[codecov-href]: https://codecov.io/gh/stacksjs/reverse-proxy -->
|