{"id":21827773,"url":"https://github.com/sane-fmt/action","last_synced_at":"2025-06-13T03:33:01.214Z","repository":{"id":37959655,"uuid":"263341247","full_name":"sane-fmt/action","owner":"sane-fmt","description":"Use sane-fmt to check for TypeScript/JavaScript code formatting","archived":false,"fork":false,"pushed_at":"2025-03-17T12:19:05.000Z","size":797,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-27T19:41:23.859Z","etag":null,"topics":["actions","ci","formatter","github-actions","javascript","sane-fmt","typescript","utility"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/sane-fmt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","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},"funding":{"github":null,"patreon":"khai96_","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-05-12T13:14:55.000Z","updated_at":"2025-03-17T12:19:02.000Z","dependencies_parsed_at":"2023-01-11T17:21:26.552Z","dependency_job_id":"e3d8861e-190f-49c3-b23d-46f5ecdda4d2","html_url":"https://github.com/sane-fmt/action","commit_stats":{"total_commits":157,"total_committers":4,"mean_commits":39.25,"dds":0.1719745222929936,"last_synced_commit":"64bd55029b33a95cc4eb1c10d896df5567c973d3"},"previous_names":[],"tags_count":82,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sane-fmt%2Faction","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sane-fmt%2Faction/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sane-fmt%2Faction/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sane-fmt%2Faction/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sane-fmt","download_url":"https://codeload.github.com/sane-fmt/action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248830420,"owners_count":21168272,"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":["actions","ci","formatter","github-actions","javascript","sane-fmt","typescript","utility"],"created_at":"2024-11-27T18:14:11.322Z","updated_at":"2025-04-14T05:43:09.395Z","avatar_url":"https://github.com/sane-fmt.png","language":"TypeScript","funding_links":["https://patreon.com/khai96_"],"categories":[],"sub_categories":[],"readme":"# sane-fmt Action\n\nUse [sane-fmt](https://github.com/sane-fmt/sane-fmt) to check for TypeScript/JavaScript code formatting.\n\n## Usage Examples\n\n### The most simple usage\n\nThis will check format of all TypeScript and JavaScript files, excluding `.git` and `node_modules`.\n\n```yaml\non: push\njobs:\n  runs-on: ubuntu-latest\n  steps:\n    - uses: actions/checkout@v3\n    - uses: sane-fmt/action@master\n```\n\n### Disable Action Logs\n\nThis will do the same as [before](#the-most-simple-usage) but without log grouping and annotations.\n\n```yaml\non: push\njobs:\n  runs-on: ubuntu-latest\n  steps:\n    - uses: actions/checkout@v3\n    - uses: sane-fmt/action@master\n      with:\n        actions-logs: 'false'\n```\n\n### Check only some files\n\nTo check only some files, you must customize `args` input.\n\n**NOTE:** Due to limitation of inputs in GitHub Actions, value of `args` must be a YAML string representation of an array, not an actual array.\n\n```yaml\non: push\njobs:\n  runs-on: ubuntu-latest\n  steps:\n    - uses: actions/checkout@v3\n    - uses: sane-fmt/action@master\n      with:\n        args: |\n          - --details=diff\n          - --color=always\n          - foo.ts\n          - bar.ts\n          - my-directory\n```\n\n### Do not run, only install\n\nYou can also choose not to run `sane-fmt` immediately, but instead, add it to PATH.\n\n```yaml\non: push\njobs:\n  runs-on: ubuntu-latest\n  steps:\n    - uses: actions/checkout@v3\n\n    - name: Install sane-fmt\n      uses: sane-fmt/action@master\n      with:\n        run: 'false'\n        export-path: 'true'\n\n    - name: Run sane-fmt\n      run: sane-fmt --details=diff --log-format=github-actions ./\n```\n\n## Inputs and Outputs\n\n### Inputs\n\n|     name    |                                   description                                  |   type   |              default             |\n|:-----------:|:------------------------------------------------------------------------------:|:--------:|:--------------------------------:|\n| run         | Whether sane-fmt should be executed right away                                 | boolean  | true                             |\n| args        | List of CLI arguments to pass to sane-fmt                                      | string[] | [--details=diff, --color=always] |\n| action-logs | Whether to pass `--log-format=github-actions` to integrate with GitHub Actions | boolean  | true                             |\n| export-path | Whether to add sane-fmt to PATH                                                | boolean  | false                            |\n\n### Outputs\n\n**NOTE:** `total`, `changed`, and `unchanged` are available only if `inputs#run` and `inputs#action-logs` are `true`.\n\n|         name        |                         description                         |  type  |\n|:-------------------:|:-----------------------------------------------------------:|:------:|\n| location            | Directory where sane-fmt is stored                          | string |\n| executable-basename | Base name of sane-fmt (either `sane-fmt` or `sane-fmt.exe`) | string |\n| executable-path     | Full path to sane-fmt                                       | string |\n| total               | Number of scanned files                                     | number |\n| changed             | Number of scanned files that aren't formatted               | number |\n| unchanged           | Number of scanned files that are formatted                  | number |\n\n## Become a Patron\n\n[My Patreon Page](https://patreon.com/khai96_).\n\n## License\n\n[MIT](https://git.io/Jf8hr) © [Hoàng Văn Khải](https://ksxgithub.github.io/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsane-fmt%2Faction","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsane-fmt%2Faction","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsane-fmt%2Faction/lists"}