{"id":18068449,"url":"https://github.com/qwefgh90/comment-parser","last_synced_at":"2026-04-28T18:35:30.592Z","repository":{"id":57734580,"uuid":"111076605","full_name":"qwefgh90/comment-parser","owner":"qwefgh90","description":"The Comment Parser supports various languages based on FSM. It's written by scala and java.","archived":false,"fork":false,"pushed_at":"2019-12-01T08:20:08.000Z","size":60,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-05T16:13:09.494Z","etag":null,"topics":["comment","comment-parser","java","language","parser","parsing","sbt","scala"],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qwefgh90.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":"2017-11-17T08:15:14.000Z","updated_at":"2022-04-13T06:52:37.000Z","dependencies_parsed_at":"2022-09-21T16:43:35.661Z","dependency_job_id":null,"html_url":"https://github.com/qwefgh90/comment-parser","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/qwefgh90/comment-parser","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qwefgh90%2Fcomment-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qwefgh90%2Fcomment-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qwefgh90%2Fcomment-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qwefgh90%2Fcomment-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qwefgh90","download_url":"https://codeload.github.com/qwefgh90/comment-parser/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qwefgh90%2Fcomment-parser/sbom","scorecard":{"id":756492,"data":{"date":"2025-08-11","repo":{"name":"github.com/qwefgh90/comment-parser","commit":"ae22c84b458026e3b52b03ce4f4af4e7b7d0d75d"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 1/20 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 2 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-22T21:48:52.589Z","repository_id":57734580,"created_at":"2025-08-22T21:48:52.589Z","updated_at":"2025-08-22T21:48:52.589Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32394466,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-28T14:34:11.604Z","status":"ssl_error","status_checked_at":"2026-04-28T14:32:37.009Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["comment","comment-parser","java","language","parser","parsing","sbt","scala"],"created_at":"2024-10-31T08:06:31.633Z","updated_at":"2026-04-28T18:35:30.572Z","avatar_url":"https://github.com/qwefgh90.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Comment Parser\nThe Comment Parser supports various languages based on FSM. It's written by scala and java.\n\n## Prerequisites\n\n- Java 1.8\n\n## Getting comment parser\n\nComment Parser is published to Sonatype OSS and Maven Central:\n\n- Group id / organization: *io.github.qwefgh90*\n- Artifact id / name: *comment-parser*\n- Latest version is *0.1.0*\n\nAdd it to your sbt build definition:\n```\nlibraryDependencies += \"io.github.qwefgh90\" %% \"comment-parser\" % \"0.1.0\"\n```\n\nAdd one of them to your maven pom file:\n```\n\u003cdependency\u003e\n    \u003cgroupId\u003eio.github.qwefgh90\u003c/groupId\u003e\n    \u003cartifactId\u003ecomment-parser_2.11\u003c/artifactId\u003e\n    \u003cversion\u003e0.1.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nor\n\n```\n\u003cdependency\u003e\n    \u003cgroupId\u003eio.github.qwefgh90\u003c/groupId\u003e\n    \u003cartifactId\u003ecomment-parser_2.11\u003c/artifactId\u003e\n    \u003cversion\u003e0.1.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## Using Comment Parser\n\nCommentParser is a main class to extract comments from various files. Import ` io.github.qwefgh90.commentparser` package to your sources to use CommentParser. Also, there is a inner `CommentParser.CommentResult` class containing a result.\n\nIt has four static methods to do that.\n\nYou can pass `URI` object to first parameter. \n```java\nimport io.github.qwefgh90.commentparser.CommentParser;\nimport java.nio.file.Paths;\nimport java.util.Optional;\nimport java.util.List;\nOptional\u003cjava.util.List\u003cCommentParser.CommentResult\u003e\u003e result = CommentParser.extractComments(Paths.get(\"C:\\\\java.java\").toUri(), \"java.java\");\n```\n\n`InputStream` object can be used to first parameter.\n\n```java\nimport io.github.qwefgh90.commentparser.CommentParser;\nimport java.nio.file.Paths;\nimport java.io.InputStream;\nimport java.io.File;\nimport java.util.Optional;\nimport java.util.List;\nFile f = Paths.get(\"C:\\\\java.java\").toFile();\nInputStream is = new FileInputStream(f);\nOptional\u003cjava.util.List\u003cCommentParser.CommentResult\u003e\u003e result = CommentParser.extractComments(is, \"java.java\");\nis.close();\n```\n\nYou can pass `Charset` object to third parameter optionally. \n```java\nimport io.github.qwefgh90.commentparser.CommentParser;\nimport java.nio.file.Paths;\nimport java.nio.charset.StandardCharsets;\nimport java.util.Optional;\nimport java.util.List;\nOptional\u003cjava.util.List\u003cCommentParser.CommentResult\u003e\u003e result = CommentParser.extractComments(Paths.get(\"C:\\\\java.java\").toUri(), \"java.java\", StandardCharsets.UTF_8);\n```\n\nFor more information, [You can check API document.](https://qwefgh90.github.io/comment-parser/)\n\n## Supported Languages\n\n- JAVA\n- PY\n- C\n- CPP\n- C_HEADER\n- CPP_HEADER\n- SCALA\n- RUBY\n- GO\n- JS\n- HTML\n- BAT\n- SH\n- XML\n- TEXT\n- MD\n- ETC\n\n## Compile \u0026 Test\n\n- sbt compile\n- sbt test\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqwefgh90%2Fcomment-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqwefgh90%2Fcomment-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqwefgh90%2Fcomment-parser/lists"}