{"id":20082036,"url":"https://github.com/exercism/typescript-representer","last_synced_at":"2026-05-13T09:03:12.376Z","repository":{"id":39863249,"uuid":"356699776","full_name":"exercism/typescript-representer","owner":"exercism","description":null,"archived":false,"fork":false,"pushed_at":"2025-10-02T15:27:51.000Z","size":188,"stargazers_count":0,"open_issues_count":0,"forks_count":3,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-10-19T09:56:34.799Z","etag":null,"topics":["community-contributions-paused","exercism-representer","exercism-tooling","maintained-autonomous"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/exercism.png","metadata":{"funding":{"github":["exercism"],"custom":["https://exercism.org/donate"]},"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-04-10T21:32:39.000Z","updated_at":"2025-10-02T15:27:56.000Z","dependencies_parsed_at":"2025-08-04T20:36:32.008Z","dependency_job_id":"ec4879b3-5bb8-4378-83b6-befabc14122f","html_url":"https://github.com/exercism/typescript-representer","commit_stats":{"total_commits":22,"total_committers":5,"mean_commits":4.4,"dds":0.6363636363636364,"last_synced_commit":"4ca50f342b1d7f95e468c905f1682faa445d1714"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/exercism/typescript-representer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exercism%2Ftypescript-representer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exercism%2Ftypescript-representer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exercism%2Ftypescript-representer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exercism%2Ftypescript-representer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/exercism","download_url":"https://codeload.github.com/exercism/typescript-representer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exercism%2Ftypescript-representer/sbom","scorecard":{"id":387841,"data":{"date":"2025-08-11","repo":{"name":"github.com/exercism/typescript-representer","commit":"2d75c2610df6df361e2376ce62acdb246e9cd0ad"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.7,"checks":[{"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":"1 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":"Code-Review","score":6,"reason":"Found 15/25 approved changesets -- score normalized to 6","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":"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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.js.yml:1","Warn: topLevel 'contents' permission set to 'write': .github/workflows/deploy.yml:10","Warn: no topLevel permission defined: .github/workflows/format-code.yml:1","Warn: no topLevel permission defined: .github/workflows/pr.ci.js.yml:1","Warn: no topLevel permission defined: .github/workflows/verify-code-formatting.yml: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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU Affero General Public License v3.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":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/ci.js.yml:44"],"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":"Pinned-Dependencies","score":4,"reason":"dependency not pinned by hash detected -- score normalized to 4","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/exercism/typescript-representer/deploy.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pause-community-contributions.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/exercism/typescript-representer/pause-community-contributions.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ping-cross-track-maintainers-team.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/exercism/typescript-representer/ping-cross-track-maintainers-team.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/sync-labels.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/exercism/typescript-representer/sync-labels.yml/main?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:1","Warn: containerImage not pinned by hash: Dockerfile:20: pin your Docker image by updating node:lts-alpine to node:lts-alpine@sha256:1b2479dd35a99687d6638f5976fd235e26c5b37e8122f786fcd5fe231d63de5b","Info:  13 out of  13 GitHub-owned GitHubAction dependencies pinned","Info:   2 out of   6 third-party GitHubAction dependencies pinned","Info:   0 out of   2 containerImage 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":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: 'allow deletion' enabled on branch 'main'","Warn: 'force pushes' enabled on branch 'main'","Warn: 'branch protection settings apply to administrators' is disabled on branch 'main'","Warn: 'stale review dismissal' is disabled on branch 'main'","Warn: branch 'main' does not require approvers","Info: codeowner review is required on branch 'main'","Warn: 'last push approval' is disabled on branch 'main'","Warn: no status checks found to merge onto branch 'main'","Info: PRs are required in order to make changes on branch 'main'"],"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":"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 23 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"}},{"name":"Vulnerabilities","score":0,"reason":"27 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T17:06:18.389Z","repository_id":39863249,"created_at":"2025-08-18T17:06:18.390Z","updated_at":"2025-08-18T17:06:18.390Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32975183,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T06:31:55.726Z","status":"ssl_error","status_checked_at":"2026-05-13T06:31:51.336Z","response_time":115,"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":["community-contributions-paused","exercism-representer","exercism-tooling","maintained-autonomous"],"created_at":"2024-11-13T15:41:29.326Z","updated_at":"2026-05-13T09:03:12.369Z","avatar_url":"https://github.com/exercism.png","language":"TypeScript","funding_links":["https://github.com/sponsors/exercism","https://exercism.org/donate"],"categories":[],"sub_categories":[],"readme":"# @exercism/typescript-representer\n\n[![Deploy](https://github.com/exercism/typescript-representer/actions/workflows/deploy.yml/badge.svg)](https://github.com/exercism/typescript-representer/actions/workflows/deploy.yml)\n[![typescript-representer / main](https://github.com/exercism/typescript-representer/actions/workflows/ci.js.yml/badge.svg)](https://github.com/exercism/typescript-representer/actions/workflows/ci.js.yml)\n\n## Installation\n\nClone this repository and then run:\n\n```bash\nyarn install\n```\n\nYou'll need at least Node LTS for this to work.\n\n```\nyarn build\n```\n\n## Global installation\n\nIf you want to use this package as a local tool, you can install it globally, in order to make the \"binaries\" available:\n\n```shellscript\nyarn global add @exercism/typescript-representer\n```\n\nOn \\*nix systems or enabled shells (wsl, bash, git bash, etc.) you can now use `typescript-representer \u003cslug\u003e \u003cinput\u003e [\u003coutput\u003e] [-flag] [--flags]` to represent a local file (at `input`), or\n`typescript-representer-remote https://exercism.io/... [\u003coutput\u003e] [-flag] [--flags]` to work on a remote solution.\n\n## Usage\n\nIf you're developing this, you can run this via `yarn` or the provided shell script.\n\n- `.sh` enabled systems (UNIX, WSL): `yarn represent:dev`\n- `.bat` fallback (cmd.exe, Git Bash for Windows): `yarn represent:dev:bat`\n\nYou'll want these `:dev` variants because it will _build_ the required code (it will transpile from TypeScript to JavaScript, which is necessary to run this in Node environments, unlike Deno environments).\nWhen on Windows, if you're using Git Bash for Windows or a similar terminal, the `.sh` files will work, but will open a new window (which closes after execution).\nThe `.bat` scripts will work in the same terminal.\n\nYou can also manually build using `yarn` or `yarn build`, and then run the script directly: `./bin/represent.sh arg1 -o2 --option3`.\n\nRun this with the argument `help` to see how to use this:\n\n```shell\nyarn represent:dev:bat help\n\nUsage | represent.js \u003cexercise\u003e \u003cinput-directory\u003e [\u003coutput-directory\u003e] [options]\n\nOptions:\n ... see below\n\nExamples:\n  represent.js two-fer ~/typescript/two-fer/128/\n\n  Represent the two-fer solution from the input directory \"~/typescript/two-fer/128\"\n```\n\n### Options\n\n| short  | long                      | description                                                         |                                              |\n| ------ | ------------------------- | ------------------------------------------------------------------- | -------------------------------------------- |\n|        | `--version`               | Show version number                                                 | `boolean`                                    |\n| `-d`   | `--debug`                 | Unless given, only outputs warnings and errors                      | `boolean` (default: `false`)                 |\n| `-c`   | `--console`               | If given, outputs to the console                                    | `boolean` (default: `false`)                 |\n| `--or` | `--output_representation` | Path relative to the output dir where the representation is stored  | `string` (default: `\"./representation.txt\"`) |\n| `--om` | `--output_mapping`        | Path relative to the output dir where the mapping is stored         | `string` (default: `\"./mapping.json\"`)       |\n| `-u`   | `--ugly`                  | If given, does not format the JSON output using 2 space indentation | `boolean` (default: `false`)                 |\n|        | `--dry`                   | If given, does not output anything to disk                          | `boolean` (default: `false`)                 |\n| `-h`   | `--help`                  | Show help                                                           | `boolean`                                    |\n\nWhen using development, likely you'll want `-dc` to _also_ print the output and debug message to the console.\nYou can use `--dry` to prevent the script from writing to disk.\nWhen the `\u003coutput-directory\u003e` is not given, it default to the given `\u003cinput-directory\u003e`\n\n## Remote solutions\n\nThere are tools provided to run the representer on remote solutions.\n\n- `.sh` enabled systems (UNIX, WSL): `bin/scripts/remote.sh url`\n- `.bat` fallback (cmd.exe, Git Bash for Windows): `bin\\scripts\\remote.bat url`\n\nYou can pass the following type of URLs:\n\n- Published solutions: `/tracks/typescript/exercises/\u003cslug\u003e/\u003cid\u003e`\n- Mentor solutions: `/mentor/solutions/\u003cid\u003e`\n- Your solutions: `/my/solutions/\u003cid\u003e`\n- Private solutions: `/solutions/\u003cid\u003e`\n\n## Using docker\n\nTo create the image, execute the following command from the repository root:\n\n```bash\ndocker build -t exercism/typescript-representer .\n```\n\nTo `run` from docker pass in the solutions path as a volume and execute with the necessary parameters:\n\n```bash\ndocker run -v $(PATH_TO_SOLUTION):/solution exercism/typescript-representer ${SLUG} /solution\n```\n\nExample:\n\n```bash\ndocker run -v ~/solution-238382y7sds7fsadfasj23j:/solution exercism/typescript-representer two-fer /solution\n```\n\n## Formatting code\n\nThe easiest way to satisfy the code-format linter is to add a comment to your PR:\n\n```text\n/format\n```\n\nAlternatively, run the following command:\n\n```shell\n# Ensure that the version matches the version inside .github/format-code.yml\nEXERCISM_PRETTIER_VERSION=2.2.1 bin/format.sh\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexercism%2Ftypescript-representer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexercism%2Ftypescript-representer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexercism%2Ftypescript-representer/lists"}