Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bunlong/create-svelte-library

📦 CLI for creating reusable Svelte libraries.
https://github.com/bunlong/create-svelte-library

babel cli component create-svelte-library library rollup svelte sveltejs

Last synced: 3 months ago
JSON representation

📦 CLI for creating reusable Svelte libraries.

Host: GitHub
URL: https://github.com/bunlong/create-svelte-library
Owner: Bunlong
License: mit
Created: 2021-04-30T07:05:45.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2021-05-03T16:50:33.000Z (over 3 years ago)
Last Synced: 2024-10-14T19:21:50.499Z (3 months ago)
Topics: babel, cli, component, create-svelte-library, library, rollup, svelte, sveltejs
Language: JavaScript
Homepage:
Size: 148 KB
Stars: 4
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# create-svelte-library

CLI for creating reusable, modern Svelte libraries using Rollup.

[![NPM](https://img.shields.io/npm/v/create-svelte-library.svg)](https://www.npmjs.com/package/create-svelte-library) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Features

* Easy-to-use CLI
* Handles all modern JS features
* Bundles commonjs and es module formats
* [Sapper](https://sapper.svelte.dev) for example usage and local dev
* [Rollup](https://rollupjs.org/guide/en) for bundling
* [Babel](https://babeljs.io) for transpiling
* Thorough documentation

## Install globally

```bash
npm install -g create-svelte-library
```

## Usage with npx

```bash
npx create-svelte-library
```

([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))

## Creating a New Module

```bash
create-svelte-library
```

Answer some basic prompts about your module, and then the CLI will perform the following steps:

* copy over the template
* install dependencies via yarn or npm
* link packages together for local development
* initialize local git repo

## Development

Local development is broken into two parts (ideally using two tabs).

First, run rollup to build your `src/` module and automatically recompile it into `dist/` whenever you make changes.

```bash
npm run build # runs rollup
```

The second part will be running the `example/` sapper that's linked to the local version of your module.

```bash
cd example
npm run dev # runs sapper dev server
```

Now, anytime you make a change to your library in `src/` or to the example app's `example/src`, sapper will reload your local dev server so you can iterate on your component in real-time.

#### Publishing to npm

```bash
npm publish
```

This builds `commonjs` and `es` versions of your module to `dist/` and then publishes your module to `npm`.

## ❗ Issues

If you think any of the `create-svelte-library` can be improved, please do open a PR with any updates and submit any issues. Also, I will continue to improve this, so you might want to watch/star this repository to revisit.

## 💪 Contribution

We'd love to have your helping hand on contributions to `create-svelte-library` by forking and sending a pull request!

Your contributions are heartily ♡ welcome, recognized and appreciated. (✿◠‿◠)

How to contribute:

- Open pull request with improvements
- Discuss ideas in issues
- Spread the word
- Reach out with any feedback

## ⚖️ License

The MIT License [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)