@compas/cli

@compas/cli

---

CLI to help with your local development environment, testing and more. Take a look at the documentation.

Reference

For the full reference, view the documentation. Below is the short reference, generated via compas help.

Usage: compas COMMAND

The Compas CLI

Unified backend tooling.

Examples:
- compas docker up
- compas lint --jsdoc
- compas visualise erd --generated-directory ./src/generated

References:
- Docs: https://compasjs.com
- Source: https://github.com/compasjs/compas
- Issues: https://github.com/compasjs/compas/issues


Commands:
  check-env          Various checks helping with a better Compas experience.
  code-mod           Execute code-mods to help migrating to new Compas versions.
  completions        Configure shell auto-complete for this CLI.
  docker             Manage common docker components.
  help               Display help for any of the available commands.
  init               Init various files in the current project.
  lint               Lint all project files.
  migrate            Run PostgreSQL migrations via the @compas/store migration system.
  run                Run arbitrary JavaScript files, scripts defined in the package.json and scripts located in the scripts directory.
  test               Run all tests in your project.
  version            Print the installed Compas version and exit
  visualise          Visualise various code-generated structures.
  watch              Run the command, restarting it when file changes happen.

Flags:
  -h, --help     Display information about the current command. (boolean)

Run 'compas help COMMAND' for more information of a specific sub command.

Changelog

v0.5.3

Features

• feat(cli): expose the test name via t.name in the test runner 900de5
• feat(cli): pad the 'threadId' in test runner logs to align when a high number of workers / randomize rounds are used 024813
• feat(cli): add t.jobs to configure concurrent subtests 3d0b9e
• feat(cli): add support for .mjs and .cjs scripts in compas run 9632d8

Bug fixes

• fix(code-gen): correctly import & export dateOnly & timeOnly via OpenAPI 62f4d9
• fix(store): change error log to info log when trying to transform an already removed file f8c6ff

Other

• chore(prettier): ignore dist directories d9967a
• chore(cli): refactor internal config of compas test d937d1

Dependency updates

• build(deps): bump eslint-plugin-jsdoc from 45.0.0 to 46.2.6 (#2643)
  • Major version bump; enables the jsdoc/no-defaults rule by default.
  • Release notes
• build(deps): bump @babel/eslint-parser from 7.21.8 to 7.22.5 (#2645)
  • Release notes
• build(deps): bump @babel/core from 7.22.1 to 7.22.5 (#2646)
  • Release notes
• build(deps): bump c8 from 7.14.0 to 8.0.0 (#2659)
  • Major version bump
  • Release notes
• build(deps): bump eslint from 8.42.0 to 8.43.0 (#2664)
  • Release notes
• build(deps): bump @aws-sdk/client-s3 from 3.347.1 to 3.354.0 (#2665)
  • Release notes
• build(deps): bump @aws-sdk/lib-storage from 3.347.1 to 3.354.0 (#2669)
  • Release notes