khulnasoft/codetypo-action

Spell Checker for Code

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stalelast commit Jan 21, 2025
License: MIT

Pinned Snippet

workflow.ymlSHA-pinned

uses: khulnasoft/codetypo-action@a55dfc7a3564cb2f6aea4df3d9040bb097ed8ea9 # no releases — HEAD as of 2026-07-11

tags can be moved; commit SHAs can't. why a SHA?

Inputs

name	description	required	default
files	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 codetypo.json still apply.	no	—
incremental_files_only	Limit the files checked to the ones in the pull request or push.	no	true
config	Path to CodeTypo configuration file, i.e. `codetypo.json` or `codetypo.config.yaml`. If not provided, the spell checker will search for the nearest configuration file.	no	—
root	The point in the directory tree to start spell checking.	no	—
inline	Notification level to use with inline reporting of spelling errors. Allowed values are: warning, error, none	no	warning
treat_flagged_words_as_errors	Treat flagged / forbidden words as errors. Allowed values are: true, false	—	false
strict	Determines if the action should be failed if any spelling issues are found. Allowed values are: true, false	no	true
suggestions	Generate Spelling suggestions.	no	false
verbose	Increase the log output to include progress. Allowed values are: true, false	no	false
check_dot_files	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.	no	explicit
use_codetypo_files	Use the `files` setting from the CodeTypo configuration file. - "true" - Overrides the `input.files` setting. - "false" - Use the `input.files` setting.	no	false

Outputs

name	description
success	"true" if no spelling issues were found, otherwise "false".
number_of_files_checked	The actual number of files that were checked.
number_of_issues	The number of issues found.
number_of_files_with_issues	The number of files that had issues.
files_with_issues	List of files with issues. Use `fromJSON()` to decode. The files are relative to the repository root.
results	The JSON encoded results.