Never-ending Pumpkin Mulch

    storybook-addon-stencil
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.9 • Public • Published

    Storybook Addon Stencil

    A Stencil compiler integration for Storybook.

    Usage

    Install and register the addon in your Storybook:

    npm install storybook-addon-stencil -D
    yarn install storybook-addon-stencil -D
    

    .storybook/main.js

    module.exports = {
      "stories": [
        "../src/**/*.stories.mdx",
        "../src/**/*.stories.@(js|jsx|ts|tsx)"
      ],
      "addons": [
        "storybook-addon-stencil",
        ...
      ],
      "framework": "@storybook/web-components"
    }

    Development

    • yarn start runs babel in watch mode and starts Storybook
    • yarn build build and package your addon code

    Release Management

    Setup

    This project is configured to use auto for release management. It generates a changelog and pushes it to both GitHub and npm. Therefore, you need to configure access to both:

    • NPM_TOKEN Create a token with both Read and Publish permissions.
    • GH_TOKEN Create a token with the repo scope.

    Local

    To use auto locally create a .env file at the root of your project and add your tokens to it:

    GH_TOKEN=<value you just got from GitHub>
    NPM_TOKEN=<value you just got from npm>

    Lastly, create labels on GitHub. You’ll use these labels in the future when making changes to the package.

    npx auto create-labels

    If you check on GitHub, you’ll now see a set of labels that auto would like you to use. Use these to tag future pull requests.

    GitHub Actions

    This template comes with GitHub actions already set up to publish your addon anytime someone pushes to your repository.

    Go to Settings > Secrets, click New repository secret, and add your NPM_TOKEN.

    Creating a release

    To create a release locally you can run the following command, otherwise the GitHub action will make the release for you.

    yarn release

    That will:

    • Build and package the addon code
    • Bump the version
    • Push a release to GitHub and npm
    • Push a changelog to GitHub

    Install

    npm i storybook-addon-stencil

    DownloadsWeekly Downloads

    42

    Version

    0.1.9

    License

    MIT

    Unpacked Size

    71.9 kB

    Total Files

    26

    Last publish

    Collaborators

    • edocava
    • dariosacco