hydrogen/dev.yml at main · J8118/hydrogen · 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
95
96
97
98
99
100
101
name: hydrogen
display_name: Hydrogen

up:
  - node:
      version: v24.13.0 # .nvmrc uses 'v24' for nvm flexibility; dev tool needs specific version
      package_manager: pnpm@10.16.1
  - packages:
      - ejson
  # The build runs as met? (not meet) so dev-up re-verifies by re-running it.
  # TURBO_FORCE bypasses turbo's shared worktree cache, which can serve
  # corrupted entries that replay logs without restoring output files.
  - custom:
      name: Build packages
      met?: TURBO_FORCE=true pnpm run build
      meet: 'true'

# So the Shopify CLI loads the local @shopify/cli-hydrogen plugin when running
# commands (e.g. skeleton dev → shopify hydrogen dev) instead of the bundled one.
env:
  SHOPIFY_CLI_ENV: development

commands:
  server:
    desc: 'Run the skeleton template dev server'
    run: pnpm run build && pnpm run dev:app

  # Standard development commands
  watch:
    desc: 'Run a server to watch for changes in any packages and automatically rebuild when changes are saved'
    run: pnpm run dev

  build:
    desc: 'Build packages for production distribution'
    run: pnpm run build

  test:
    desc: 'Run tests once'
    run: pnpm run test
    aliases: [t]

  test-watch:
    desc: 'Run tests in watch mode'
    run: pnpm run test:watch

  typecheck:
    desc: 'Check source-code for invalid TypeScript'
    run: pnpm run typecheck

  lint:
    desc: 'Lint the code with ESLint'
    run: pnpm run lint

  format:
    desc: 'Format the code with prettier'
    run: pnpm run format

  changeset:
    desc: 'Add a changeset for releases'
    run: pnpm run changeset add

  cookbook:
    subcommands:
      regenerate:
        desc: 'Refresh all cookbook recipes'
        run: pnpm --dir cookbook run cookbook -- regenerate
      validate:
        desc: 'Validate all cookbook recipes'
        run: pnpm --dir cookbook run cookbook -- validate

  # Package-specific commands
  hydrogen:
    subcommands:
      dev:
        desc: 'Run Hydrogen package in dev mode'
        run: pnpm --dir packages/hydrogen run dev
      build:
        desc: 'Build Hydrogen package'
        run: pnpm --dir packages/hydrogen run build
      docs:
        desc: 'Build Hydrogen documentation'
        run: pnpm --dir packages/hydrogen run build-docs

  skeleton:
    subcommands:
      dev:
        desc: 'Run skeleton template in dev mode'
        run: pnpm --dir templates/skeleton run dev
      dev-tunnel:
        desc: 'Run skeleton template in dev mode with tunnel'
        run: SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH=true pnpm --dir templates/skeleton run dev
      build:
        desc: 'Build skeleton template'
        run: pnpm --dir templates/skeleton run build

open:
  github: https://github.com/Shopify/hydrogen
  pr: # Opens PR for current branch
  issues: # Opens GitHub issues
  docs: https://shopify.dev/docs/api/hydrogen
  hydrogen-react-docs: https://shopify.dev/docs/api/hydrogen-react