Skip to content

Roadmap to Alpha #1

@Bechma

Description

@Bechma

Roadman to fulfill cyberfabric/cyberfabric-core#312 (comment)

The idea will be to create a CLI to handle the different use cases that a developer or a user can have. We will organize the main functionality into 5 groups:

  1. setup
  2. lint
  3. test
  4. run
  5. build

Each of the groups will have their corresponding CLI command with different functionality:

  • setup
    • tools install/update required tooling (by default checks in the environment what tools you miss or needs to be upgraded). Ideally each tool should be categorized (maybe someon
      • --upgrade upgrade your installed tools to the recommended version of the tool
      • --install install a comma separated tools
      • --install-yolo install all tools without asking feedback
      • --verbose add verbosity
    • template generate template for new repo
      • init PATH initialize the barebones for a new cyberfabric project
      • add MODULE generates a new module from a template (you could choose from a list)
    • config handles and validate the configuration file
  • lint
    • when you run it without any other params it will run clippy (which includes cargo check) + our custom dylint rules
    • --clippy to just run clippy with our custom set of lints
    • --dylint to just run our custom dylint rules
    • --pattern used only when dylint is provided, it will run a specific dylint rule from the set
  • test run all available tests
    • --e2e run only end to end tests
    • --module run tests for a given module
    • --coverage run with coverage
  • run fire up a hyperspot server with hot-module reload
    • -r in release mode
    • -c configuration to run the server
  • build
    • -r in release mode
    • -c configuration to run the server
  • deploy not planned for now

Metadata

Metadata

Assignees

Labels

enhancementNew feature or requesthelp wantedExtra attention is needed

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions