Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/forge42dev/storyblok-generator
Generate Storyblok components out of your components.json file and get full type-safety and bundle splitting out of the box
https://github.com/forge42dev/storyblok-generator
Last synced: 5 days ago
JSON representation
Generate Storyblok components out of your components.json file and get full type-safety and bundle splitting out of the box
- Host: GitHub
- URL: https://github.com/forge42dev/storyblok-generator
- Owner: forge42dev
- License: mit
- Created: 2024-08-20T09:09:10.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-23T15:23:13.000Z (3 months ago)
- Last Synced: 2024-09-23T19:46:46.337Z (about 2 months ago)
- Language: TypeScript
- Size: 95.7 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.MD
Awesome Lists containing this project
README
# Storyblok Generator
Storyblok React component generator for Vite Storyblok apps (React/Remix.run).
- Pulls in your components from Storyblok and generates the types for you.
- Generates the components in either a file or folder structure.
- Makes all components editable via the bridge by default.
- Adds per component bundle splitting for better performance.
- Adds full typesafety to your components.
- Supports both kebab-case and camel-case file names.
- Adds shortcuts to regenerate the components and types.
## Setup
To get up and running quickly, you first install the vite plugin as a dev dependency in your project.
```bash
npm install -D storyblok-generator
```
Then, in your `vite.config.ts` file, add the following:
```typescript
import { storyblokPlugin } from "storyblok-generator"
export default defineConfig({
plugins: [
storyblokPlugin({
spaceId: "",
componentsDir: "./storyblok/components",
}),
],
})
```
## Usage
Once the plugin is installed and configured, it will generate the components and types for you. You can then import the components in your code and use them as you normally would.
```typescript
import { components } from "./storyblok/components";
import { storyblokInit, apiPlugin } from "@storyblok/react"
storyblokInit({
accessToken: "",
use: [apiPlugin],
// You pass in the components here, the components will be lazy loaded when actually used.
components,
})
```
### Storyblok CLI Caveats
The Plugin uses the Storyblok CLI to pull the components from your Storyblok space. This means that you need to have the CLI installed on your machine and available in your path.
You will also need to be logged in to the Storyblok CLI properly. You should login via SSO instead of
using the username and password combo as that keeps you logged in but after some time the login expires
and you need to login again by first logging out and logging in again.
## Configuration
The plugin accepts the following configuration options:
| Option | Type | Description | Default | Required |
| ----------------- | -------- | --------------- | ------- | -------- |
| spaceId | string | Your Storyblok space ID. | - | Yes |
| componentsDir | string | The directory where the components will be generated. | - | Yes |
| typeFileLoc | string | The location of the type file. | `./storyblok/types.d.ts` | No |
| pullCommand | string | The command to use to pull the components from Storyblok via the CLI | `storyblok pull-components --space --path ` | No |
| typesCommand | string | The command to use to generate the types for the components via the CLI | `storyblok generate-typescript-typedefs --sourceFilePaths --destinationFilePath ` | No |
| componentsJsonLoc | string | The location of the components JSON file. | `./storyblok/components..json` | No |
| fileNameConvention | string | The file name convention for the components. Can be either `kebab-case` or `camel-case`. | `kebab-case` | No |
| componentAs | string | The component structure. Can be either `file` or `folder`. | `file` | No |
| debug | boolean | Whether to enable debug mode. If enabled, the plugin will print additional information to the console. | `false` | No |
## Development
To develop this plugin, you can clone the repository and run the following commands:
```bash
npm install
npm run dev
```
This will build the plugin, install the dependencies, and start the development server.