{"id":16720387,"url":"https://github.com/tomokimiyauci/registerable","last_synced_at":"2026-04-16T04:01:17.600Z","repository":{"id":37074066,"uuid":"367765700","full_name":"TomokiMiyauci/registerable","owner":"TomokiMiyauci","description":"Check if it can be registered as a package name or domain name","archived":false,"fork":false,"pushed_at":"2022-12-08T20:05:08.000Z","size":773,"stargazers_count":1,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-29T01:26:03.563Z","etag":null,"topics":["check","deno","denoland","name","nestland","node","npm","registry"],"latest_commit_sha":null,"homepage":"https://registerable.vercel.app","language":"TypeScript","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/TomokiMiyauci.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":"FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null},"funding":{"github":"TomokiMiyauci","patreon":"tomoki_miyauci"}},"created_at":"2021-05-16T02:02:00.000Z","updated_at":"2022-07-13T18:58:17.000Z","dependencies_parsed_at":"2023-01-25T17:46:19.314Z","dependency_job_id":null,"html_url":"https://github.com/TomokiMiyauci/registerable","commit_stats":null,"previous_names":["tomokimiyauci/nameable"],"tags_count":35,"template":false,"template_full_name":null,"purl":"pkg:github/TomokiMiyauci/registerable","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TomokiMiyauci%2Fregisterable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TomokiMiyauci%2Fregisterable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TomokiMiyauci%2Fregisterable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TomokiMiyauci%2Fregisterable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TomokiMiyauci","download_url":"https://codeload.github.com/TomokiMiyauci/registerable/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TomokiMiyauci%2Fregisterable/sbom","scorecard":{"id":142795,"data":{"date":"2025-08-11","repo":{"name":"github.com/TomokiMiyauci/registerable","commit":"127898d3aad4acea5af06eda85fe32cfcf4a3cbf"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.2,"checks":[{"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":"Security-Policy","score":4,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Warn: no linked content found","Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1","Info: Found text in security policy: SECURITY.md:1"],"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":"Code-Review","score":0,"reason":"Found 0/9 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":"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":"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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1","Warn: no topLevel permission defined: .github/workflows/release-eggs.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Warn: no topLevel permission defined: .github/workflows/test.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":"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/codeql-analysis.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/codeql-analysis.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-eggs.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release-eggs.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-eggs.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release-eggs.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:113: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:116: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:126: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:141: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:143: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:147: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:160: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:165: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:169: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:174: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/test.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/test.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/TomokiMiyauci/registerable/test.yml/main?enable=pin","Info:   0 out of  22 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   6 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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: 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 'main'","Warn: branch protection not enabled for branch 'beta'"],"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":7,"reason":"SAST tool detected but not run on all commits","details":["Info: SAST configuration detected: CodeQL","Warn: 0 commits out of 27 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":"80 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-p2fh-2h23-6grg","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-7gc6-qh9x-w6h8","Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq","Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488","Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g","Warn: Project is vulnerable to: GHSA-6vfc-qv3f-vr6c","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-qrpm-p2h7-hrv2","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-76c9-3jph-rj3q","Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j","Warn: Project is vulnerable to: GHSA-gj77-59wh-66hg","Warn: Project is vulnerable to: GHSA-hqhp-5p83-hx96","Warn: Project is vulnerable to: GHSA-3949-f494-cm99","Warn: Project is vulnerable to: GHSA-x7hr-w5r2-h6wg","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-mv48-hcvh-8jj8","Warn: Project is vulnerable to: GHSA-353f-5xf4-qw67","Warn: Project is vulnerable to: GHSA-64vr-g452-qvp3","Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx","Warn: Project is vulnerable to: GHSA-vg6x-rcgg-rjx6","Warn: Project is vulnerable to: GHSA-x574-m823-4x7w","Warn: Project is vulnerable to: GHSA-4r4m-qw57-chr8","Warn: Project is vulnerable to: GHSA-xcj6-pq6g-qj4x","Warn: Project is vulnerable to: GHSA-356w-63v5-8wf4","Warn: Project is vulnerable to: GHSA-859w-5945-r5v3","Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-2h3h-q99f-3fhc","Warn: Project is vulnerable to: GHSA-gmw6-94gg-2rc2","Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","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-rc47-6667-2j5j","Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj","Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf","Warn: Project is vulnerable to: GHSA-px4h-xg32-q955","Warn: Project is vulnerable to: GHSA-hj9c-8jmm-8c52","Warn: Project is vulnerable to: GHSA-v39p-96qg-c8rf","Warn: Project is vulnerable to: GHSA-8v63-cqqc-6r2c","Warn: Project is vulnerable to: GHSA-3j8f-xvm3-ffx4","Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653","Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj","Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67","Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w","Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2","Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-x2pg-mjhr-2m5x","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx","Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v","Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7","Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7"],"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-16T08:34:19.852Z","repository_id":37074066,"created_at":"2025-08-16T08:34:19.852Z","updated_at":"2025-08-16T08:34:19.852Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31870516,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T15:24:51.572Z","status":"online","status_checked_at":"2026-04-16T02:00:06.042Z","response_time":69,"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":["check","deno","denoland","name","nestland","node","npm","registry"],"created_at":"2024-10-12T22:06:57.013Z","updated_at":"2026-04-16T04:01:17.580Z","avatar_url":"https://github.com/TomokiMiyauci.png","language":"TypeScript","funding_links":["https://github.com/sponsors/TomokiMiyauci","https://patreon.com/tomoki_miyauci","https://www.patreon.com/tomoki_miyauci"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"logo image\" src=\"https://res.cloudinary.com/dz3vsv9pg/image/upload/v1622682435/projects/registerable/logo.png\" /\u003e\n  \u003ch1 align=\"center\"\u003eRegisterable\u003c/h1\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\nCheck if it can be registered as a package name or domain name\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![test](https://github.com/TomokiMiyauci/registerable/actions/workflows/test.yml/badge.svg)](https://github.com/TomokiMiyauci/registerable/actions/workflows/test.yml)\n[![GitHub release](https://img.shields.io/github/release/TomokiMiyauci/registerable.svg)](https://github.com/TomokiMiyauci/registerable/releases)\n[![deno land](http://img.shields.io/badge/available%20on-deno.land/x-lightgrey.svg?logo=deno\u0026labelColor=black)](https://deno.land/x/registerable)\n[![nest badge](https://nest.land/badge.svg)](https://nest.land/package/registerable)\n[![deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/registerable/mod.ts)\n[![deno version](https://img.shields.io/badge/deno-^1.6.0-lightgrey?logo=deno)](https://github.com/denoland/deno)\n![node support version](https://img.shields.io/badge/node-%5E14.16.0-yellow)\n![bundle size](https://img.shields.io/bundlephobia/min/registerable)\n![npm download](https://img.shields.io/npm/dw/registerable?color=blue)\n\n[![dependencies Status](https://status.david-dm.org/gh/TomokiMiyauci/registerable.svg)](https://david-dm.org/TomokiMiyauci/registerable)\n[![codecov](https://codecov.io/gh/TomokiMiyauci/registerable/branch/main/graph/badge.svg?token=SPAi5Pv2wd)](https://codecov.io/gh/TomokiMiyauci/registerable)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/f43b1c317e11445399d85ce6efc06504)](https://www.codacy.com/gh/TomokiMiyauci/registerable/dashboard?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=TomokiMiyauci/registerable\u0026utm_campaign=Badge_Grade)\n![npm type definitions](https://img.shields.io/npm/types/registerable)\n![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)\n![Gitmoji](https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat)\n![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)\n\n\u003c/div\u003e\n\n---\n\n## :bookmark: Table of Contents\n\n- [:bookmark: Table of Contents](#bookmark-table-of-contents)\n- [:sparkles: Features](#sparkles-features)\n  - [Module registry](#module-registry)\n- [:memo: API](#memo-api)\n  - [CLI](#cli)\n    - [Deno](#deno)\n      - [Configuration](#configuration)\n      - [Local](#local)\n      - [Global](#global)\n    - [Node.js](#nodejs)\n      - [Local](#local-1)\n      - [Global](#global-1)\n  - [JavaScript API](#javascript-api)\n  - [Parameters](#parameters)\n    - [name [`required`]](#name-required)\n    - [option [`optional`]](#option-optional)\n    - [What is mode?](#what-is-mode)\n  - [Return value](#return-value)\n  - [Definition of error](#definition-of-error)\n  - [Examples](#examples)\n- [:green_heart: Supports](#green_heart-supports)\n  - [ES modules](#es-modules)\n  - [UMD](#umd)\n- [:handshake: Contributing](#handshake-contributing)\n- [:seedling: Show your support](#seedling-show-your-support)\n- [:bulb: License](#bulb-license)\n\n## :sparkles: Features\n\n- :zap: Multi runtime support (`Deno`, `Node.js`)\n- :books: Pure TypeScript and provides type definition\n- :earth_americas: Universal module, providing `ES modules` and `UMD`\n- :package: Optimized, super slim size\n- :page_facing_up: TSDoc-style comments\n\n### Module registry\n\n- [deno.land](https://deno.land/x/registerable)\n- [nest.land](https://nest.land/package/registerable)\n- [npm](https://www.npmjs.com/package/registerable)\n\n## :memo: API\n\n### CLI\n\nThe Cli interface is common to `Deno` and `Node.js`.\n\n```bash\n@runtime \u003cname\u003e [Options]\n```\n\n`@runtime`: How to call it depends on the runtime. See [Deno](#deno) or [Node.js](#nodejs) sections.\n\n`name`: Check module is registerable or not. `required`\n\n`Options`:  \n**All options are optional**\n\n| flag               | desc                   | type      | default                           | choice                          |\n| ------------------ | ---------------------- | --------- | --------------------------------- | ------------------------------- |\n| `-r`, `--registry` | Query to registry      | `array`   | [`deno.land`, `nest.land`, `npm`] | `deno.land`, `nest.land`, `npm` |\n| `-j`, `--json`     | Display to JSON format | `boolean` | `false`                           |\n| `--verbose`        | Verbose mode           | `boolean` | `true`                            |\n| `-h`, `--help`     | Show help              | `boolean` |                                   |                                 |\n| `-v`, `--version`  | Show version number    |           |                                   |\n\n#### Deno\n\n`@runtime`: `deno run --allow-net https://deno.land/x/registerable/cli.ts`\n\n##### Configuration\n\nRequired permissions:\n\n- --allow-net\n\n##### Local\n\nYou can use it directly from the CLI by using `deno run`:\n\n```bash\ndeno run --allow-net https://deno.land/x/registerable/cli.ts \u003cname\u003e [Options]\n```\n\n##### Global\n\nYou can also install it globally using the following:\n\n```bash\ndeno install --allow-net -n registerable https://deno.land/x/registerable/cli.ts\n```\n\nThen, the package is available to run:\n\n```bash\nregisterable \u003cname\u003e [Options]\n```\n\n#### Node.js\n\n##### Local\n\nYou can install locally.\n\n```bash\nyarn add -D registerable\nor\nnpm i -D registerable\n```\n\nthen,\n\n```bash\nyarn registerable \u003cname\u003e [Options]\nor\nnpm run registerable \u003cname\u003e [Options]\n```\n\n##### Global\n\nYou can also install it globally using the following:\n\n```bash\nyarn global add registerable\n\nregisterable \u003cname\u003e [Options]\n```\n\n### JavaScript API\n\nThe JavaScript API is the best way to call it programmatically.\n\nType Definition:\n\n```ts\ndeclare const registerable: \u003cT extends \"nest.land\" | \"npm\" | \"deno.land\"\u003e(\n  name: string,\n  option?: Partial\u003cOption\u003cT\u003e\u003e | undefined\n) =\u003e Promise\u003cRegisterableResult\u003cT\u003e\u003e;\n```\n\n### Parameters\n\nregisterable(`name`, `option`)\n\nThis function accept 2 arguments.\n\n#### name [`required`]\n\n| name   | type     | desc       |\n| ------ | -------- | ---------- |\n| `name` | `string` | Query name |\n\n#### option [`optional`]\n\n| name       | type     | desc                                                                           | default                           |\n| ---------- | -------- | ------------------------------------------------------------------------------ | --------------------------------- |\n| `registry` | `array`  | Pick the package registry to query. choice: `deno.land`, `nest.land` and `npm` | [`deno.land`, `nest.land`, `npm`] |\n| `mode`     | `string` | Specifies where this function is called. choice: `server` or `universal`       | `server`                          |\n\n#### What is mode?\n\nYou can avoid CORS errors by specifying the `mode`.\nFor `server` mode, it queries the public API in the package registry directly.\n\nWith the exception of `deno.land`, the public api response headers do not have the `Access-Control-Allow-Origin` property set.\nThat is, if call this function from browser, you will get a CORS error.\n\nTo avoid this, we have prepared a Proxy server.\nIt returns the result of running the `registerable` function on the server and the response header with `Access-Control-Allow-Origin: *` added.\n\nYou can get the result from the following URL:\n\n`https://registerable.vercel.app/check-name`\n\nMode of `universal` queries this URL and gets the same results as `server` mode without CORS errors.\n\nIf there is a possibility of calling the `registerable` function from a Browser such as `SPA` or `SSR`, the mode should be `universal`.\n\nHowever, if it is clear that it will be called only on the server side, it is recommended to use in `server` mode from the viewpoint of performance.\nTherefore, it is set to `server` mode by default.\n\n### Return value\n\nThe return value is a JSONObject that indicates whether it can be registered in the package registry, an error message if there is a validation error in query name, and which query caused the error.\n\n```ts\n{\n  result: {\n    \"deno.land\"?: boolean,\n    \"nest.land\"?: boolean,\n    npm?: boolean,\n  },\n  error: {\n     \"deno.land\"?: string,\n     \"nest.land\"?: string,\n      npm?: string,\n  },\n  hasError: boolean,\n  errorRegistry: (\"deno.land\" | \"nest.land\" | npm)[],\n  name: string,\n}\n```\n\n| name            | desc                                                                                    |\n| --------------- | --------------------------------------------------------------------------------------- |\n| `name`          | Same as query name                                                                      |\n| `result`        | Map of registry name and result of registerable or not                                  |\n| `error`         | Map of registry name and validation error message                                       |\n| `hasError`      | Set this flag to `true` if each registry query has more than one name validation error. |\n| `errorRegistry` | List the registry names that had validation errors                                      |\n\n### Definition of error\n\nIf the package name exists, it will not be treated as an error. Violation of the package name rules in each package registry will report an error.\n\nClick [here](https://github.com/TomokiMiyauci/is-valid-package-name/tree/beta) for package name validation rules.\n\nFor example, if there is a validation error as the package name for `deno.land` and `nest.land` :\n\n```ts\nconst { result, error, errorRegistry } = await registerable('exist-package-name')\n// result\n{\n  result: {\n    \"deno.land\": false,\n    \"nest.land\": false,\n    npm: true,\n  },\n  error: {\n     \"deno.land\": \"Name contains only the characters a-z, 0-9 and _\",\n     \"nest.land\": \"Name contains only the characters a-z, 0-9 and _\",\n  },\n  hasError: true,\n  errorRegistry: [\"deno.land\", \"nest.land\"],\n  name: \"exist-package-name\",\n}\n\nerrorRegistry.forEach((registry) =\u003e console.warn(registry, error[registry]))\n// deno.land \"Name contains only the characters a-z, 0-9 and _\"\n// nest.land \"Name contains only the characters a-z, 0-9 and _\"\n```\n\n### Examples\n\n```ts\nawait registerable('not_exist_package')\n// result\n{\n  result: {\n    \"deno.land\": true,\n    \"nest.land\": true,\n    npm: true,\n  },\n  error: {},\n  hasError: false,\n  errorRegistry: [],\n  name: \"not_exist_package\",\n}\n\nawait registerable('not_exist_package', {\n  registry: ['deno.land']\n})\n// result\n{\n  result: {\n    \"deno.land\": true\n  },\n  error: {},\n  hasError: false,\n  errorRegistry: [],\n  name: \"not_exist_package\",\n}\n```\n\n## :green_heart: Supports\n\nThe TypeScript version must be `4.1.0` or higher.\n\nThis project provide `ES modules` and `UMD`. The range supported by both is different.\n\n### ES modules\n\nLimit support to the latest environment to reduce the bundle size.\n\n| \u003cimg width=\"30px\" height=\"30px\" alt=\"Deno\" src=\"https://res.cloudinary.com/dz3vsv9pg/image/upload/v1620998361/logos/deno.svg\"\u003e\u003c/br\u003eDeno | \u003cimg width=\"24px\" height=\"24px\" alt=\"Node.js\" src=\"https://res.cloudinary.com/dz3vsv9pg/image/upload/v1620998361/logos/nodejs.svg\"\u003e\u003c/br\u003eNode.js | \u003cimg width=\"24px\" height=\"24px\" alt=\"IE / Edge\" src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png\"\u003e\u003c/br\u003eEdge | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png\" alt=\"Firefox\" width=\"24px\" height=\"24px\" /\u003e\u003c/br\u003eFirefox | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png\" alt=\"Chrome\" width=\"24px\" height=\"24px\" /\u003e\u003c/br\u003eChrome | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png\" alt=\"Safari\" width=\"24px\" height=\"24px\" /\u003e\u003c/br\u003eSafari | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari-ios/safari-ios_48x48.png\" alt=\"iOS Safari\" width=\"24px\" height=\"24px\" /\u003e\u003c/br\u003eiOS Safari | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/samsung-internet/samsung-internet_48x48.png\" alt=\"Samsung\" width=\"24px\" height=\"24px\" /\u003e\u003c/br\u003eSamsung | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png\" alt=\"Opera\" width=\"24px\" height=\"24px\" /\u003e\u003c/br\u003eOpera |\n| --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| ^1.6.0                                                                                                                                  | ^14.16.0                                                                                                                                        | last 2 versions                                                                                                                                      | last 2 versions                                                                                                                                               | last 2 versions                                                                                                                                           | last 2 versions                                                                                                                                           | last 2 versions                                                                                                                                                           | last 2 versions                                                                                                                                                                 | last 2 versions                                                                                                                                       |\n\n### UMD\n\nBrowser is supporting since IE11.\n\n| \u003cimg width=\"24px\" height=\"24px\" alt=\"Node.js\" src=\"https://res.cloudinary.com/dz3vsv9pg/image/upload/v1620998361/logos/nodejs.svg\"\u003e\u003c/br\u003eNode.js | \u003cimg width=\"24px\" height=\"24px\" alt=\"IE / Edge\" src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png\"\u003e\u003c/br\u003eIE / Edge | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png\" alt=\"Firefox\" width=\"24px\" height=\"24px\" /\u003e\u003c/br\u003eFirefox | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png\" alt=\"Chrome\" width=\"24px\" height=\"24px\" /\u003e\u003c/br\u003eChrome | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png\" alt=\"Safari\" width=\"24px\" height=\"24px\" /\u003e\u003c/br\u003eSafari | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari-ios/safari-ios_48x48.png\" alt=\"iOS Safari\" width=\"24px\" height=\"24px\" /\u003e\u003c/br\u003eiOS Safari | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/samsung-internet/samsung-internet_48x48.png\" alt=\"Samsung\" width=\"24px\" height=\"24px\" /\u003e\u003c/br\u003eSamsung | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png\" alt=\"Opera\" width=\"24px\" height=\"24px\" /\u003e\u003c/br\u003eOpera |\n| ----------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| ^6.17.0                                                                                                                                         | IE11 / ^16                                                                                                                                                | ^60                                                                                                                                                           | ^61                                                                                                                                                       | ^10.1                                                                                                                                                     | ^10.3                                                                                                                                                                     | ^8.2                                                                                                                                                                            | ^48                                                                                                                                                   |\n\nCompared to `ES modules`, `UMD` has a bundle size increase of about 2.5x. Recommend using `ES modules` as much as possible.\n\n## :handshake: Contributing\n\nContributions, issues and feature requests are welcome!\u003cbr /\u003eFeel free to check [issues](https://github.com/TomokiMiyauci/equal/issues).\n\n## :seedling: Show your support\n\nGive a ⭐️ if this project helped you!\n\n\u003ca href=\"https://www.patreon.com/tomoki_miyauci\"\u003e\n  \u003cimg src=\"https://c5.patreon.com/external/logo/become_a_patron_button@2x.png\" width=\"160\"\u003e\n\u003c/a\u003e\n\n## :bulb: License\n\nCopyright © 2021-present [TomokiMiyauci](https://github.com/TomokiMiyauci).\n\nReleased under the [MIT](./LICENSE) license\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomokimiyauci%2Fregisterable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftomokimiyauci%2Fregisterable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomokimiyauci%2Fregisterable/lists"}