0.2.2 • Published 3 months ago

@chialab/plasma v0.2.2

Weekly downloads
-
License
MIT
Repository
github
Last release
3 months ago

Plasma

Generate Custom Elements wrappers for Angular, React, Svelte and Vue.

plasma is the imperative form for the Italian verb plasmare, to shape in English.

Status

FrameworkBase wrapperPropertiesEventsSlotsTypings
Angular🚧🚧🚧🚧🚧
Preact
React
Svelte
Vue🚧🚧🚧🚧🚧

How it works

Plasma transformations are based on Custom Element Manifest (CEM) specifications. The CEM is a JSON files that describes a Custom Element, its properties, events and slots. Plasma uses the CEM to generate wrappers for the supported frameworks.

You can generate the CEM for most of the Web Components library using this Analyzer.

Installation

npm i -D @chialab/plasma

Usage

Plasma will try to autodetect the custom elements manifest (custom-elements.json) and will read the entrypoint from the package.json if not specified. The output directory will be ./dist/[framework] by default.

npm run plasma

Other samples

Create cross-framework wrappers for a Web Component library:

npm run plasma --entrypoint @acme/acme-button --outdir './dist/[framework]'

Create wrappers for React and Preact only:

npm run plasma --entrypoint @acme/acme-button --outdir './dist/[framework]' --frameworks react,preact

Create wrappers for Svelte only:

npm run plasma --entrypoint @acme/acme-button --outdir './svelte' --frameworks svelte

Specify custom elements manifest path:

npm run plasma 'dist/custom-elements.json' --entrypoint @acme/acme-button

Options

Usage: plasma [options] <input>

Generate Custom Elements wrappers for Angular, React, Svelte and Vue.

Arguments:
  input                             custom elements manifest path

Options:
  -V, --version                     output the version number
  -e, --entrypoint <path>           module entrypoint
  -o, --outdir <outdir>             output directory
  -f, --frameworks <frameworks...>  the framework to convert to
  -y, --yes                         convert all candidates to all available frameworks
  -h, --help                        display help for command

License

Plasma is released under the MIT license.

0.2.1

3 months ago

0.2.2

3 months ago

0.2.0

5 months ago

0.1.1

5 months ago

0.1.0

5 months ago