{"id":22202698,"url":"https://github.com/namchee/actions-case-police","last_synced_at":"2025-07-27T05:31:46.502Z","repository":{"id":41871951,"uuid":"477197534","full_name":"Namchee/actions-case-police","owner":"Namchee","description":"Use the correct case please, even on GitHub","archived":false,"fork":false,"pushed_at":"2023-03-07T01:33:20.000Z","size":112,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-31T10:49:10.054Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","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/Namchee.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}},"created_at":"2022-04-02T23:52:00.000Z","updated_at":"2023-03-07T10:24:51.000Z","dependencies_parsed_at":"2024-06-19T19:20:46.887Z","dependency_job_id":null,"html_url":"https://github.com/Namchee/actions-case-police","commit_stats":{"total_commits":35,"total_committers":3,"mean_commits":"11.666666666666666","dds":0.08571428571428574,"last_synced_commit":"81e34d0f448fcba6bfdafdb846f08454038fa4e9"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Namchee%2Factions-case-police","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Namchee%2Factions-case-police/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Namchee%2Factions-case-police/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Namchee%2Factions-case-police/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Namchee","download_url":"https://codeload.github.com/Namchee/actions-case-police/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227762901,"owners_count":17816098,"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-12-02T16:36:58.083Z","updated_at":"2025-07-27T05:31:46.490Z","avatar_url":"https://github.com/Namchee.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Actions Case Police\n\n🚨 Use the correct case, even on GitHub issues. Directly inspired by the original [case-police](https://github.com/antfu/case-police).\n\n## Installation\n\n\u003e To use `actions-case-police`, you'll need to prepare a GitHub access token. Please refer to this [article](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) on how to generate an access token.\n\nYou can integrate `actions-case-police` to your existing GitHub actions workflow by using `Namchee/actions-case-police@\u003cversion\u003e` in one of your jobs using `yaml`.\n\nBelow is the example of using `actions-case-police` job in your action workflow.\n\n```yaml\non:\n  pull_request:\n  issues:\n\njobs:\n  case-police:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Use the correct case\n        uses: Namchee/actions-case-police@v(version)\n        with:\n          access_token: \u003cYOUR_GITHUB_ACCESS_TOKEN_HERE\u003e\n          fix         : true\n```\n\nPlease refer to [GitHub workflow syntax](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#about-yaml-syntax-for-workflows) for more advanced usage.\n\n\u003e [!NOTE]\n\u003e 💡 You can use a special syntax `${{ secrets.GITHUB_TOKEN }}` as your access token and the `github-actions` bot will run the job on behalf of you.\n\n## Dictionary\n\nEvery words that can be case-policed is stored in dictionaries. Please refer to the [dictionary folder](./dict/) for all default words.\n\n\u003e [!NOTE]\n\u003e 💡 You can also provide your own dictionary to be used with the default dictionary with the `dictionary` input.\n\n## Inputs\n\nYou can customize this actions with these following options (fill it on `with` section):\n\n| **Name**       | **Required?** | **Default Value** | **Description** |\n| -------------- | ------------- | ----------------- | --------------- |\n| `access_token` | `true`        | `-` | [GitHub access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) to interact with the GitHub API. It is recommended to store this token with [GitHub Secrets](https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets). |\n| `fix`          | `false`        | `true`            | Determines if possible case fixes should be applied automatically. If set to `false`, `actions-case-police` will only log possible fixes in the action log. |\n| `preset`       | `false`        | ``[\"abbreviates\", \"brands\", \"general\", \"products\", \"softwares\"]`` | Dictionary names to be used when validating word cases. Dictionary are sourced from the original [case-police repository](https://github.com/antfu/case-police/tree/main/packages/case-police/dict). By default, it will use all default dictionary. Comma-separated. |\n| `exclude`      | `false`        | `\"\"` | Words to be whitelisted on case police. Comma-separated. |\n| `dictionary`   | `false`        | `{}` | Stringified JSON map that represents custom entiries for dictionary that will be used on case police. |\n\n## Special Thanks\n\n- [Anthony Fu](https://github.com/antfu), for the original [case-police](https://github.com/antfu/case-police) and for granting me the permission for this project.\n\n## License\n\nThis project is licensed under the [MIT license](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnamchee%2Factions-case-police","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnamchee%2Factions-case-police","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnamchee%2Factions-case-police/lists"}