https://github.com/unjs/mkdist
Lightweight file-to-file transpiler.
https://github.com/unjs/mkdist
Last synced: 15 days ago
JSON representation
Lightweight file-to-file transpiler.
- Host: GitHub
- URL: https://github.com/unjs/mkdist
- Owner: unjs
- License: mit
- Created: 2021-01-14T11:51:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T16:31:13.000Z (about 1 year ago)
- Last Synced: 2024-04-13T20:45:37.710Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 936 KB
- Stars: 312
- Watchers: 6
- Forks: 18
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# mkdist
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions][github-actions-src]][github-actions-href]
[![Codecov][codecov-src]][codecov-href]
> Lightweight file-to-file transformer
✅ Copies all assets
✅ Supports [Vue Single File Components](https://vuejs.org/v2/guide/single-file-components.html)
✅ Fast and minimal transform by [esbuild](https://github.com/evanw/esbuild)
✅ `.d.ts` generation for `.ts`, `.js` and `.vue` files
✅ Support [postcss](https://postcss.org/) ([autoprefixer](https://github.com/postcss/autoprefixer), [cssnano](https://cssnano.co/) and [postcss-nested](https://www.npmjs.com/package/postcss-nested) enabled out of the box!)
## ❓ Why?
Bundling libraries isn't always the best choice:
- We lose original file structure
- We lose modern syntax by transpiling in bundle
- We lose critical-css by extracting css to a global dist (vue)
- Dependencies will be always imported from bundle even if not used (a second bundling step might fix this but it usually won't happen in development and for dependencies with side-effects)
While there are tools like [tsc](https://www.typescriptlang.org/docs/handbook/compiler-options.html) and [@babel/cli](https://babeljs.io/docs/en/babel-cli), they mostly focus on transpiling rather than keeping source level quality. Also they lack support for handling custom extensions like `.vue` and copying assets.
## 🚀 Usage
```bash
npx mkdist [rootDir] [--src=src] [--dist=dist] [--no-clean] [--pattern=glob [--pattern=more-glob]] [--format=cjs|esm] [-d|--declaration] [--ext=mjs|js|ts]
```
## License
[MIT](./LICENSE)
[npm-version-src]: https://img.shields.io/npm/v/mkdist?style=flat-square
[npm-version-href]: https://npmjs.com/package/mkdist
[npm-downloads-src]: https://img.shields.io/npm/dm/mkdist?style=flat-square
[npm-downloads-href]: https://npmjs.com/package/mkdist
[github-actions-src]: https://img.shields.io/github/actions/workflow/status/unjs/mkdist/ci.yml?branch=main&style=flat-square
[github-actions-href]: https://github.com/unjs/mkdist/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/mkdist/main?style=flat-square
[codecov-href]: https://codecov.io/gh/unjs/mkdist