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

@lorefnon/civetman

v0.0.8

Published

No more pain about civet!

Downloads

24

Readme

Civet not working? Bad integration with pure TypeScript files? No problem!

Table of Content

Usage

First install npm package civetman (e.g. pnpm add civetman). Then, add civetman dev to your dev or start script in package.json, add civetman build to your build script. Now you can use .civet files. All the imports don't need the suffix .civet anymore, meaning that .civet files are treated the same as TypeScript files.

How it works

When you run pnpm civetman build (the same as npx civetman build), Civetman will collect all the .civet files and build them into TypeScript with the Civet compiler. Then, Civetman will create a <name>.ts file beside each .civet file. That is why you can import Civet files just like TypeScript files, since they ARE literally just TypeScript files.

What? You can't see the .ts files generated? That's because Civetman automatically put all the generated .ts files into the files.exclude in the .vscode/settings.json file. Then VSCode will hide all the bundled files in the file explorer. Those files are also added to .gitignore so that they won't be included by Git.

civetman dev is basically just building your files when they are changed.

It's recommended to add civetman build to the postinstall script in your package.json.

Examples

Several examples are available in the examples directory.

Documentation

CLI documentation:

Usage: civetman [options] [command]

Use Civet in any projects!

Options:
    -V, --version     output the version number
    -x, --tsx, --jsx  Generate `.tsx` files instead of `.ts` files
    --noGit           Civetman without writing `.gitignore` file
    --noVscode        Civetman without writing `.vscode/settings.json` file
    -h, --help        display help for command

Commands:
    build             Start building Civet files
    dev               Start building Civet files in watch mode
    help [command]    display help for command