chacas0 / tempest Goto Github PK

Try to generate man documentation, it should possible via viper or cobra.
If it's not out for the first beta version it's fine. 🙈 ❄️

Write unit tests

For cmd package:

• add.go
• get.go
• init.go
• list.go
• rm.go
• set.go
• start.go
• purge.go
• update.go
• version.go
• doc.go
• root.go

This might even get followed by a new command like tempest debug or something to see what's wrong. In that case a new issue or task will be created.

• Handle default config file tempest.yaml in tempest init
• Update README.md

In short

The tempest rm is a nice command but not so convenient to use. It just needs some enhancement.

Examples

We should be able to remove targets from the TEMPest list with a command like tempest rm -i 0-2 or tempest rm -i 0 3 or tempest -p /path1 /path2

In depth

So the 0-2 would remove all targets from 0 to 2 from TEMPest list.
0 3 would remove targets with index 0 and 3.
Should be able to do the same with the full path name.

In addition

Update and/or create documentation about that
➕ Use this opportunity to finish the --origin flag 😜

TODOs

• add the thing
• write the code ofc
• write doc
• udpate tests
• update rm tutorial (gh-pages)
• same for --origin

📝

• README.md
• commands/flags helpers
• wiki
• https://chacas0.github.io/tempest/

Running tempest version or tempest -v... generates an error (see below):

• tempest always uses and prints that it is using default config file at [...].
• tempest doesn't set corroctly the duration via the set command anymore

It currently show values only in KBytes, maybe it would be nice to adapt the unit according to the size

Presentation

Maybe by running tempest init, set an "automatic mode" "on" and stored in .tempest.yaml.

Thus, it would be possible to set it "on" or "off" with a flag from the command tempest set

"Automatic mode"

By automatic mode I mean that TEMPest would be run automatically, at start up for example.

TODOs

• deactivate default test mode on the automode

Keep them up to date:

• helpers in README.md
• index/menu in README.md
• helpers in code

• Pricing & Setup:
  https://github.com/marketplace/travis-ci/plan/MDIyOk1hcmtldHBsYWNlTGlzdGluZ1BsYW43MA==#pricing-and-setup
• Documentation - Getting started:
  https://docs.travis-ci.com/user/getting-started/

Intro

Add a way to back up configurations stuff, including .tempestcf and ,tempest.yaml.

❔ Maybe using github? 😑
❔ Maybe move the two config files into a config folder like ~/.tempest/.tempestcf and ~/.tempest/.tempest.yaml

👉 Edit it or add comment to add some details

TODO

Suggestion

The only "targets" of TEMPest for now, are directories... We can do more!
TEMPest should be able to "empty" temporary files pointed as "targets".

TODOs

• add the working command(s) required for this to work
• write the doc ( README.md + help flags )
• unit tests
• runtime test
• gh-pages

Allow people to install TEMPest from AUR ! 😋

< edit the list as bad error handling will be found >

TODO List

• example

It turns something of the form:

{
    duration: W
}

into:

duration: X

Thus, the param duration is no more understood by TEMPest!

In short

When adding one or many paths to TEMPest, some might change or get deleted.

Details

A way to fix that would be to add a sub command or something, like :
tempest list fix
or
tempest list --fix

In depth

This command would check if every command still exist, if it doesn't, do something.
"Something" being deleting the path from TEMPest or asking the user to enter the new path for this one.
The new path would replace the old one in .tempestcf

In addition

Of course write some documentation and maybe complete README.md.

TODOs

• add the thing
• write the code ofc
• write doc
• write tests

Intro

Develop a tutorial to show how to simply use TEMPest.

TODOs

• Add a new target
• Add many targets
• List targets
• Remove a target
• Configuration
• Init
• start
• test mode
• help

Add if find more important stuff to show

• make.sh
• different path variables
• different hard paths
• run tests

tempest set -a 4 for example deletes the config auto-mode, use merge or something instead?

Yup...

Should print informative stuff and doesn't alway (see below):

Use an iFrame for asciinema instead of a URL on an image!!

Running tempest update generates an error (see below):

Globally

Look for all temp.est directories of the system and add them to the targets list of TEMPest if they are not already there.

Usage

Should be something like:

> tempest add --auto

Then maybe display a little warning message about the time it would take and to confirm ?
At the end, shows what targets were added.

TODOs

• Actual code that would search those directories.
• Tests for the research.
• Code to add the matching directories
• Tests for the add.

Test if go get or if there is more to do, if so do it.
👉 Then update README.md ( #3 )

Gloablly

The ability to generate a new target in the current directory or in a specified one. This "new target" would be added automatically in the targets list of TEMPest and would already have the typed name referred in #31 like temp.est or whatever will be used there.

Usage

• A new target in the current directory:

> tempest new

• A new target in the /temp directory:

> tempest new /temp

TODOs

• Actual code for the current directory
• Tests for the current directory functionnality
• Code for the named directory
• Tests for the named directory functionnality