{"id":17119161,"url":"https://github.com/regadas/socco-ng","last_synced_at":"2025-09-06T10:31:31.537Z","repository":{"id":38040264,"uuid":"272975819","full_name":"regadas/socco-ng","owner":"regadas","description":"socco-ng is a fork from criteo/socco: A Scala compiler plugin to generate documentation from Scala source files.","archived":false,"fork":false,"pushed_at":"2025-08-16T19:49:37.000Z","size":388,"stargazers_count":2,"open_issues_count":6,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-16T21:21:41.136Z","etag":null,"topics":[],"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/regadas.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,"zenodo":null}},"created_at":"2020-06-17T13:04:34.000Z","updated_at":"2025-08-16T19:49:41.000Z","dependencies_parsed_at":"2024-02-01T19:41:22.613Z","dependency_job_id":"560f8da9-a419-4d09-a99a-0b91bea5187f","html_url":"https://github.com/regadas/socco-ng","commit_stats":{"total_commits":161,"total_committers":12,"mean_commits":"13.416666666666666","dds":0.577639751552795,"last_synced_commit":"e5175dd855482fd88a59a84d170731e980c010ad"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/regadas/socco-ng","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regadas%2Fsocco-ng","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regadas%2Fsocco-ng/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regadas%2Fsocco-ng/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regadas%2Fsocco-ng/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/regadas","download_url":"https://codeload.github.com/regadas/socco-ng/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regadas%2Fsocco-ng/sbom","scorecard":{"id":193729,"data":{"date":"2025-08-11","repo":{"name":"github.com/regadas/socco-ng","commit":"574fa81627aa70cc6d68029c3a2d3d2924cddb98"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.1,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","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":"Code-Review","score":10,"reason":"all changesets reviewed","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":"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":5,"reason":"6 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:6: update your workflow using https://app.stepsecurity.io/secureworkflow/regadas/socco-ng/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/regadas/socco-ng/ci.yaml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/regadas/socco-ng/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/regadas/socco-ng/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/regadas/socco-ng/ci.yaml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yaml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/regadas/socco-ng/ci.yaml/master?enable=pin","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned"],"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yaml:1","Info: no jobLevel write permissions found"],"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":"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":"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":"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":"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":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/ci.yaml:21"],"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 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-16T21:22:22.354Z","repository_id":38040264,"created_at":"2025-08-16T21:22:22.354Z","updated_at":"2025-08-16T21:22:22.354Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273892671,"owners_count":25186558,"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","status":"online","status_checked_at":"2025-09-06T02:00:13.247Z","response_time":2576,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-10-14T17:56:26.003Z","updated_at":"2025-09-06T10:31:31.460Z","avatar_url":"https://github.com/regadas.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"# socco-ng\n\n![build](https://github.com/regadas/socco-ng/workflows/ci/badge.svg)\n[![GitHub license](https://img.shields.io/github/license/regadas/socco-ng.svg)](./LICENSE)\n![Maven Central](https://img.shields.io/maven-central/v/io.regadas/socco-ng_2.13.10)\n\n**socco-ng** is a Scala compiler plugin to generate documentation from Scala source files. This is a fork from [criteo/socco](https://github.com/criteo/socco).\n\nIt produces HTML documents that display your comments alongside your code. Comments are passed through Markdown, and the Scala code is syntax highlighted, typed and linked to the appropriate API Doc.\n\n## Usage\n\nIf you use SBT, add the following settings to enable the plugin:\n\n```scala\nautoCompilerPlugins := true\naddCompilerPlugin(\"io.regadas\" %% \"socco-ng\" % \"0.1.8\")\n```\n\nIf you are using scalac directly, add the following option:\n\n```sh\n-Xplugin:io.regadas.socco-ng_2.13.10-0.1.8.jar\n```\n\nThis can be followed by any of the available options:\n\n- `-P:out:$outDir` to specify the output directory.\n- `-P:style:$stylesheetPath` to specify a custom stylesheet.\n- `-P:packagge_$packageName:$scalaDocUrl` to specify a Scala API doc to link.\n- `-P:header:$headerPath` to specify a custom HTML header.\n- `-P:footer:$footerPath` to specify a custom HTML footer.\n\n## Syntax\n\nThe plugin will handle all scala source files starting with a comment line like:\n\n```\n// Example: (.*)\n```\n\nThe captured group will be used as the example title in the generated HTML documents.\n\nThe comments can use Markdown syntax, and will be correctly rendered to the generated documentation.\n\nAlso, there is a special kind of comment:\n\n```\n// @className\n```\n\nWhen added on top of a code block, it will add the CSS class to the generated block. Allowing you to style it further wit CSS.\n\n## Prior art\n\n- [Docco](https://jashkenas.github.io/docco/) generates this kind of layout for CoffeeScript code. It has been ported to several other languages.\n- [Tut](https://github.com/tpolecat/tut) is a documentation tool that allow to embed (and compile) Scala code into Markdown documents. Which is exactly the opposite of Socco 😛.\n- [SXR](https://github.com/sbt/sxr) is Scala compiler plugin that turn source code into syntax highlighted and browsable HTML documents. It is outdated now but was a good source of inspiration for socco.\n\n## License\n\nThis project is licensed under the Apache 2.0 license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregadas%2Fsocco-ng","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fregadas%2Fsocco-ng","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregadas%2Fsocco-ng/lists"}