{"id":16203990,"url":"https://github.com/mottie/github-reserved-names","last_synced_at":"2025-11-01T02:30:27.963Z","repository":{"id":38153754,"uuid":"94595371","full_name":"Mottie/github-reserved-names","owner":"Mottie","description":"Get a list, or check if a user or organization name is reserved by GitHub","archived":false,"fork":false,"pushed_at":"2024-08-20T13:43:04.000Z","size":106,"stargazers_count":50,"open_issues_count":0,"forks_count":6,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-02-17T06:06:08.893Z","etag":null,"topics":["github","node","organization","reserved","users"],"latest_commit_sha":null,"homepage":"https://npm.im/github-reserved-names","language":"JavaScript","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/Mottie.png","metadata":{"files":{"readme":"README.md","changelog":"history.md","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":"2017-06-17T02:25:39.000Z","updated_at":"2024-10-26T19:18:57.000Z","dependencies_parsed_at":"2024-01-16T06:12:19.060Z","dependency_job_id":"4b4c2c48-cb44-4436-8aef-6d831dc555bb","html_url":"https://github.com/Mottie/github-reserved-names","commit_stats":{"total_commits":102,"total_committers":11,"mean_commits":9.272727272727273,"dds":"0.18627450980392157","last_synced_commit":"c104ac1931b98471fa2434814ece058182878f4b"},"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mottie%2Fgithub-reserved-names","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mottie%2Fgithub-reserved-names/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mottie%2Fgithub-reserved-names/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mottie%2Fgithub-reserved-names/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mottie","download_url":"https://codeload.github.com/Mottie/github-reserved-names/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239248417,"owners_count":19607013,"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":["github","node","organization","reserved","users"],"created_at":"2024-10-10T09:55:53.537Z","updated_at":"2025-11-01T02:30:27.919Z","avatar_url":"https://github.com/Mottie.png","language":"JavaScript","readme":"# GitHub-reserved-names [![NPM Version][npm-image]][npm-url]\n\n[npm-url]: https://npmjs.org/package/github-reserved-names\n[npm-image]: https://img.shields.io/npm/v/github-reserved-names.svg\n\n\u003e Get a list, or check if a user or organization name is reserved by GitHub\n\nThe list comprises user or organization names that GitHub reserves for special use, e.g. the `new` in `https://github.com/new` is a reserved name and is contained in this list.\n\n**Update 11/11/2019** Sites are now reported as being \"unavailable\" or \"taken\"; we can no longer determine if a name is reserved. All new additions will be included in the reserved list and marked as reserved.\n\nThis is *by no means a complete list* of reserved GitHub user/organization names.\n\nThe list in this repository was gathered from several sources:\n\n* [Octotree](https://github.com/buunguyen/octotree/) ([ref](https://github.com/buunguyen/octotree/blob/master/src/adapters/github.js#L1-L12)).\n* [GitHub Hovercard](https://github.com/Justineo/github-hovercard/) ([ref](https://github.com/Justineo/github-hovercard/blob/master/src/hovercard.js#L35-L42)).\n* [GitHub Custom Hotkeys Userscript](https://github.com/Mottie/GitHub-userscripts/wiki/GitHub-custom-hotkeys) ([ref](https://github.com/Mottie/GitHub-userscripts/blob/master/github-custom-hotkeys.user.js#L58-L90)).\n* [shorten-repo-url](https://github.com/fregante/shorten-repo-url) ([ref](https://github.com/fregante/shorten-repo-url/blob/master/index.js#L9)).\n* Manually entering names into https://github.com/account/organizations/new and seeing it labeled as \"Reserved\". **Update** Sites are now reported as \"unavailable\".\n* And a lot of hard work by [@strafe](https://github.com/strafe). Thanks!\n\nSee the [history page](./history.md) for more details and how you can help expand this list.\n\n## Oddballs\n\nThere are a few names that have been added or omitted because of their behavior, these are listed in the [oddballs](./oddballs.md) read me.\n\nIn version 1.1.0, an `oddballs.json` has been included along with an API function \u0026 command-line interface (CLI; removed in v2.0.0). The data returned by the oddballs function is described in the [oddballs](./oddballs.md#oddballs-object-keys) read me.\n\n## Install\n\n```\n$ npm install --save github-reserved-names\n```\n\n## Usage\n\nPass a `name` (e.g. `settings` from `https://github.com/settings`) parameter to the `check` or `oddballs` function.\n\n```js\nconst isReserved = require('github-reserved-names');\n\nisReserved.check(\"settings\");\n//=\u003e true\n\nisReserved.check(\"google\");\n//=\u003e false\n\nisReserved.all;\n// [ 400, 401, 402, ..., \"www8\", \"www9\" ]\n\nisReserved.oddballs(\"avatars\");\n// { reserved: true, taken: true, typical: true, included: false }\n\nisReserved.oddballs();\n// [ \"account\", \"apps\", ..., \"wiki\", \"windows\" ]\n```\n\n*NOTE*: Also make sure to check that the username doesn't include invalid alphanumeric characters; such is the case for the url of a [private feed](./oddballs.md#private-feed).\n\n## API\n\n### `.all`\n\nType: `array`\n\nCurrent list of gathered GitHub reserved names.\n\n### `.check(name)`\n\nType: `function`\n\nReturns a boolean of `true` if the `name` parameter is in the reserved list, `false` if not.\n\n### `.oddballs(name)`\n\nType: `function`\n\nIf `name` is in the list, this function returns data related to the named oddball; otherwise it returns an array of oddballs pages.\n\n## CLI\n\nRemoved in v2.0.0.\n\n## Related\n\n- [github-url-detection](https://github.com/fregante/github-url-detection) - Check what type of GitHub page you’re on (includes `github-reserved-names`).\n\n## License\n\nMIT\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmottie%2Fgithub-reserved-names","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmottie%2Fgithub-reserved-names","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmottie%2Fgithub-reserved-names/lists"}