{"id":26022829,"url":"https://github.com/junnishimura/konmari","last_synced_at":"2025-07-10T07:34:36.394Z","repository":{"id":172004411,"uuid":"648698911","full_name":"JunNishimura/konmari","owner":"JunNishimura","description":"CLI tool to delete code comment ","archived":false,"fork":false,"pushed_at":"2025-02-18T14:15:39.000Z","size":68,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-18T15:27:04.914Z","etag":null,"topics":["cli","go","golang"],"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/JunNishimura.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":"2023-06-02T15:26:14.000Z","updated_at":"2025-02-18T14:15:37.000Z","dependencies_parsed_at":"2023-11-06T14:58:14.609Z","dependency_job_id":null,"html_url":"https://github.com/JunNishimura/konmari","commit_stats":null,"previous_names":["junnishimura/konmari"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JunNishimura%2Fkonmari","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JunNishimura%2Fkonmari/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JunNishimura%2Fkonmari/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JunNishimura%2Fkonmari/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JunNishimura","download_url":"https://codeload.github.com/JunNishimura/konmari/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242194201,"owners_count":20087529,"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":["cli","go","golang"],"created_at":"2025-03-06T10:37:07.015Z","updated_at":"2025-03-06T10:37:07.692Z","avatar_url":"https://github.com/JunNishimura.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# konmari / CLI tool to delete code comments\n\n\u003cp align='left'\u003e\n  \u003cimg alt=\"GitHub release (latest by date)\" src=\"https://img.shields.io/github/v/release/JunNishimura/konmari\"\u003e\n  \u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/JunNishimura/konmari\"\u003e\n  \u003ca href=\"https://github.com/JunNishimura/konmari/actions/workflows/test.yml\"\u003e\u003cimg src=\"https://github.com/JunNishimura/konmari/actions/workflows/test.yml/badge.svg\" alt=\"test\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://goreportcard.com/report/github.com/JunNishimura/konmari\"\u003e\u003cimg src=\"https://goreportcard.com/badge/github.com/JunNishimura/konmari\" alt=\"Go Report Card\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## 📖 Overview\nkonmari is a CLI tool that allows you to delete comments in source code in bulk.\n\n## 💻 Installation\n### Homebrew Tap\n```\nbrew install JunNishimura/tap/konmari\n```\n\n### go intall\n```\ngo install github.com/JunNishimura/konmari@latest\n```\n\n## 🔨 Options\n```console\n$ konmari -h \nclean up source code comments\n\nUsage:\n  konmari [flags]\n\nFlags:\n  -h, --help             help for konmari\n  -o, --overwrite        overwrite existing files\n  -p, --postfix string   postfix for cleaned files\n```\n### `-o`, `--overwrite`\nBy default, konmari outputs the result of comment deletion to a separate file. However, by specifying this option, existing files can be overwritten.\n\n### `-p`, `--postfix`\nSpecify the postfix of the file that is the output destination of the comment deletion result.\n\n## 👀 Example\nTo apply konmari to the following main.go file,\n```go:main.go\npackage main\n\n// import package\nimport \"fmt\"\n\n/*\n\tthis is a test go file\n*/\n\n// main function\nfunc main() {\n\tfmt.Println(\"Hello, Wolrd\") // print out hello world\n}\n\n```\n\nThe output will look like this\n```go:main.go\npackage main\n\n\nimport \"fmt\"\n\n\n\n\nfunc main() {\n\tfmt.Println(\"Hello, Wolrd\") \n}\n\n```\n\n## 😢 Limitation\nkonmari has flows. konmari does not work as expected in the following case.\n```go:main.go\npackage main\n\n// import package\nimport \"fmt\"\n\n// main function\nfunc main() {\n\tfmt.Println(\"this // will be treated as comment\") // print out hello world\n}\n```\n\nThis is the output.\n```go:main.go\npackage main\n\n\nimport \"fmt\"\n\n\nfunc main() {\n\tfmt.Println(\"this \n}\n\n```\n\nkonmari incorrectly recognizes comment symbols in strings as comments as well. This will be fixed in the future, so please be patient.\n\n## 🪧 License\nkonmari is released under MIT License. See [MIT](https://raw.githubusercontent.com/JunNishimura/konmari/main/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjunnishimura%2Fkonmari","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjunnishimura%2Fkonmari","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjunnishimura%2Fkonmari/lists"}