{"id":14109761,"url":"https://github.com/j2kun/chktex-action","last_synced_at":"2025-04-23T20:31:53.626Z","repository":{"id":39834449,"uuid":"205777425","full_name":"j2kun/chktex-action","owner":"j2kun","description":"A Github action to lint a LaTeX file for style and formatting issues.","archived":false,"fork":false,"pushed_at":"2024-04-12T20:39:47.000Z","size":46,"stargazers_count":16,"open_issues_count":2,"forks_count":8,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-14T04:57:01.146Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/j2kun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2019-09-02T04:35:29.000Z","updated_at":"2024-04-26T14:55:18.538Z","dependencies_parsed_at":"2024-04-12T21:41:52.955Z","dependency_job_id":null,"html_url":"https://github.com/j2kun/chktex-action","commit_stats":{"total_commits":47,"total_committers":4,"mean_commits":11.75,"dds":"0.17021276595744683","last_synced_commit":"936c046bdb015b4ce9d2dbdbb0dcc5f6d43b51b8"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/j2kun%2Fchktex-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/j2kun%2Fchktex-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/j2kun%2Fchktex-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/j2kun%2Fchktex-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/j2kun","download_url":"https://codeload.github.com/j2kun/chktex-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250509693,"owners_count":21442479,"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-08-14T10:02:28.961Z","updated_at":"2025-04-23T20:31:53.618Z","avatar_url":"https://github.com/j2kun.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# ChkTeX Action\n\n## _Lint your LaTeX files with ChkTeX_\n\n[ChkTeX](https://www.nongnu.org/chktex/) is a LaTeX linter.\nA _linter_ is a program that checks your work for potential stylistic or formatting issues.\nFor LaTeX, this includes soft errors (e.g., missing braces or alignment problems) and choices that could lead to\nrendering inconsistencies.\n\nThis Action runs ChkTeX version `1.7.9` on `.tex` files in your repository.\n\nTo customize ChkTeX's behavior, add a `.chktexrc` configuration file to your repository's root.\nThis file allows you to define specific rules and exclusions for the linter.\nRefer to the ChkTeX documentation for details on how to create and configure this file.\nIf no local repository `.chktexrc` file can be found, the action will use the global ChkTeX configuration distributed as\npart of the ChkTeX software that runs in the Action container.\n\n**ChkTeX Action** reviews your pull requests when used with the `pull_request` event.\nIf ChkTeX reports errors or warnings, the Action will request changes:\n\n![Pull request review with requested changes](images/request-changes.png)\n\nWhen this happens, the files changed will be annotated with the error and warning messages from ChkTeX:\n\n![File annotations with ChkTeX errors](images/annotations.png)\n\nOnce you fix all the issues and trigger the Action again, the Action will approve your pull request:\n\n![Pull request review with approval](images/approve.png)\n\n**ChkTeX Action** also posts a step summary under `Actions \u003e [workflow run] \u003e Summary`:\n\n![ChkTeX Action summary in GitHub Actions](images/summary.png)\n\n## Configuration and Usage\n\nTo use this Action in your repository, add it to your custom workflow.\n\nBy default, the Action will only lint the files in the latest pushed commit when used with the `push` event.\nIf you want to override this behavior, set `lint-all: true` to lint all `.tex` files in your repository.\n\nWhen used with the `pull_request` event, the Action only lints the `.tex` files that are part of the pull request.\n\n### Events\n\n- `push`: Lints `.tex` files in the latest pushed commit.\n- `pull_request`: Lints `.tex` files that are part of the pull request.\n\n### Permissions\n\n- For the `push` event, set:\n    - `contents: read`\n- For the `pull_request` event, set:\n    - `pull-requests: write`\n    - `checks: write`\n    - Additionally, enable `Allow GitHub Actions to create and approve pull requests` under\n      `Repository \u003e Settings \u003e Actions \u003e General \u003e Workflow permissions`\n\n### Inputs\n\n- `lint-all`: Force lint of all files in the repository.\n    - Default: `false`\n\n### Example\n\n```yml\nname: Lint\non: push # Or `pull_request`\npermissions:\n  contents: read\n  pull-requests: write # When using the `pull_request` event\n  checks: write # When using the `pull_request` event\njobs:\n  lint:\n    name: Lint\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4\n      - name: Run ChkTeX\n        uses: j2kun/chktex-action@v2\n        with:\n          lint-all: true # Default: `false`\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fj2kun%2Fchktex-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fj2kun%2Fchktex-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fj2kun%2Fchktex-action/lists"}