format/action.yml at master · elide-dev/format · 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
name: 'Elide Format'
description: 'Check source formatting using Elide (google-java-format and ktfmt)'
author: 'Elide'
branding:
  color: purple
  icon: check-circle

inputs:
  formatter:
    description: 'Formatter to run: javaformat, ktfmt, or all'
    required: false
    default: 'all'

  mode:
    description: 'Mode: check (default) or write'
    required: false
    default: 'check'

  files:
    description: >
      Files or directories to check (space or newline-separated paths). When omitted,
      sources are auto-detected by extension (*.java for javaformat, *.kt for ktfmt).
    required: false

  working-directory:
    description: 'Directory to run formatters from'
    required: false
    default: ${{ github.workspace }}

  exclude:
    description: >
      Files or patterns to exclude (space or newline-separated). Plain paths are matched
      as path segments; glob patterns (* and **) are also supported.
    required: false

  gjf-args:
    description: 'Extra arguments for google-java-format (appended after --)'
    required: false

  ktfmt-args:
    description: 'Extra arguments for ktfmt (appended after --)'
    required: false

  include-kts:
    description: 'Include .kts (Kotlin script) files when running ktfmt'
    required: false
    default: 'false'

  fail-on-error:
    description: 'Fail the workflow when formatting check fails'
    required: false
    default: 'true'

  telemetry:
    description: 'Enable anonymous error telemetry'
    required: false
    default: 'true'

  output-mode:
    description: >
      Output mode after the formatter runs: none (default), file (print affected file paths),
      diff (print unified diffs, check mode only), or command (print a fix command).
    required: false
    default: 'none'

  output-mode-diffs:
    description: >
      When output-mode is diff, limit the number of files whose diffs are printed. If the number
      of affected files exceeds this limit, falls back to listing file paths instead. Must be a
      positive integer.
    required: false

  output-mode-command:
    description: >
      When output-mode is command, print this string instead of a generated elide command.
      Intended for projects that have a pre-defined formatter command (e.g. a Makefile target).
    required: false

outputs:
  result:
    description: 'Check result: success or failure'

  files-checked:
    description: 'Number of files checked'

  files-failed:
    description: 'Newline-separated list of files affected by the formatter: files that failed the format check (check mode) or were reformatted (write mode). Only set when output-mode is file.'

runs:
  using: node24
  main: dist/index.js
  post: dist/post.js
  post-if: always()