Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/FredKSchott/pika-pack
📦⚡️ Build your npm package using composable plugins. https://www.pika.dev/blog/introducing-pika-pack/
https://github.com/FredKSchott/pika-pack
Last synced: 7 days ago
JSON representation
📦⚡️ Build your npm package using composable plugins. https://www.pika.dev/blog/introducing-pika-pack/
- Host: GitHub
- URL: https://github.com/FredKSchott/pika-pack
- Owner: FredKSchott
- License: other
- Archived: true
- Created: 2019-01-13T06:14:38.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-04-10T00:00:46.000Z (over 2 years ago)
- Last Synced: 2024-05-30T16:33:58.459Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 867 KB
- Stars: 2,314
- Watchers: 26
- Forks: 36
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - pack - 📦⚡️ npm package building, reimagined. https://www.pika.dev/blog/introducing-pika-pack/ (JavaScript)
- my-awesome-list - pika-pack - pika-pack/ | FredKSchott | 2309 | (JavaScript)
- awesome-github-repos - FredKSchott/pika-pack - 📦⚡️ Build your npm package using composable plugins. https://www.pika.dev/blog/introducing-pika-pack/ (JavaScript)
README
@pika/pack • npm package building, reimagined.
## @pika/pack helps you build amazing packages without the hassle:
- **Simple** ⚡️ Use pre-configured plugins to build your package for you.
- **Flexible** 🏋️♀️ Choose plugins and optimizations to match your needs.
- **Holistic** ⚛️ Let us build the entire package... *including package.json.*
## Quickstart
```bash
npx @pika/pack # Run once.
npm install --dev @pika/pack # Or, run multiple times using "pika pack" in any package.json scripts
```
😎🆒! So now what? If you run `pika build` with an empty pipeline, you'll get an empty package build. **@pika/pack** lets you connect pre-configured plugins to build and optimize your package for you. Plugins wrap already-popular tools like Babel and Rollup with npm-optimized config options, removing the need to fiddle with much (if any) configuration yourself. You even get a generated package.json manifest configured for you ***automatically***.
### 1. Create a project pipeline out of simple, pluggable builders.
```js
// Before: Your top-level package.json manifest:
{
"name": "simple-package",
"version": "1.0.0",
"@pika/pack": {
"pipeline": [
["@pika/plugin-standard-pkg", {"exclude": ["__tests__/**/*"]}],
["@pika/plugin-build-node"],
["@pika/plugin-build-web"],
["@pika/plugin-build-types"]
]
}
}
```
Builders are simple, single-purpose build plugins defined in your `package.json`. For example, `@pika/plugin-build-node` & `@pika/plugin-build-web` build your package for those different environments. Other, more interesting builders can bundle your web build for [unpkg](https://unpkg.com), generate TypeScript definitions from your JavaScript, addon a standard CLI wrapper for Node.js builds, and even compile non-JS languages to WASM (with JS bindings added).
### 2. Builders handle everything, including package configuration.
```js
// After: your built "pkg/" package.json manifest:
{
"name": "simple-package",
"version": "1.0.0",
// Multiple distributions, built & configured automatically:
"esnext": "dist-src/index.js",
"main": "dist-node/index.js",
"module": "dist-web/index.js",
"types": "dist-types/index.d.ts",
// With sensible package defaults:
"sideEffects": false,
"files": ["dist-*/", "assets/", "bin/"]
}
```
This is all possible because **@pika/pack** builds your entire package: code, assets, and even package.json manifest. By building the entire package, you end up with a fully-built `pkg/` directory, ready to publish. Entry points like "main", "module", "umd:main", "types", "unpkg", "files", and even advanced options like "sideEffects" are all handled by your build pipeline.
## Build Plugins
**[Check out the full list](https://github.com/pikapkg/builders)** of official & community-written @pika/pack plugins!
## Lerna Support
Curious about integrating @pika/pack with Lerna? Our official collection of plugins is a Lerna repo that uses @pika/pack to build each package! [Check it out](https://github.com/pikapkg/builders) to see how easy it is to use the two tools together.