Civetman

Use Civet in any project.

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

• Usage
• How it works
• Examples
• Documentation

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.

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.

Several examples are available in the examples directory.

• Basic example
• Vanilla Extact example
• Solid component library example

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