garden.yaml

# Use "cargo install garden-tools" to install garden (https://gitlab.com/garden-rs/garden).
# Usage:
#   garden check
#   garden fmt
#
# Generate documentation
#   garden setup  # One-time setup
#   garden doc
trees:
  harpoon-term:
    description: Fork of the harpoon.term module from Harpoon v1
    path: ${GARDEN_CONFIG_DIR}
    url: git@gitlab.com:davvid/harpoon-term.nvim.git
    gitconfig:
      remote.publish.pushurl:
        - git@gitlab.com:davvid/harpoon-term.nvim.git
        - git@github.com:davvid/harpoon-term.nvim.git
    remotes:
      github: git@github.com:davvid/harpoon-term.nvim.git
    environment:
      PATH: ${GARDEN_CONFIG_DIR}/panvimdoc
    commands:
      check>:
        - check/lua
        - check/fmt
      check/fmt: garden ${GARDEN_CMD_VERBOSE} fmt -- --check "$@"
      check/lua: luacheck lua
      doc>:
        - doc/build
        - doc/post
      doc/build: |
        panvimdoc.sh \
          --description 'Quickly jump to terminals' \
          --input-file README.md \
          --project-name ${TREE_NAME} \
          --toc false
      doc/post: |
        sed -i -e 's/Generated by panvimdoc.*//' doc/${TREE_NAME}.txt
        nvim +'helptags doc | exit'
      fmt: stylua "$@" lua/*/*.lua
      setup: |
        garden ${GARDEN_CMD_VERBOSE} grow panvimdoc
        garden ${GARDEN_CMD_VERBOSE} deps panvimdoc

  panvimdoc:
    description: Generate vimdoc documentation from pandoc markdown
    url: https://github.com/kdheepak/panvimdoc.git
    commands:
      deps: sudo apt install pandoc