tsup - npm Package Compare versions
Comparing version 3.10.0 to 3.10.1
@@ -5,3 +5,3 @@ "use strict";Object.defineProperty(exports, "__esModule", {value: true}); | ||
| var _chunk1znoPSljs = require('./chunk.-1znoPSl.js'); | ||
| var _chunkeNQFCg1hjs = require('./chunk.eNQFCg1h.js'); | ||
| require('./chunk.DEUMEOWj.js'); | ||
@@ -14,2 +14,2 @@ | ||
| exports.build = _chunk1znoPSljs.build; exports.makeLabel = _chunk1znoPSljs.makeLabel; exports.runEsbuild = _chunk1znoPSljs.runEsbuild; | ||
| exports.build = _chunkeNQFCg1hjs.build; exports.makeLabel = _chunkeNQFCg1hjs.makeLabel; exports.runEsbuild = _chunkeNQFCg1hjs.runEsbuild; |
| { | ||
| "name": "tsup", | ||
| "version": "3.10.0", | ||
| "version": "3.10.1", | ||
| "main": "dist/index.js", | ||
@@ -5,0 +5,0 @@ "bin": "dist/cli.js", |
172
README.md
@@ -7,178 +7,16 @@ # tsup | ||
| ## What can it bundle? | ||
| ## Quick Start | ||
| Anything that's supported by Node.js natively, namely `.js`, `.json`, `.mjs`. And TypeScript `.ts`, `.tsx`. | ||
| This project is designed for bundling Node.js libraries. | ||
| ## Install | ||
| Install it locally in your project folder: | ||
| ```bash | ||
| npm i tsup -D | ||
| # Or Yarn | ||
| yarn add tsup --dev | ||
| tsup src/index.ts | ||
| ``` | ||
| You can also install it globally but it's not recommended. | ||
| This will bundle `src/index.ts` to `dist/index.js`. | ||
| ## Usage | ||
| ## Documentation | ||
| ### Bundle files | ||
| https://tsup.egoist.sh | ||
| ```bash | ||
| tsup [...files] | ||
| ``` | ||
| Files are written into `./dist`. | ||
| You can bundle multiple files in one go: | ||
| ```bash | ||
| tsup src/index.ts src/cli.ts | ||
| ``` | ||
| This will output `dist/index.js` and `dist/cli.js`. | ||
| Code splitting is enabled by default and supported in `cjs` and `esm` format. | ||
| ### Excluding packages | ||
| By default tsup bundles all `import`-ed modules but `dependencies` and `peerDependencies` in your `packages.json` are always excluded, you can also use `--external <module>` flag to mark other packages as external. | ||
| ### Generate declaration file | ||
| ```bash | ||
| tsup index.ts --dts | ||
| ``` | ||
| This will emit `./dist/index.js` and `./dist/index.d.ts`. | ||
| If you set multiple entry files, each entry will get a corresponding `.d.ts` file. | ||
| ### Generate sourcemap file | ||
| ```bash | ||
| tsup index.ts --sourcemap | ||
| ``` | ||
| This will emit `./dist/index.js` and `./dist/index.js.map`. | ||
| If you set multiple entry files, each entry will get a corresponding `.map` file. | ||
| ### Bundle formats | ||
| Supported format: `esm`, `cjs`, (default) and `iife`. | ||
| You can bundle in multiple formats in one go: | ||
| ```bash | ||
| tsup src/index.ts --format esm,cjs,iife | ||
| ``` | ||
| That will output files in following folder structure: | ||
| ```bash | ||
| dist | ||
| ├── index.mjs # esm | ||
| ├── index.global.js # iife | ||
| └── index.js # cjs | ||
| ``` | ||
| If the `type` field in your `package.json` is set to `module`, the filenames will be slightly different: | ||
| ```bash | ||
| dist | ||
| ├── index.js # esm | ||
| ├── index.global.js # iife | ||
| └── index.cjs # cjs | ||
| ``` | ||
| Read more about [`esm` support in Node.js](https://nodejs.org/api/esm.html#esm_enabling). | ||
| If you don't want extensions like `.mjs` or `.cjs`, e.g. you want your library to be used in a bundler (or environment) that doesn't support those, you can enable `--legacy-output` flag: | ||
| ```bash | ||
| tsup src/index.ts --format esm,cjs,iife --legacy-output | ||
| ``` | ||
| ..which outputs to: | ||
| ```bash | ||
| dist | ||
| ├── esm | ||
| │ └── index.js | ||
| ├── iife | ||
| │ └── index.js | ||
| └── index.js | ||
| ``` | ||
| ### ES5 support | ||
| You can use `--target es5` or `"target": "es5"` in `tsconfig.json` to compile the code down to es5, it's processed by [buble](http://buble.surge.sh/). Some features are NOT supported by this target, namely: `for .. of`. | ||
| ### Compile-time environment variables | ||
| You can use `--env` flag to define compile-time environment variables: | ||
| ```bash | ||
| tsup src/index.ts --env.NODE_ENV production | ||
| ``` | ||
| ### Building CLI app | ||
| When an entry file like `src/cli.ts` contains hashbang like `#!/bin/env node` tsup will automatically make the outout file executable, so you don't have to run `chmod +x dist/cli.js`. | ||
| ### Watch mode | ||
| ```bash | ||
| tsup src/index.ts --watch | ||
| ``` | ||
| ### Minify output | ||
| You can also minify the output, resulting into lower bundle sizes by using the `--minify` flag. | ||
| ```bash | ||
| tsup src/index.ts --minify | ||
| ``` | ||
| ### What about type checking? | ||
| esbuild is fast because it doesn't perform any type checking, you already get type checking from your IDE like VS Code or WebStorm. | ||
| Additionally, if you want type checking at build time, you can enable `--dts`, which will run a real TypeScript compiler to generate declaration file so you get type checking as well. | ||
| ### CSS support | ||
| esbuild has [experimental CSS support](https://esbuild.github.io/content-types/#css), and tsup allows you to use PostCSS plugins on top of native CSS support. | ||
| To use PostCSS, you need to install PostCSS: | ||
| ```bash | ||
| yarn add postcss --dev | ||
| ``` | ||
| ..and populate a `postcss.config.js` in your project | ||
| ```js | ||
| module.exports = { | ||
| plugins: [ | ||
| require('tailwindcss')(), | ||
| require('autoprefixer')() | ||
| ] | ||
| } | ||
| ``` | ||
| --- | ||
| For more details: | ||
| ```bash | ||
| tsup --help | ||
| ``` | ||
| ## License | ||
| MIT © [EGOIST (Kevin Titor)](https://github.com/sponsors/egoist) |
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Lines of code
- increased by0.1%
16788
Worsened metrics
- Total package byte prevSize
- decreased by-0.6%
576394
- Number of lines in readme file
- decreased by-88.04%
22
No dependency changes