documentation/Taskfile.yaml at main · squiglink/documentation · 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
tasks:
  build:
    desc: Build the documentation.
    cmds:
      - docker compose run --rm documentation pnpm vitepress build

  check:
    desc: Check everything.
    cmds:
      - task: check-formatting
      - task: check-linting

  check-formatting:
    desc: Check formatting.
    cmds:
      - docker compose run --rm documentation pnpm oxfmt --check {{.CLI_ARGS}}

  check-linting:
    desc: Check linting.
    cmds:
      - docker compose run --rm documentation pnpm oxlint --deny-warnings

  fetch-openapi-specification:
    desc: Fetch the OpenAPI specification.
    cmds:
      - docker compose run --rm documentation sh -c "
        mkdir --parents .temporary &&
        rm -fr .temporary/server &&
        git clone --depth 1 https://github.com/squiglink/server.git .temporary/server &&
        cd .temporary/server &&
        pnpm install &&
        export \$(sed 's/#.*//' .env.example) &&
        pnpm exec tsx scripts/generate-openapi.ts &&
        mkdir --parents /documentation/public &&
        cp output/openapi.json /documentation/public/openapi.json &&
        cd /documentation &&
        rm -fr .temporary/server
        "

  fix-formatting:
    desc: Fix formatting.
    cmds:
      - docker compose run --rm documentation pnpm oxfmt --write {{.CLI_ARGS}}

  preview:
    desc: Preview the built documentation.
    cmds:
      - docker compose run --rm --service-ports documentation pnpm vitepress preview

  install-dependencies:
    desc: Install dependencies.
    cmds:
      - docker compose run --rm documentation pnpm install

  list:
    aliases:
      - default
    desc: List available tasks.
    cmds:
      - task --list

  setup:
    desc: Setup the application.
    cmds:
      - task: fetch-openapi-specification
      - task: install-dependencies

  start:
    desc: Start the application.
    cmds:
      - docker compose up

version: 3