{"id":19083029,"url":"https://github.com/deep5050/count-comments-action","last_synced_at":"2026-02-26T03:45:24.820Z","repository":{"id":40704333,"uuid":"359769666","full_name":"deep5050/count-comments-action","owner":"deep5050","description":"count number of comments in the codebase of a PR before you merge :tada:","archived":false,"fork":false,"pushed_at":"2022-08-18T19:39:47.000Z","size":3361,"stargazers_count":3,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-03-15T09:50:06.913Z","etag":null,"topics":["actions","cloc","code-quality","code-quality-analyzer","comment","count-comment","github-actions","gloc","pull","pull-requests"],"latest_commit_sha":null,"homepage":"","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/deep5050.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}},"created_at":"2021-04-20T10:09:49.000Z","updated_at":"2023-02-13T16:11:22.000Z","dependencies_parsed_at":"2023-01-04T12:21:48.563Z","dependency_job_id":null,"html_url":"https://github.com/deep5050/count-comments-action","commit_stats":{"total_commits":21,"total_committers":1,"mean_commits":21.0,"dds":0.0,"last_synced_commit":"9ce2d514f944c91da0dbc11ea19cb2095afc727f"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deep5050%2Fcount-comments-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deep5050%2Fcount-comments-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deep5050%2Fcount-comments-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deep5050%2Fcount-comments-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deep5050","download_url":"https://codeload.github.com/deep5050/count-comments-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223780087,"owners_count":17201287,"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","cloc","code-quality","code-quality-analyzer","comment","count-comment","github-actions","gloc","pull","pull-requests"],"created_at":"2024-11-09T02:45:45.467Z","updated_at":"2026-02-26T03:45:19.799Z","avatar_url":"https://github.com/deep5050.png","language":"JavaScript","readme":"# count-comments-action\ncount number of comments in the codebase of a PR before you merge it:tada:\n\n## Example\n\n![example](./screen.jpg)\n\n#### comment-to-code-ratio analysis report for this PR :tada:\n        \n File|blank %|comment %|code\n:-------|-------:|-------:|-------:\n./dist/index.js|15.72|10.77|6403\n./README.md|10.18|0.00|547\n./index.js|26.58|0.00|58\n./.github/workflows/test.yml|13.79|0.00|25\n./action.yml|17.39|0.00|19\n./report.md|20.83|0.00|19\n./.github/workflows/meme.yml|11.76|0.00|15\n./logo.svg|0.00|0.00|1\n--------|--------|--------|--------\nSUM:|15.46|9.88|7087\n\n\n \n Horribly commented code averages 0-5% comment ratio.\n \n Poorly commented code has a 5-10% comment ratio.\n \n Average code has a 10-15% comment ratio.\n \n Good code has a 15-25% comment ratio.\n \n Excellent code has a \u003e 25% comment ratio.\n \n\n Use [this action](https://github.com/deep5050/comment-to-code-ratio-action) on your projects to generate a report like this.\n \n ## How to use\n \n ```yaml\n \nname: \"test\"\non:\n  pull_request_target:\n    types: [opened, reopened]\n\njobs:\n  test:\n    name: setup environment\n    runs-on: ubuntu-latest\n    steps:\n      - name: chekckout PR codebase\n        uses: actions/checkout@v2\n        with:\n          ref: ${{ github.event.pull_request.head.sha }}\n        \n      - name: install cloc\n        uses: actions/setup-node@v1\n        with:\n          node-version: '12'\n      - run: sudo npm install cloc -g\n        \n      - name: count and reply\n        uses: deep5050/count-comments-action@main\n        with:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          issue_number: 1\n          options: '--quiet ./ --hide-rate --git --unix --md --out=report.md --timeout=20 --by-percent=cmb --by-file-by-lang --exclude-dir=node_modules, --exclude-lang=JSON,XML,YAML,YML'\n \n ```\n \n ## Related\n \n [![deep5050/comment-to-code-ratio-action - GitHub](https://gh-card.dev/repos/deep5050/comment-to-code-ratio-action.svg)](https://github.com/deep5050/comment-to-code-ratio-action)\n \n [![deep5050/cppcheck-action - GitHub](https://gh-card.dev/repos/deep5050/cppcheck-action.svg)](https://github.com/deep5050/cppcheck-action)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeep5050%2Fcount-comments-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeep5050%2Fcount-comments-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeep5050%2Fcount-comments-action/lists"}