{"id":48268192,"url":"https://github.com/ChiefGokhlayeh/textidote-action","last_synced_at":"2026-04-20T10:01:13.448Z","repository":{"id":37947846,"uuid":"309435626","full_name":"ChiefGokhlayeh/textidote-action","owner":"ChiefGokhlayeh","description":"GitHub Action to lint, spell- and grammar-check LaTeX documents using TeXtidote.","archived":false,"fork":false,"pushed_at":"2026-03-17T10:27:35.000Z","size":162,"stargazers_count":11,"open_issues_count":5,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-18T01:30:02.213Z","etag":null,"topics":["github-actions","latex","spell-check","textidote"],"latest_commit_sha":null,"homepage":"","language":"TeX","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/ChiefGokhlayeh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-11-02T16:53:02.000Z","updated_at":"2026-03-17T10:27:37.000Z","dependencies_parsed_at":"2023-02-08T18:01:55.143Z","dependency_job_id":"d4532f5d-1444-467d-abe3-5bb415f3fabd","html_url":"https://github.com/ChiefGokhlayeh/textidote-action","commit_stats":{"total_commits":111,"total_committers":7,"mean_commits":"15.857142857142858","dds":0.4864864864864865,"last_synced_commit":"4db1df2ac7178085b174452c4818a7eafcd48d1b"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/ChiefGokhlayeh/textidote-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChiefGokhlayeh%2Ftextidote-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChiefGokhlayeh%2Ftextidote-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChiefGokhlayeh%2Ftextidote-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChiefGokhlayeh%2Ftextidote-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ChiefGokhlayeh","download_url":"https://codeload.github.com/ChiefGokhlayeh/textidote-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChiefGokhlayeh%2Ftextidote-action/sbom","scorecard":{"id":29131,"data":{"date":"2025-08-11","repo":{"name":"github.com/ChiefGokhlayeh/textidote-action","commit":"58183f6e03454816658864d68fce09fb1fc63546"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.8,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/1 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"1 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/push-image.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Warn: topLevel 'contents' permission set to 'write': .github/workflows/versioning.yml:8","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/push-image.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/ChiefGokhlayeh/textidote-action/push-image.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/push-image.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/ChiefGokhlayeh/textidote-action/push-image.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/push-image.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/ChiefGokhlayeh/textidote-action/push-image.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/push-image.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/ChiefGokhlayeh/textidote-action/push-image.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/push-image.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/ChiefGokhlayeh/textidote-action/push-image.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/push-image.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/ChiefGokhlayeh/textidote-action/push-image.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/push-image.yml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/ChiefGokhlayeh/textidote-action/push-image.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/push-image.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/ChiefGokhlayeh/textidote-action/push-image.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/ChiefGokhlayeh/textidote-action/test.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/versioning.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/ChiefGokhlayeh/textidote-action/versioning.yml/main?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating fedora:42 to fedora:42@sha256:3da64cb89971a1cdbc6046e307eeebcb54f7281c0a606ee48d9995473f6b88d5","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   7 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/push-image.yml:10"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 29 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-14T18:38:08.199Z","repository_id":37947846,"created_at":"2025-08-14T18:38:08.199Z","updated_at":"2025-08-14T18:38:08.199Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32042293,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T00:18:06.643Z","status":"online","status_checked_at":"2026-04-20T02:00:06.527Z","response_time":94,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["github-actions","latex","spell-check","textidote"],"created_at":"2026-04-04T22:00:29.180Z","updated_at":"2026-04-20T10:01:13.442Z","avatar_url":"https://github.com/ChiefGokhlayeh.png","language":"TeX","funding_links":[],"categories":["TeX"],"sub_categories":[],"readme":"# TeXtidote Action\n\n[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ChiefGokhlayeh/textidote-action)\n\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ChiefGokhlayeh/textidote-action/main.svg)](https://results.pre-commit.ci/latest/github/ChiefGokhlayeh/textidote-action/main)\n[![Test on Documents](https://github.com/ChiefGokhlayeh/textidote-action/actions/workflows/test.yml/badge.svg)](https://github.com/ChiefGokhlayeh/textidote-action/actions/workflows/test.yml)\n[![Push Image](https://github.com/ChiefGokhlayeh/textidote-action/actions/workflows/push-image.yml/badge.svg)](https://github.com/ChiefGokhlayeh/textidote-action/actions/workflows/push-image.yml)\n[![Version Tag](https://github.com/ChiefGokhlayeh/textidote-action/actions/workflows/versioning.yml/badge.svg)](https://github.com/ChiefGokhlayeh/textidote-action/actions/workflows/versioning.yml)\n\nGitHub Action to lint, spell- and grammar-check LaTeX documents using [TeXtidote](https://github.com/sylvainhalle/textidote).\n\n## Inputs\n\n### `root_file`\n\n**Required** - The root LaTeX file to be linted.\n\n### `working_directory`\n\n**Optional** - Working directory to execute TeXtidote in.\n\n### `report_type`\n\n**Optional** - The type of TeXtidote report to generate (referring to TeXtidote's `--output` option). Default: `html`\n\n### `report_file`\n\n**Optional** - The file path of the TeXtidote report. Default: `report.html`\n\n### `args`\n\n**Optional** - Extra arguments to be passed to TeXtidote.\n\n## Outputs\n\n### `num_warnings`\n\nInteger value representing the number of warnings TeXtidote found while linting the document. Value is parsed from TeXtidote `stderr`. If parsing fails, [`num_warnings`](#num_warnings) is set to `-1` and an error is logged.\n\n## Example usage\n\n```yaml\nname: Lint LaTeX document\non: [push]\njobs:\n    lint_latex:\n        runs-on: ubuntu-latest\n        steps:\n            - name: Set up Git repository\n              uses: actions/checkout@v2\n            - name: Lint LaTeX document\n              uses: ChiefGokhlayeh/textidote-action@v5\n              id: lint\n              with:\n                  root_file: main.tex\n\n                  ## Implied defaults:\n                  # working_directory:\n                  # report_type: html\n                  # report_file: report.html\n\n                  ## Use this setting to pass custom arguments options to\n                  ## TeXtidote (such as what grammar checker to use).\n                  # args:\n            - name: Upload TeXtidote report\n              uses: actions/upload-artifact@v2\n              with:\n                  name: textidote_report\n                  path: report.html\n            - name: Throw error if linter warnings exist\n              if: ${{ steps.lint.outputs.num_warnings != 0 }}\n              run: 'echo \"::error file=main.tex::num_warnings: ${{ steps.lint.outputs.num_warnings }}\"; exit 1;'\n```\n\n### Spell Check\n\nTeXtidote is able to perform spell- and grammar-checking using [LanguageTool](https://languagetool.org/). To activate it for CI build, add option `--check \u003clanguage\u003e` to [`args`](#args), where `\u003clanguage\u003e` is any language code supported by LanguageTool (examples: `en` - English, `de` - German, `es` - Spanish). Custom dictionaries can be added via option `--dict \u003cpath-to-dict-file-in-repo\u003e`.\n\n\u003cdetails\u003e\u003csummary\u003eExample: Using English spell check \u0026 dictionary\u003c/summary\u003e\n\u003cp\u003e\n\n```yaml\nname: Lint \u0026 Spell Check LaTeX document\non: [push]\njobs:\n    lint_and_spell_check_latex:\n        runs-on: ubuntu-latest\n        steps:\n            - uses: actions/checkout@v2\n            - uses: ChiefGokhlayeh/textidote-action@v5\n              with:\n                  root_file: main.tex\n                  args: --check en --dict en_US.dict\n```\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n### Ignoring False-Positives\n\nIf you're struggling with false-positives, you can disable certain rules using [TeXtidote's `--ignore`](https://github.com/sylvainhalle/textidote#ignoring-rules) option.\n\n\u003cdetails\u003e\u003csummary\u003eExample: Ignoring rules sh:001 and sh:d:001\u003c/summary\u003e\n\u003cp\u003e\n\n```yaml\nname: Lint document with some exemptions\non: [push]\njobs:\n    lint_latex_with_some_exemptions:\n        runs-on: ubuntu-latest\n        steps:\n            - uses: actions/checkout@v2\n            - uses: ChiefGokhlayeh/textidote-action@5\n              with:\n                  root_file: main.tex\n                  args: --ignore sh:001,sh:d:001\n```\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n### More Options\n\nPlease refer to the official [TeXtidote README](https://github.com/sylvainhalle/textidote/blob/master/Readme.md) for more options. Use [`args`](#args) to add custom options. For long lists of additional arguments consider using a [`.textidote`](https://github.com/sylvainhalle/textidote#using-a-configuration-file) configuration file.\n\n## Docker Hub\n\nThe Docker image created for this action is reusable as a general TeXtidote container and is available on [Docker Hub](https://hub.docker.com/r/gokhlayeh/textidote).\n\n## Contributing\n\nPlease raise an issue if you encounter any troubles related to this action. Pull requests are always welcome. Remember, this is a hobby project.\n\n## Alternatives\n\nIf you want continuous spell and grammar checking as you type, I recommend the excellent [LTeX Language Server](https://valentjn.github.io/ltex/), also available as [VS Code extension](https://marketplace.visualstudio.com/items?itemName=valentjn.vscode-ltex). LTeX has a greater understanding of LaTeX commands and a more intuitive mechanism of adding new unknown commands. TeXtidote may then be used like a linter in the classical sense.\n\n## License\n\nSPDX: [`MIT`](https://opensource.org/licenses/MIT)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FChiefGokhlayeh%2Ftextidote-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FChiefGokhlayeh%2Ftextidote-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FChiefGokhlayeh%2Ftextidote-action/lists"}