make-help/help.yaml at dev · niceEli/make-help · 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
$schema: "https://unpkg.com/makeman@*/help.schema.json"
name: makeman
author: niceEli
description: An Opinionated GNU Make Help System
targets:
  build:
    description: Build the app
  dev:
    description: Build and run the app
    usage:
      variables:
        - name: NODE_ENV
          description: Use 'development' for development mode, 'production' for production
            mode
  format:
    description: Format the code using prettier
  lint:
    description: Lint the code using ESLint
  test:
    description: Run the tests using vitest
    usage:
      example: test [commands] [options]
      commands:
        - name: dev
          description: Run the tests in development mode
      options:
        - name: --watch
          description: Run the tests in watch mode
  tsc:
    description: Type check the code using TypeScript
    usage:
      example: tsc [commands]
      commands:
        - name: noEmit
          description: Type check the code without emitting files
  genSchema:
    description: Generate the schema for the app