vecron

command module
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2025 License: GPL-3.0 Imports: 8 Imported by: 0

README

Vecron

A project manager aimed to help you create projects and manage them with ease

Requirements

  • go
  • fzf
  • git
  • gh (github-cli)
  • unix system Linux :) or mac :(

Installation

Download install.sh and run it. It is advised installation as it will make full configuration for you.

OR you can go hardcore mode and install and configure everything yourself which might require undestanding ALL elegant dog shit I've coded here. I really wish you luck and if you DO I would ask you to

  • listen to this on repeat this
  • reset next two variables hours spent until understood: 0h hours spent and given up: 0h

Configs

The idea is that configs are singleton instances, accessed via getConfig or getLocalConfig.

Is it a state machine? Nope. State machine is about changing function behaviour, depanding on the state. Configs only provide access to system data, to make function signatures cleaner and configs accessible in any point of code.

Global config

Config stored in system. tree $VecronHome: (paths are given as they would be in linux)

.
├── config.json
│   ├── VecronHome    ($HOME/.config/vecron)
│   ├── DevPath       (Path to dir where you store your projects default: $HOME/Dev)
│   ├── DefaultEditor (Your default editor, default: VSCode)
│   └── Projects	  (Path to ALL your projects that you have opened with vecron at least ones)
├── templates         (Default can be edited)
│   ├── cpp
│   ├── java
│   └── go
└── licences          (Default can be edited)
    ├── MIT
    └── GPL v3.0

Local Config

Config created for every project and stored

.vecron
├── config.json
│   ├── DefaultEditor (Default editor for current project, default: VSCode)
│   ├── ProjectPath 
│   ├── DefaultEditor
│   ├── Build
│   ├── BuildReleaseCmd
│   ├── BuildDebugCmd
│	├── SubProjects	  (List of "sub"-projects e.g Microservice application)
│   └── RunCmd
└── db.json
	└── All {{vecron variables}} that are present in your project.

You should fill variables values in db.json and run vecron format for vecron to fill those placeholders and scan for new variables. If you want the warning about empty placeholder to disappear please set it to --skip, or run vecron format --skip={vars comma-separated} or vecron format --{var_name}="--skip"

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL