openlane-docs/Taskfile.yaml at main · theopenlane/openlane-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
version: '3'

tasks:
  default:
    silent: true
    cmds:
      - task --list

  install:
    desc: Setup the project dependencies
    cmds:
      - task: brew-install
      - task: bun-install
      - task: build
      - task: precommit

  build:
    dir: docs
    desc: build all apps and package
    cmd: bun run build

  bun-install:
    dir: docs
    desc: install the dependencies listed in package.json
    cmds:
      - bun install

  bun-reinstall:
    dir: docs
    desc: reinstall the dependencies listed in package.json
    cmds:
      - task: clean
      - task: bun-install

  clean:
    dir: docs
    desc: clean all apps and package
    cmd: bun run clean

  generate-api-docs:
    dir: docs
    desc: refresh the OpenAPI spec and Scalar renderer served at /api-reference
    cmd: bash scripts/api-reference-assets.sh

  generate-glossary-data:
    dir: docs
    desc: regenerate the glossary tooltip data from the glossary page
    cmd: node scripts/glossary-data.mjs

  generate:
    dir: docs
    desc: generate all docs
    cmds:
      - task: generate-api-docs
      - task: generate-glossary-data

  dev:
    dir: docs
    desc: develop all apps
    cmds:
      - bun dev

  precommit-full:
    desc: Lint the project against all files
    aliases: [precommit]
    cmds:
      - pre-commit install && pre-commit install-hooks
      - pre-commit autoupdate
      - pre-commit run --show-diff-on-failure --color=always --all-files

  brew-install:
    desc: Install workstation dependencies with Brew
    cmds:
      - task: update-brew
      - echo "Installing {{.DEPS}} via homebrew..."
      - brew install {{.DEPS}} {{.CLI_ARGS}}
      - echo "Installed {{.DEPS}} via homebrew!"
    deps:
      - task: brew-installed
    status:
      - '[ -f $(brew --prefix)/bin/{{.DEPS}} ]'
    vars:
      DEPS: >-
        oven-sh/bun/bun pre-commit #magic___^_^___line
  brew-installed:
    silent: true
    desc: check if Homebrew is installed
    cmds:
      - '[ -x "$(command -v brew)" ] || (echo "Homebrew is not installed, please install it from https://brew.sh" && exit 1)'

  update-brew:
    desc: Update Homebrew and upgrade all packages
    cmds:
      - brew update && brew upgrade && brew cleanup || true