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

sirocco-wc

v1.1.25

Published

Scaffolding Tool for the fusion of lit with tailwind. DRY development in the speed of light with the zero configuration build tool parcel, playwright and jest testing. jenkinsCI ready.

Downloads

3,323

Readme

Scaffolding Tool for the fusion of lit with tailwind.

DRY development in the speed of light with the zero configuration build tool parcel, playwright, and jest testing. Jenkins plugin ready

This tool helps you to develop with lit, tailwind, playwright, and parcel. It provides not only scaffolding but as well the infrastructure to generate component-specific style definitions. Further, our defaults are ready for being used in a Jenkins plugin.

Why the name?

I was looking for a word that unifies tailwind with lit. A Mediterranean wind that comes from the Sahara and reaches hurricane speeds in North Africa and Southern Europe, is the definition of sirocco and since I wrote it based in Sevilla, I found it fitting. 😁

Sirocco wind

Install

npm i -g sirocco-wc

You should install the tool globally so you can use it to generate node based projects with the init command.

Customize

You can set different environments variable to change the default configuration of this tool, which you can find in bin/config.js:

const defaultComponentType = process.env.SWC_TYPE || 'components';
const prefix = process.env.SWC_PREFIX || 'swc-';
const index = process.env.SWC_INDEX || 'index.ts';
const srcDir = process.env.SWC_SRC || `src/main/ts`
const cssDir = process.env.SWC_CSS || `${srcDir}\/\*\*\/\*.css`

Commands available

Version

sirocco-wc --version

help

sirocco-wc help
COMMANDS — Type 'sirocco-wc help <command>' to get some help about a command

init - Scaffolding your project

sirocco-wc ["init" || "i"]

Scaffolding your project to add the infrastructure needed to develop as described in the README of the template.

This structure allows to quickly develop with lit and tailwind. Further our defaults are ready for being used in a jenkins plugin. It will further direcly migrate to yarn 2 and install some recommended plugins.

...but wait there is still more to the template:

  • yarn2 based
  • typescript based
  • playwright testing integration
  • jest testing integration
  • parcel zero config based compilation and optimisation integration.
  • prettier, lint and husky integration ready
  • npm publish ready

add - Create a new component

.option("-t, --type ", "Component Type", { default: defaultComponentType, })

sirocco-wc ["add"||"a"] newcomponent [-t componentType || 'components']

This will create a new component (or the componentType you have chosen) and link it in the project hierarchy.

For example if you want to create a new view you can do:

sirocco-wc add myview -t views

buildCss - Building style.ts files

sirocco-wc ["buildCss"||"bc"]

Will generate style definitions so they can be imported into your web components. The files are optimized to only include some general tailwind plugins and the classes you may defined in your css or template.

watchCss - Watch changes and rebuild

sirocco-wc ["watchCss"||"wc"]

Will watch css and ts files and invoke the rebuild in case they have changed.

Usage sample

In case you have not yet a node based project installed, you can use the init command, however, be aware that it will override existing files.

mkdir test
cd test
sirocco-wc i

After this you will need to create a first component and then the entry file that you have defined in the init command. You can use yarn :add test to use the prefix that you have choosen in the init command.

sirocco-wc a test
echo "export * from './components/index';" > src/main/ts/index.ts

The last step is to update the index.html that was generated earlier to use your first web component.

  <body>
    <swc-test></swc-test>
  </body>

Once you have the basic structure set up, you can either use the project commands or the sirocco-wc once.

First, you need to run the local dev server.

yarn start

Sample use in package.json

"css:build": "sirocco-wc bc",
"css:watch": "sirocco-wc wc",
":add": "SWC_PREFIX=my-sirocco- sirocco-wc a"