npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@atelier-wb/vite-plugin-atelier

v0.12.0-beta.4

Published

Helps you buildind Component Driven UIs with Atelier and Vite

Downloads

66

Readme

Atelier - Vite Plugin

Weclome to the Atelier!

This Vite plugin launches atelier as part of your dev server.

It can also export your entire atelier as a static website.



Getting started

You'll need first to write some "tools" files for your UI components.

Please refer to your UI framework binding API:

Then, assuming you already installed vite and configured it,

  1. install the plugin for Vite and your UI framework bindings,

    npm i -D @atelier-wb/vite-plugin-atelier @atelier-wb/[your-ui-framework]
  2. register the plugin in vite.config.js file:

    // other vite plugins
    import atelier from '@atelier-wb/vite-plugin-atelier'
    
    export default defineConfig({
      plugins: [/* other plugins */ atelier({ framework: 'your-ui-framework' })]
    })
  3. start vite in dev mode:

    npx vite
  4. then browse your components on http://localhost:3000/atelier.

To export your atelier, run Vite build command with export-atelier mode:

vite build --mode export-atelier

Configuration API

The atelier plugin function takes the following settings:

  • framework (detaults to svelte): your UI framework of choice. To this day, only Svelte is supported.
  • url (detaults to /atelier/): the url root under which Atelier's UI will be available. Must have leading and trailing /.
  • path (defaults to ./atelier): the path to the top level folder containing your *.tools.* files. It could be either absolute, or relative to your vite configuration file.
  • toolRegexp (defaults to /\.tools(?!\.shot$).+$/, any files endinf with .tools. but .tools.shot): the regular expression used to find your tool files.
  • outDir (defaults to ./dist-atelier): path to the folder which will contain the static export of your atelier.
  • setupPath: optional path to a file imported prior to any of your tool files. It can be absolute, from node_modules, or relative to path.
  • publicDir: optional path, or list of paths, to folders containing static assets your tools may use.

For example:

atelier({
  framework: 'svelte',
  url: '/atelier/',
  toolRegexp: '\\.tools\\.svelte$',
  path: './tests', // cwd()/tests/**/*.tools.svelte
  setupPath: './atelier-setup.js' // cwd()/tests/atelier-setup.js
})