{"id":19911022,"url":"https://github.com/streetsidesoftware/cspell-action","last_synced_at":"2026-02-24T09:21:40.596Z","repository":{"id":37036079,"uuid":"243818802","full_name":"streetsidesoftware/cspell-action","owner":"streetsidesoftware","description":"GitHub Action: Check Spelling","archived":false,"fork":false,"pushed_at":"2025-05-12T11:36:48.000Z","size":99387,"stargazers_count":90,"open_issues_count":10,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-12T12:39:26.359Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/streetsidesoftware.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["streetsidesoftware"],"patreon":"streetsidesoftware","open_collective":"cspell","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-02-28T17:31:31.000Z","updated_at":"2025-05-12T11:34:25.000Z","dependencies_parsed_at":"2024-05-30T13:31:28.671Z","dependency_job_id":"84342528-5407-45c5-93bd-e39ea1af4864","html_url":"https://github.com/streetsidesoftware/cspell-action","commit_stats":{"total_commits":1117,"total_committers":7,"mean_commits":"159.57142857142858","dds":"0.33572068039391223","last_synced_commit":"09d665e490abbfa4280840289a45721186951d3f"},"previous_names":[],"tags_count":153,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/streetsidesoftware%2Fcspell-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/streetsidesoftware%2Fcspell-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/streetsidesoftware%2Fcspell-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/streetsidesoftware%2Fcspell-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/streetsidesoftware","download_url":"https://codeload.github.com/streetsidesoftware/cspell-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254436948,"owners_count":22070947,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T21:23:03.203Z","updated_at":"2026-02-24T09:21:40.553Z","avatar_url":"https://github.com/streetsidesoftware.png","language":"JavaScript","funding_links":["https://github.com/sponsors/streetsidesoftware","https://patreon.com/streetsidesoftware","https://opencollective.com/cspell"],"categories":["JavaScript"],"sub_categories":[],"readme":"# cspell-action\n\nUses [cspell](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell) to check code.\n\n## Installation\n\nExample `spellcheck.yaml`\n\n```yaml\nname: 'Check spelling'\non: # rebuild any PRs and main branch changes\n  pull_request:\n  push:\n\njobs:\n  spellcheck: # run the action\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v5\n        with:\n          persist-credentials: false\n      - uses: streetsidesoftware/cspell-action@v8\n```\n\n## Usage\n\n```yaml\n- uses: streetsidesoftware/cspell-action@v8\n  with:\n    # Define glob patterns to filter the files to be checked. Use a new line between patterns to define multiple patterns.\n    # The default is to check ALL files that were changed in in the pull_request or push.\n    # Note: `ignorePaths` defined in cspell.json still apply.\n    # Example:\n    # files: |\n    #   **/*.{ts,js}\n    #   !dist/**/*.{ts,js}\n    #\n    # Default: ALL files\n    files: ''\n\n    # Check files and directories starting with `.`.\n    # - \"true\" - glob searches will match against `.dot` files.\n    # - \"false\" - `.dot` files will NOT be checked.\n    # - \"explicit\" - glob patterns can match explicit `.dot` patterns.\n    check_dot_files: explicit\n\n    # The point in the directory tree to start spell checking.\n    # Default: .\n    root: '.'\n\n    # Notification level to use with inline reporting of spelling errors.\n    # Allowed values are: warning, error, none\n    # Default: warning\n    inline: warning\n\n    # Reports flagged / forbidden words as errors.\n    # If true, errors will still be reported even if `inline` is \"none\"\n    treat_flagged_words_as_errors: false\n\n    # Generate Spelling suggestions.\n    suggestions: false\n\n    # Determines if the action should be failed if any spelling issues are found.\n    # Allowed values are: true, false\n    # Default: true\n    strict: true\n\n    # Limit the files checked to the ones in the pull request or push.\n    incremental_files_only: true\n\n    # Path to `cspell.json`\n    config: '.'\n\n    # Log progress and other information during the action execution.\n    # Default: false\n    verbose: false\n\n    # Use the `files` setting found in the CSpell configuration instead of `input.files`.\n    use_cspell_files: false\n\n    # Set how unknown words are reported.\n    # Allowed values are: all, simple, typos, flagged\n    # Default: all\n    report: all\n```\n\n## Yarn 2 - PlugNPlay\n\nTo use dictionaries stored within a Yarn 2 workspace, there are two choices:\n\n1. Add `\"usePnP\": true` to the workspace `cspell.json` file. This tells `cspell` to search for the\n   nearest `.pnp.js` or `.pnp.cjs` file and load it.\n\nExample for medical terms:\n\n```js\n{\n  \"usePnP\": true,\n  \"import\": [\"@cspell/dict-medicalterms/cspell-ext.json\"]\n}\n```\n\n2. Require the `.pnp.js` or `.pnp.cjs` in a `cspell.config.js` file.\n   This must be done before importing any packages.\n\n```js\n'use strict';\nrequire('./.pnp.js').setup(); // or './.pnp.cjs'\n\n/** @type { import(\"@cspell/cspell-types\").CSpellUserSettings } */\nconst cspell = {\n  description: 'Yarn 2 Aware cspell config',\n  import: ['@cspell/dict-medicalterms/cspell-ext.json'],\n};\nmodule.exports = cspell;\n```\n\n## Outputs\n\n```yaml\noutputs:\n  success:\n    description: |\n      \"true\" if no spelling issues were found, otherwise \"false\".\n  number_of_files_checked:\n    description: |\n      The actual number of files that were checked.\n  number_of_issues:\n    description: |\n      The number of issues found.\n  number_of_files_with_issues:\n    description: |\n      The number of files that had issues.\n  errors:\n    description: |\n      The number of errors found. This is the number issues found or configuration errors.\n  files_with_issues:\n    description: |\n      List of files with issues. Use `fromJSON()` to decode.\n      The files are relative to the repository root.\n  results:\n    description: |\n      The JSON encoded results.\n```\n\nExample Output:\n\n```json\n{\n  \"success\": \"false\",\n  \"number_of_files_checked\": \"3\",\n  \"number_of_issues\": \"2\",\n  \"number_of_files_with_issues\": \"1\",\n  \"files_with_issues\": \"[\\\"src/withErrors.ts\\\"]\",\n  \"result\": \"{\\\"success\\\":false,\\\"number_of_issues\\\":2,\\\"number_of_files_checked\\\":3,\\\"files_with_issues\\\":[\\\"src/withErrors.ts\\\"]}\"\n}\n```\n\n\u003c!---\ncspell:ignore medicalterms\n\n---\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstreetsidesoftware%2Fcspell-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstreetsidesoftware%2Fcspell-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstreetsidesoftware%2Fcspell-action/lists"}