# storybook-vue-csf-addon

> A Storybook Addon to write Storybook's stories using Vue SFC syntax and automatically convert them to Storybook CSF

Latest version **0.0.1-beta.1** (published 2023-09-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install storybook-vue-csf-addon
pnpm add storybook-vue-csf-addon
yarn add storybook-vue-csf-addon
bun add storybook-vue-csf-addon
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1-beta.1 |
| Published | 2023-09-13 |
| First published | 2023-09-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 20.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | floroz |
| Keywords | unplugin, vite, webpack, rollup, transform, storybook, vue, vue3 |

## Links

- npm: https://www.npmjs.com/package/storybook-vue-csf-addon
- Repository: https://github.com/floroz/storybook-vue-csf-addon
- Homepage: https://github.com/floroz/storybook-vue-csf-addon#readme
- Issues: https://github.com/floroz/storybook-vue-csf-addon/issues
- npm.io page: https://npm.io/package/storybook-vue-csf-addon

## Dependencies (1)

- [unplugin](https://npm.io/package/unplugin.md) ^1.4.0

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 0.0.1-beta.1 (latest) — 2023-09-13
- 0.0.1-beta.0 — 2023-09-13

## README

# `storybook-vue-csf-addon`

🚧 Work in progress 🚧

## Install

```bash
npm i -D storybook-vue-csf-addon
```

<details>
<summary>Vite</summary><br>

```ts
// vite.config.ts
import Starter from 'storybook-vue-csf-addon/vite'

export default defineConfig({
  plugins: [
    Starter({ /* options */ }),
  ],
})
```

Example: [`playground/`](./playground/)

<br></details>

<details>
<summary>Rollup</summary><br>

```ts
// rollup.config.js
import Starter from 'storybook-vue-csf-addon/rollup'

export default {
  plugins: [
    Starter({ /* options */ }),
  ],
}
```

<br></details>


<details>
<summary>Webpack</summary><br>

```ts
// webpack.config.js
module.exports = {
  /* ... */
  plugins: [
    require('storybook-vue-csf-addon/webpack')({ /* options */ })
  ]
}
```

<br></details>

<details>
<summary>Nuxt</summary><br>

```ts
// nuxt.config.js
export default defineNuxtConfig({
  modules: [
    ['storybook-vue-csf-addon/nuxt', { /* options */ }],
  ],
})
```

> This module works for both Nuxt 2 and [Nuxt Vite](https://github.com/nuxt/vite)

<br></details>

<details>
<summary>Vue CLI</summary><br>

```ts
// vue.config.js
module.exports = {
  configureWebpack: {
    plugins: [
      require('storybook-vue-csf-addon/webpack')({ /* options */ }),
    ],
  },
}
```

<br></details>

<details>
<summary>esbuild</summary><br>

```ts
// esbuild.config.js
import { build } from 'esbuild'
import Starter from 'storybook-vue-csf-addon/esbuild'

build({
  plugins: [Starter()],
})
```

<br></details>

---
_Source: https://npm.io/package/storybook-vue-csf-addon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._