gkmngrgn / dosh-core Goto Github PK

Shell-independent task manager.

License: MIT License

Python 100.00%

dosh-core's Introduction

HELLO 👋

I'm GoeDev, living in Berlin, but sometimes I visit Ankara. I'm working as a Software Engineer at Mimi and coding in hearing technologies.

If you like my projects, you can support and motivate me. Sometimes I plan to open LiveCoding streams on Twitch. It depends on you.

dosh-core's People

Contributors

Stargazers

Watchers

Forkers

radity

dosh-core's Issues

Add `envs` parameter to `add_task` to restrict the use of task.

`UnicodeDecodeError` in `run` command

$ dosh deploy
DOSH => [RUN] hugo
DOSH => [RUN] rsync -avz --delete public/ [email protected]:/var/www/html/gokmengorgen.net/
Traceback (most recent call last):
  File "app.py", line 12, in <module>
  File "app.py", line 8, in main
  File "dosh/cli.py", line 92, in run
  File "dosh/config.py", line 70, in run_task
  File "lupa/_lupa.pyx", line 587, in lupa._lupa._LuaObject.__call__
  File "lupa/_lupa.pyx", line 1333, in lupa._lupa.call_lua
  File "lupa/_lupa.pyx", line 1358, in lupa._lupa.execute_lua_call
  File "lupa/_lupa.pyx", line 281, in lupa._lupa.LuaRuntime.reraise_on_exception
  File "lupa/_lupa.pyx", line 1496, in lupa._lupa.py_call_with_gil
  File "lupa/_lupa.pyx", line 1483, in lupa._lupa.call_python
  File "dosh/commands/external.py", line 116, in run
UnicodeDecodeError: 'utf-8' codec can't decode byte 0xc5 in position 11: invalid continuation byte
[64981] Failed to execute script 'app' due to unhandled exception!

Task Options

I want to know if a task accepts an option. In the help output, I should see all available options with the type, choices, and the default value.

dosh - shell-independent task manager

Tasks:
  > setup SETUP_TYPE     setup my operating system.
                         setup_type: all, emacs, python, shell, tmux (default: all)

Dosh commands:
  > help                 print this output
  > init                 initialize a new config in current working directory

  -c, --config PATH      specify config path (default: dosh.lua)
  -d, --directory PATH   change the working directory
  -v|vv|vvv, --verbose   increase the verbosity of messages:
                         1 - default, 2 - detailed, 3 - debug

An idea for config:

cmd.add_task {
    name = "setup",
    description = "setup my operating system.",
    required_platforms = {"macos"},
    command_options = {
        setup_type = {
            type = "string",
            options = {"all", "emacs", "python", "shell", "tmux"},
            default = "all"
        }
    },
    command = function(options)
        print(options)
    end
}

Create a sample `dosh.star` config file if the client runs `dosh init`.

Add pre-description and post-description for help output.

My planned help output is like this one:

$ dosh help

dosh 0.1.0
shell-independent command manager

Tasks:
  > setup_my_os        place my config files.
  > install_cli_apps   install my favorite apps.
  > sync_repos         do not forget to push your changes before working on a different
                       laptop.
                       - repo_path: str, optional

If you are new to dosh, consider running `dosh --help` to learn using dosh.

This help output has three parts:

the first part includes the app name, version, description, etc.
tasks that show the available subcommand and its parameters.
the last line is about the --help parameter.

I want to allow the clients to edit the first and the last parts.

add new command `workdir`

to change the current working directory.

A new general parameter: `-d` & `--directory`

As in --config parameter, I want to change the current working directory using --directory parameter. It will be very helpful to run tests without installing dosh.

Compare DOSH with CMake and Makefile or NMAKE.

Add a new subtitle to explain the differences between dosh and the other apps like cmake, makefile, etc.

`dosh help` should be informative even there's no `dosh.lua` file yet.

Currently, it's just saying that the required config file doesn't exist.

How could we rewrite this bash code in dosh?

for repo in $(curl -X GET "https://gitea.server/api/v1/repos/search?uid=goedev&limit=10000" \
                   -H "accept: application/json" \
                   -H "Authorization: token very-very-secret-token" \
                   -H "Content-Type: application/json" \
                   -s | jq -c ".data[] | {ssh_url,name}"); do
    ssh_url=$(echo $repo | jq -r ".ssh_url")
    name=$(echo $repo | jq -r ".name")
    repo_dir="$HOME/Workspace/goedev/$name"

    if [ -d $repo_dir ]; then
        echo "Repo $name is syncing..."
        git -C $repo_dir pull
    else
        echo "Repo $name is cloning..."
        git clone $ssh_url $repo_dir
    fi
    echo ""
done

A new external command for getting list of directories or files.

Sample use here:

local config_dirs = cmd.ls{
    parent_dir = ".",
    exclude = { "home", "archived" },
    file_types = { "directory" },
}

A new parameter for `cmd.task`: `required_platforms`

Sync local folder with remote folder or vice-versa.

I've a command to sync my changes in my website with the server:

cmd.run("rsync -avz --delete public/ user@domain:/var/www/html/domain/")

But this command doesn't work if you don't have rsync. So, we need a native Python function to sync folders.

new command: `cmd.run_task`

There should be a function to run the other tasks.

Acceptance Criteria

check if there's a task with the specified name.
don't allow to run the task inside the same task.

Add color and font weight support for `dosh help` output.

Create the first release: v0.1.0

Add changelog file.
GitHub Actions should add the executable files to release page automatically.
Support Linux and MacOS first, then Windows.
Install pytest-coverage for reporting coverage.

Add verbosity option for dosh.

Instead of using print, we support four levels of logging:

debug
info
warning
error

Currently, dosh doesn't show any output. The default level should be info.

Handle `KeyboardInterrupt` when a task interrupted with `ctrl-c` / `ctrl-z`

$ DOSH_ENV="dev" dosh dev
DOSH => [RUN] hugo server -D --bind 0.0.0.0 -b mydomain
^CTraceback (most recent call last):
  File "app.py", line 12, in <module>
  File "app.py", line 8, in main
  File "dosh/cli.py", line 92, in run
  File "dosh/config.py", line 70, in run_task
  File "lupa/_lupa.pyx", line 587, in lupa._lupa._LuaObject.__call__
  File "lupa/_lupa.pyx", line 1333, in lupa._lupa.call_lua
  File "lupa/_lupa.pyx", line 1358, in lupa._lupa.execute_lua_call
  File "lupa/_lupa.pyx", line 281, in lupa._lupa.LuaRuntime.reraise_on_exception
  File "lupa/_lupa.pyx", line 1496, in lupa._lupa.py_call_with_gil
  File "lupa/_lupa.pyx", line 1483, in lupa._lupa.call_python
  File "dosh/commands/external.py", line 112, in run
KeyboardInterrupt
[64905] Failed to execute script 'app' due to unhandled exception!

new command: `run_dosh`

Sometimes I want to run a separate dosh config from another one. This can be in my file path or in a public url.

cmd.run_dosh(
    "https://raw.githubusercontent.com/gkmngrgn/emacs.d/main/dosh.lua",
    {task = "install", parameters = "--noconfirm"}
)

Additionally it may be a good idea to rename run_url command with run_bash or something else.