cspell-action/action.yaml at main · streetsidesoftware/cspell-action · 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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
name: 'cspell-action'
description: 'Spell Checker for Code'
author: 'Street Side Software <info@streetsidesoftware.nl>'
inputs:
  files:
    description: |
      Define glob patterns to filter the files to be checked. Use a new line between patterns to define multiple patterns.
      The default is to check ALL files that were changed in in the pull_request or push.
      Note: `ignorePaths` defined in cspell.json still apply.
    required: false
  incremental_files_only:
    description: >
      Limit the files checked to the ones in the pull request or push.
    default: 'true'
    required: false
  config:
    description: >
      Path to CSpell configuration file, i.e. `cspell.json` or `cspell.config.yaml`.
      If not provided, the spell checker will search for the nearest configuration file.
    required: false
  root:
    description: >
      The point in the directory tree to start spell checking.
    required: false
  inline:
    description: >
      Notification level to use with inline reporting of spelling errors.
      Allowed values are: warning, error, none
    default: warning
    required: false
  treat_flagged_words_as_errors:
    description: >
      Treat flagged / forbidden words as errors.
      Allowed values are: true, false
    default: 'false'
  strict:
    description: |
      Determines if the action should be failed if any spelling issues are found.
      Allowed values are: true, false
    default: 'true'
    required: false
  suggestions:
    description: >
      Generate Spelling suggestions.
    default: 'false'
    required: false
  verbose:
    description: |
      Increase the log output to include progress.
      Allowed values are: true, false
    default: 'false'
    required: false
  check_dot_files:
    description: |
      Check files and directories starting with `.`.
      - "true" - glob searches will match against `.dot` files.
      - "false" - `.dot` files will NOT be checked.
      - "explicit" - glob patterns can match explicit `.dot` patterns.
    default: 'explicit'
    required: false
  use_cspell_files:
    description: |
      Use the `files` setting from the CSpell configuration file.
      - "true" - Overrides the `input.files` setting.
      - "false" - Use the `input.files` setting.
    default: 'false'
    required: false
  report:
    description: |
      Set how unknown words are reported.
      - "all" - all issues are reported.
      - "simple" - only unknown words are reported.
      - "typos" - only typos are reported.
      - "flagged" - only flagged words are reported.
    required: false
  summary:
    description: |
      Include a summary of the results in the output.
      Allowed values are: "true", "false"
    default: 'false'
    required: false

outputs:
  success:
    description: |
      "true" if no spelling issues were found, otherwise "false".
  number_of_files_checked:
    description: |
      The actual number of files that were checked.
  number_of_issues:
    description: |
      The number of issues found.
  number_of_files_with_issues:
    description: |
      The number of files that had issues.
  number_of_files_skipped:
    description: |
      The number of files that were skipped.
  number_of_files_cached:
    description: |
      The number of files where the results were taken from the cache.
  errors:
    description: |
      The number of errors found. This is the number issues found or configuration errors.
  files_with_issues:
    description: |
      List of files with issues. Use `fromJSON()` to decode.
      The files are relative to the repository root.
  results:
    description: |
      The JSON encoded results.

runs:
  using: 'node24'
  main: './action/lib/main_root.js'
branding:
  icon: 'code'
  color: 'green'