13.5.3 • Published 11 months ago

virmator v13.5.3

Weekly downloads
-
License
(MIT or CC0 1.0)
Repository
github
Last release
11 months ago

virmator

A package for centralizing and automating mind-numbingly repetitive repo tasks and checks. New commands can easily be added through a plugin system.

Note that as of v13, this package is now in ESM.

virmator usage

[npx] virmator [--flags] command subCommand [...optional args]

  • npx is needed when the command is run directly from the terminal (not called from within an npm script) unless virmator has been globally installed (which I recommend against).
  • [--flags] is any of the optional virmator flags. See Virmator Flags below.
  • command, subCommand, and [...optional args] depend on the specific command you're running. See Available Commands below.

Available commands

  • compile

    Type checks TypeScript files and compiles them into JS outputs using the TypeScript compiler. Any extra args are passed directly to tsc.

    Automatically compiles a mono-repo's sub packages in the correct order if called from a mono-repo root.

    • Examples
      • virmator compile
      • With tsc flags: virmator compile --noEmit
    • Configs
      • tsconfig.json
      • tsconfig.json
      • configs/tsconfig.base.json
    • Deps
  • deps

    Various dependency commands. A sub-command must be provided.

    • Examples
      • check import dependencies: virmator deps check
      • upgrade npm dependencies: virmator deps upgrade
      • regenerate npm dependencies: virmator deps regen
    • Sub Commands

      • check

        Checks that import dependencies pass your dependency cruiser config. The base configuration blocks typical import errors such as circular dependencies and importing test files.

      • upgrade

        Upgrades dependencies using npm-check-update. Does not automatically run 'npm i'. It is recommended to run 'virmator deps regen' instead.

      • regen

        Force regeneration of all all dependencies by deleting all node_modules directories and package-lock.json and then running 'npm i'.

        • Examples
          • virmator deps regen
  • docs

    Generates documentation using the typedoc package and inserts code examples into README files using the markdown-code-example-inserter package.

    • Examples
      • virmator docs
    • Configs
      • configs/typedoc.config.ts
    • Deps
    • Sub Commands

      • check

        Checks that documentation is valid and passes all checks without generating documentation outputs.

        • Examples
          • virmator docs check
  • format

    Formats with prettier.

  • frontend

    Runs a frontend dev server with Vite.

    • Examples
      • virmator frontend
    • Configs
      • configs/vite.config.ts
    • Deps
    • Sub Commands

      • build

        Builds a frontend for deployment using Vite (and Rollup).

        • Examples
          • virmator frontend build
      • preview

        Builds a frontend and previews that build in a local dev server.

        • Examples
          • virmator frontend preview
  • help

    Prints help messages for all supported plugins/commands.

    • Examples
      • virmator help
  • init

    Init all default configs. Needs env and package type args.

    • Examples
      • virmator init web mono-repo
      • virmator init node package
    • Configs
      • .github/workflows/build-for-gh-pages.yml
      • .github/workflows/tagged-release.yml
      • .github/workflows/tests.yml
      • .github/workflows/tests.yml
      • .vscode/settings.json
      • src/ui/elements/vir-app.element.ts
      • src/index.html
      • www-static/index.css
      • www-static/_redirects
      • .gitattributes
      • .nvmrc
      • .gitignore
      • LICENSE-MIT
      • LICENSE-CC0
      • .npmignore
      • package.json
      • package.json
      • package.json
      • package.json
      • package.json
  • lint

    Runs ESLint.

  • publish

    Publish a package or mono-repo to NPM with an optional test script and auto-incrementing package version.

    • Examples
      • With tests: virmator publish npm test
      • Without tests: virmator publish
  • spellcheck

    Checks spelling for all files using the cspell package. All arguments are passed directly to cspell.

    • Examples
      • virmator spellcheck
      • Check a specific file: virmator spellcheck src/index.ts
    • Configs
      • cspell.config.cjs
    • Deps
  • test

    Runs tests. An environment is required.

    This cannot be run in a mono-repo root, it can only be run for mono-repo sub-packages or a top-level singular package.

Virmator Flags

All virmator flags are optional and typically not needed.

  • --no-configs: Prevents command config files from being copied.
  • --no-deps: Prevents command npm deps from being installed.
  • --help: Print the help message.
13.5.3

11 months ago

13.3.9

1 year ago

13.3.7

1 year ago

13.3.8

1 year ago

13.3.5

1 year ago

13.3.6

1 year ago

13.3.4

1 year ago

13.3.11

1 year ago

13.3.10

1 year ago

13.3.15

1 year ago

13.3.14

1 year ago

13.3.13

1 year ago

13.3.12

1 year ago

13.4.0

1 year ago

13.4.1

1 year ago

13.5.1

12 months ago

13.5.2

12 months ago

13.5.0

12 months ago

13.3.3

1 year ago

13.3.1

1 year ago

13.3.2

1 year ago

13.3.0

1 year ago

13.1.1

1 year ago

13.1.0

1 year ago

13.2.8

1 year ago

13.2.9

1 year ago

13.2.6

1 year ago

13.2.7

1 year ago

13.2.4

1 year ago

13.2.5

1 year ago

13.2.2

1 year ago

13.2.3

1 year ago

13.2.0

1 year ago

13.2.1

1 year ago

12.0.3

1 year ago

12.0.4

1 year ago

12.0.0

1 year ago

12.0.1

1 year ago

12.0.2

1 year ago

13.0.4

1 year ago

13.0.5

1 year ago

13.0.2

1 year ago

13.0.3

1 year ago

13.0.1

1 year ago

13.2.10

1 year ago

11.5.1

2 years ago

11.5.2

2 years ago

11.5.0

2 years ago

11.4.0

2 years ago

11.3.3

2 years ago

11.3.4

2 years ago

11.3.2

2 years ago

11.3.1

2 years ago

11.3.0

2 years ago

11.2.0

2 years ago

11.1.5

2 years ago

10.0.0

2 years ago

9.1.3

2 years ago

9.1.2

2 years ago

11.1.3

2 years ago

11.1.4

2 years ago

11.1.1

2 years ago

11.1.2

2 years ago

11.1.0

2 years ago

11.0.0

2 years ago

7.3.1

2 years ago

7.3.0

2 years ago

7.4.1

2 years ago

6.6.1

2 years ago

6.6.0

2 years ago

6.6.3

2 years ago

6.6.2

2 years ago

6.6.5

2 years ago

6.6.4

2 years ago

6.6.6

2 years ago

7.0.0

2 years ago

7.4.0

2 years ago

7.0.3

2 years ago

7.0.2

2 years ago

7.0.1

2 years ago

6.7.0

2 years ago

6.7.1

2 years ago

9.0.2

2 years ago

9.0.1

2 years ago

9.0.0

2 years ago

8.0.5

2 years ago

8.0.4

2 years ago

7.1.0

2 years ago

7.2.5

2 years ago

7.2.4

2 years ago

7.2.3

2 years ago

9.1.1

2 years ago

9.1.0

2 years ago

7.2.2

2 years ago

7.2.1

2 years ago

7.2.0

2 years ago

7.3.2

2 years ago

8.0.1

2 years ago

8.0.0

2 years ago

8.0.3

2 years ago

8.0.2

2 years ago

5.3.3

3 years ago

6.1.0

3 years ago

6.1.1

3 years ago

6.5.0

2 years ago

5.4.1

3 years ago

5.4.0

3 years ago

6.2.1

3 years ago

6.2.0

3 years ago

6.2.3

2 years ago

6.2.2

3 years ago

6.3.4

2 years ago

6.3.3

2 years ago

5.5.0

3 years ago

6.3.0

2 years ago

6.3.2

2 years ago

6.3.1

2 years ago

6.4.3

2 years ago

6.4.2

2 years ago

6.4.4

2 years ago

5.6.0

3 years ago

6.0.1

3 years ago

6.0.0

3 years ago

6.0.2

3 years ago

6.4.1

2 years ago

6.4.0

2 years ago

6.5.2

2 years ago

6.5.1

2 years ago

5.3.2

3 years ago

5.3.1

3 years ago

5.3.0

3 years ago

4.0.3

3 years ago

5.0.8

3 years ago

5.0.7

3 years ago

5.0.6

3 years ago

5.0.5

3 years ago

5.0.4

3 years ago

5.0.3

3 years ago

5.0.2

3 years ago

5.0.1

3 years ago

5.0.0

3 years ago

4.3.2

3 years ago

4.3.1

3 years ago

4.2.10

3 years ago

4.3.4

3 years ago

4.2.11

3 years ago

4.3.3

3 years ago

4.2.12

3 years ago

4.3.0

3 years ago

4.2.17

3 years ago

4.2.18

3 years ago

4.2.13

3 years ago

4.2.14

3 years ago

4.2.15

3 years ago

4.2.16

3 years ago

5.2.12

3 years ago

5.2.11

3 years ago

5.2.10

3 years ago

4.2.3

3 years ago

4.2.2

3 years ago

4.2.5

3 years ago

4.2.4

3 years ago

4.2.1

3 years ago

4.2.0

3 years ago

5.2.9

3 years ago

5.2.8

3 years ago

5.2.7

3 years ago

5.2.6

3 years ago

5.2.5

3 years ago

5.2.4

3 years ago

5.2.3

3 years ago

5.2.2

3 years ago

5.2.1

3 years ago

5.2.0

3 years ago

4.2.7

3 years ago

4.2.6

3 years ago

4.2.9

3 years ago

4.1.0

3 years ago

1.4.6

3 years ago

4.0.1

3 years ago

4.0.0

3 years ago

4.0.2

3 years ago

3.0.4

3 years ago

3.0.3

3 years ago

3.0.2

3 years ago

3.0.1

3 years ago

3.0.6

3 years ago

3.0.5

3 years ago

3.0.0

3 years ago

2.0.7

3 years ago

2.0.6

3 years ago

1.4.5

4 years ago

2.0.3

4 years ago

2.0.2

4 years ago

2.0.5

3 years ago

2.0.4

3 years ago

2.0.1

4 years ago

2.0.0

4 years ago

1.4.4

4 years ago

1.4.3

4 years ago

1.4.2

4 years ago

1.4.1

4 years ago

1.4.0

4 years ago

1.3.8

4 years ago

1.2.0

4 years ago

1.3.7

4 years ago

1.3.6

4 years ago

1.3.5

4 years ago

1.3.4

4 years ago

1.3.3

4 years ago

1.3.2

4 years ago

1.3.1

4 years ago

1.3.0

4 years ago

1.1.15

4 years ago

1.1.14

4 years ago

1.1.13

4 years ago

1.1.12

4 years ago

1.1.11

4 years ago

1.1.9

4 years ago

1.1.8

4 years ago

1.1.10

4 years ago

1.1.7

4 years ago

1.1.6

4 years ago

1.1.5

4 years ago

1.1.4

4 years ago

1.1.3

4 years ago

1.1.1

4 years ago

1.1.0

4 years ago

1.0.6

4 years ago

1.1.2

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

0.0.8

4 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.5

4 years ago

0.0.4

4 years ago

0.0.3

4 years ago

0.0.2

4 years ago

0.0.1

4 years ago