@kitschpatrol/tweakpane-plugin-textarea
Version:
A fork of @pangenerator/tweakpane-textarea-plugin with build optimizations.
34 lines (17 loc) • 2.56 kB
Markdown
# /tweakpane-plugin-textarea
[](https://npmjs.com/package/@kitschpatrol/tweakpane-plugin-textarea)
## Overview
**This is a fork of [Krzysztof Goliński](http://www.golinski.org) and [Jakub Koźniewski](https://pangenerator.com)'s [tweakpane-textarea-plugin](https://github.com/pangenerator/tweakpane-textarea-plugin) with externalized dependencies.**
This allows for smaller bundled file sizes in projects using multiple Tweakpane plugins.
It is published to NPM primarily for the [_Svelte Tweakpane UI_](https://kitschpatrol.com/svelte-tweakpane-ui) project, and will be kept in sync with the upstream version of the plugin, with minimal changes other than dependency externalization.
For most use cases, you probably don't want this fork!
## Background
The [Rollup](https://rollupjs.org) configuration provided in the [Tweakpane plugin template](https://github.com/tweakpane/plugin-template) does not externalize [`@tweakpane/core`](https://github.com/cocopon/tweakpane/tree/main/packages/core) as a production dependency.
Instead, it gets built into the single-file plugin artifact, which is what's published to NPM and imported by plugin consumers. This makes it easy to import as an ES module from a URL, but means that larger projects importing multiple Tweakpane plugins end up with duplicate copies of the `/core` code, adding about ~100 Kb to the final minified build for each plugin after the first.
Externalizing this dependency allows build tools like [vite](https://vitejs.dev) to share a single instance of the `@tweakpane/core` code across multiple plugins.
If you're not using a bundler, direct ESM imports from URLs can still work by defining the `/core` dependency in an [importmap](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script/type/importmap).
## Implementation notes
Note the package's name change from `/tweakpane-textarea-plugin` to `@kitschpatrol/tweakpane-plugin-textarea` in the sanity-preserving spirit of [hierarchical naming](https://en.wikipedia.org/wiki/Reverse_domain_name_notation).
PNPM is used as the package manager.
## Versioning
In addition to the dependency externalization change, this fork also includes assorted dependency updates. In an effort to stay in sync with future upstream versions, intra-minor-version releases of the fork are tagged as "betas" of what would / will be the next patch release upstream.