tshy 3.3.2 → 4.1.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 +36 -46
- package/dist/esm/bin-min.d.mts +1 -1
- package/dist/esm/bin-min.d.mts.map +1 -1
- package/dist/esm/bin-min.mjs +12 -14
- package/dist/esm/bin-min.mjs.map +3 -3
- package/dist/esm/build-commonjs.d.ts.map +1 -1
- package/dist/esm/build-commonjs.js +18 -7
- package/dist/esm/build-commonjs.js.map +1 -1
- package/dist/esm/build-esm.d.ts.map +1 -1
- package/dist/esm/build-esm.js +11 -7
- package/dist/esm/build-esm.js.map +1 -1
- package/dist/esm/build-fail.d.ts +1 -1
- package/dist/esm/build-fail.d.ts.map +1 -1
- package/dist/esm/build-fail.js.map +1 -1
- package/dist/esm/build-live-commonjs.d.ts.map +1 -1
- package/dist/esm/build-live-commonjs.js +8 -6
- package/dist/esm/build-live-commonjs.js.map +1 -1
- package/dist/esm/build-live-esm.d.ts.map +1 -1
- package/dist/esm/build-live-esm.js +8 -6
- package/dist/esm/build-live-esm.js.map +1 -1
- package/dist/esm/build.d.ts.map +1 -1
- package/dist/esm/build.js +3 -2
- package/dist/esm/build.js.map +1 -1
- package/dist/esm/built-imports.d.ts +1 -1
- package/dist/esm/built-imports.d.ts.map +1 -1
- package/dist/esm/built-imports.js.map +1 -1
- package/dist/esm/config.d.ts +1 -1
- package/dist/esm/config.d.ts.map +1 -1
- package/dist/esm/config.js +3 -3
- package/dist/esm/config.js.map +1 -1
- package/dist/esm/console.d.ts.map +1 -1
- package/dist/esm/console.js +3 -1
- package/dist/esm/console.js.map +1 -1
- package/dist/esm/exports.d.ts +1 -1
- package/dist/esm/exports.d.ts.map +1 -1
- package/dist/esm/exports.js +43 -58
- package/dist/esm/exports.js.map +1 -1
- package/dist/esm/package.d.ts +1 -1
- package/dist/esm/package.d.ts.map +1 -1
- package/dist/esm/package.js.map +1 -1
- package/dist/esm/polyfills.d.ts +1 -0
- package/dist/esm/polyfills.d.ts.map +1 -1
- package/dist/esm/polyfills.js +22 -9
- package/dist/esm/polyfills.js.map +1 -1
- package/dist/esm/read-typescript-config.d.ts +1 -1
- package/dist/esm/read-typescript-config.d.ts.map +1 -1
- package/dist/esm/read-typescript-config.js +1 -0
- package/dist/esm/read-typescript-config.js.map +1 -1
- package/dist/esm/resolve-export.d.ts +1 -1
- package/dist/esm/resolve-export.d.ts.map +1 -1
- package/dist/esm/resolve-export.js +1 -1
- package/dist/esm/resolve-export.js.map +1 -1
- package/dist/esm/self-link.d.ts +2 -1
- package/dist/esm/self-link.d.ts.map +1 -1
- package/dist/esm/self-link.js +1 -1
- package/dist/esm/self-link.js.map +1 -1
- package/dist/esm/set-folder-dialect.d.ts +1 -1
- package/dist/esm/set-folder-dialect.d.ts.map +1 -1
- package/dist/esm/set-folder-dialect.js.map +1 -1
- package/dist/esm/tsconfig.d.ts.map +1 -1
- package/dist/esm/tsconfig.js +15 -12
- package/dist/esm/tsconfig.js.map +1 -1
- package/dist/esm/types.d.ts +1 -1
- package/dist/esm/types.d.ts.map +1 -1
- package/dist/esm/types.js.map +1 -1
- package/dist/esm/unbuilt-imports.d.ts +1 -1
- package/dist/esm/unbuilt-imports.d.ts.map +1 -1
- package/dist/esm/unbuilt-imports.js.map +1 -1
- package/dist/esm/valid-dialects.d.ts +3 -3
- package/dist/esm/valid-dialects.d.ts.map +1 -1
- package/dist/esm/valid-dialects.js.map +1 -1
- package/dist/esm/valid-exclude.d.ts +1 -1
- package/dist/esm/valid-exclude.d.ts.map +1 -1
- package/dist/esm/valid-exclude.js.map +1 -1
- package/dist/esm/valid-exports.d.ts +1 -1
- package/dist/esm/valid-exports.d.ts.map +1 -1
- package/dist/esm/valid-exports.js +2 -1
- package/dist/esm/valid-exports.js.map +1 -1
- package/dist/esm/valid-external-export.d.ts +1 -1
- package/dist/esm/valid-external-export.d.ts.map +1 -1
- package/dist/esm/valid-external-export.js.map +1 -1
- package/dist/esm/valid-extra-dialects.d.ts +1 -1
- package/dist/esm/valid-extra-dialects.d.ts.map +1 -1
- package/dist/esm/valid-extra-dialects.js +21 -17
- package/dist/esm/valid-extra-dialects.js.map +1 -1
- package/dist/esm/valid-imports.d.ts +1 -1
- package/dist/esm/valid-imports.d.ts.map +1 -1
- package/dist/esm/valid-imports.js.map +1 -1
- package/dist/esm/valid-project.d.ts.map +1 -1
- package/dist/esm/valid-project.js.map +1 -1
- package/dist/esm/watch.d.ts +1 -1
- package/dist/esm/watch.d.ts.map +1 -1
- package/dist/esm/watch.js +1 -0
- package/dist/esm/watch.js.map +1 -1
- package/package.json +13 -11
package/README.md
CHANGED
|
@@ -9,6 +9,23 @@ and CommonJS variants, [providing the full strength of
|
|
|
9
9
|
TypeScript’s checking for both output
|
|
10
10
|
formats](https://twitter.com/atcb/status/1702069237710479608).
|
|
11
11
|
|
|
12
|
+
> > [!NOTICE]
|
|
13
|
+
>
|
|
14
|
+
> ## Upgrading from v3 to v4 and v5
|
|
15
|
+
>
|
|
16
|
+
> Version 4 switches from TypeScript 5 to TypeScript 6 by
|
|
17
|
+
> default. (Note: you can already preview TypeScript 7 by setting
|
|
18
|
+
> `"compiler": "tsgo"` in your tshy options, or any other version
|
|
19
|
+
> by specify `typescript` as a `devDependency` in your project.)
|
|
20
|
+
>
|
|
21
|
+
> This may cause problems upgrading, because tshy will only
|
|
22
|
+
> create a new `tsconfig.json` file if the file is missing
|
|
23
|
+
> (assuming that you've put it there for a good reason), and the
|
|
24
|
+
> requirements have changed slightly.
|
|
25
|
+
>
|
|
26
|
+
> If you get tsc errors after upgrading, try deleting your
|
|
27
|
+
> `tsconfig.json` file, and re-running tshy.
|
|
28
|
+
|
|
12
29
|
## USAGE
|
|
13
30
|
|
|
14
31
|
Install tshy:
|
|
@@ -264,6 +281,10 @@ CommonJS and `./dist/esm` for ESM.
|
|
|
264
281
|
There is very little configuration for this, but a lot of things
|
|
265
282
|
_can_ be configured.
|
|
266
283
|
|
|
284
|
+
### How to Configure Tshy
|
|
285
|
+
|
|
286
|
+
Set options in the `tshy` field in `package.json`.
|
|
287
|
+
|
|
267
288
|
### `exports`
|
|
268
289
|
|
|
269
290
|
By default, if there is a `src/index.ts` file, then that will be
|
|
@@ -754,7 +775,9 @@ builds entirely, you can add an `exclude` `string[]` field to the
|
|
|
754
775
|
If you have any other dialects that you'd like to support, you
|
|
755
776
|
can list them as either `commonjsDialects` or `esmDialects`,
|
|
756
777
|
depending on whether you want them to be built as CommonJS or
|
|
757
|
-
ESM.
|
|
778
|
+
ESM. As of version 4.1, it is possible to have a dialect in both
|
|
779
|
+
types, and it'll build to both `dist/commonjs/${name}` and
|
|
780
|
+
`dist/esm/${name}`, as appropriate.
|
|
758
781
|
|
|
759
782
|
Note that each added dialect you create will result in another
|
|
760
783
|
build in the `./dist` folder, so you may wish to use sparingly if
|
|
@@ -780,23 +803,23 @@ Will result in:
|
|
|
780
803
|
{
|
|
781
804
|
"exports": {
|
|
782
805
|
".": {
|
|
783
|
-
"deno": {
|
|
784
|
-
"types": "./dist/deno/index.d.ts",
|
|
785
|
-
"default": "./dist/deno/index.js"
|
|
786
|
-
},
|
|
787
|
-
"browser": {
|
|
788
|
-
"types": "./dist/browser/index.d.ts",
|
|
789
|
-
"default": "./dist/browser/index.js"
|
|
790
|
-
},
|
|
791
|
-
"webpack": {
|
|
792
|
-
"types": "./dist/webpack/index.d.ts",
|
|
793
|
-
"default": "./dist/webpack/index.js"
|
|
794
|
-
},
|
|
795
806
|
"require": {
|
|
807
|
+
"webpack": {
|
|
808
|
+
"types": "./dist/commonjs/webpack/index.d.ts",
|
|
809
|
+
"default": "./dist/commonjs/webpack/index.js"
|
|
810
|
+
},
|
|
796
811
|
"types": "./dist/commonjs/index.d.ts",
|
|
797
812
|
"default": "./dist/commonjs/index.js"
|
|
798
813
|
},
|
|
799
814
|
"import": {
|
|
815
|
+
"deno": {
|
|
816
|
+
"types": "./dist/esm/deno/index.d.ts",
|
|
817
|
+
"default": "./dist/esm/deno/index.js"
|
|
818
|
+
},
|
|
819
|
+
"browser": {
|
|
820
|
+
"types": "./dist/esm/browser/index.d.ts",
|
|
821
|
+
"default": "./dist/esm/browser/index.js"
|
|
822
|
+
},
|
|
800
823
|
"types": "./dist/esm/index.d.ts",
|
|
801
824
|
"default": "./dist/esm/index.js"
|
|
802
825
|
}
|
|
@@ -822,39 +845,6 @@ src/index-deno.mts # esm variant for deno
|
|
|
822
845
|
src/index-webpack.cts # cjs variant for webpack
|
|
823
846
|
```
|
|
824
847
|
|
|
825
|
-
If dialect overrides are used, then the `"source"` export
|
|
826
|
-
condition will refer to the original source for the override. For
|
|
827
|
-
example:
|
|
828
|
-
|
|
829
|
-
```json
|
|
830
|
-
{
|
|
831
|
-
"exports": {
|
|
832
|
-
".": {
|
|
833
|
-
"deno": {
|
|
834
|
-
"types": "./dist/deno/index.d.ts",
|
|
835
|
-
"default": "./dist/deno/index.js"
|
|
836
|
-
},
|
|
837
|
-
"browser": {
|
|
838
|
-
"types": "./dist/browser/index.d.ts",
|
|
839
|
-
"default": "./dist/browser/index.js"
|
|
840
|
-
},
|
|
841
|
-
"webpack": {
|
|
842
|
-
"types": "./dist/webpack/index.d.ts",
|
|
843
|
-
"default": "./dist/webpack/index.js"
|
|
844
|
-
},
|
|
845
|
-
"require": {
|
|
846
|
-
"types": "./dist/commonjs/index.d.ts",
|
|
847
|
-
"default": "./dist/commonjs/index.js"
|
|
848
|
-
},
|
|
849
|
-
"import": {
|
|
850
|
-
"types": "./dist/esm/index.d.ts",
|
|
851
|
-
"default": "./dist/esm/index.js"
|
|
852
|
-
}
|
|
853
|
-
}
|
|
854
|
-
}
|
|
855
|
-
}
|
|
856
|
-
```
|
|
857
|
-
|
|
858
848
|
Note that the `commonjs` override uses the abbreviated `cjs`
|
|
859
849
|
name (historical reasons, it was originally the only override
|
|
860
850
|
supported), and that the file extension must be `cts` or `mts`
|
package/dist/esm/bin-min.d.mts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
|
|
1
|
+
import './index.js';
|
|
2
2
|
//# sourceMappingURL=bin-min.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bin-min.d.mts","sourceRoot":"","sources":["../../src/bin-min.mts"],"names":[],"mappings":"AACA,OAAO,
|
|
1
|
+
{"version":3,"file":"bin-min.d.mts","sourceRoot":"","sources":["../../src/bin-min.mts"],"names":[],"mappings":"AACA,OAAO,YAAY,CAAA","sourcesContent":["// this is a placeholder for the compiled bin\nimport './index.js'\n"]}
|