{"id":31128832,"url":"https://github.com/ijlee2/ember-codemod-add-component-signatures","last_synced_at":"2026-04-02T19:02:52.630Z","repository":{"id":176407876,"uuid":"656304094","full_name":"ijlee2/ember-codemod-add-component-signatures","owner":"ijlee2","description":"Codemod to add component signatures","archived":false,"fork":false,"pushed_at":"2025-12-29T13:49:05.000Z","size":921,"stargazers_count":14,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-16T05:23:30.597Z","etag":null,"topics":["codemod","ember-codemod","emberjs","embroider","glint","typescript"],"latest_commit_sha":null,"homepage":"","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/ijlee2.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-06-20T17:10:20.000Z","updated_at":"2025-12-29T13:48:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"4bc9be66-da62-4fc9-8d0f-b9882ee32699","html_url":"https://github.com/ijlee2/ember-codemod-add-component-signatures","commit_stats":null,"previous_names":["ijlee2/ember-codemod-args-to-signature","ijlee2/ember-codemod-add-component-signatures"],"tags_count":43,"template":false,"template_full_name":null,"purl":"pkg:github/ijlee2/ember-codemod-add-component-signatures","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ijlee2%2Fember-codemod-add-component-signatures","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ijlee2%2Fember-codemod-add-component-signatures/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ijlee2%2Fember-codemod-add-component-signatures/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ijlee2%2Fember-codemod-add-component-signatures/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ijlee2","download_url":"https://codeload.github.com/ijlee2/ember-codemod-add-component-signatures/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ijlee2%2Fember-codemod-add-component-signatures/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28845800,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T13:02:32.985Z","status":"ssl_error","status_checked_at":"2026-01-28T13:02:04.945Z","response_time":57,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":["codemod","ember-codemod","emberjs","embroider","glint","typescript"],"created_at":"2025-09-18T01:04:26.196Z","updated_at":"2026-03-16T13:01:17.450Z","avatar_url":"https://github.com/ijlee2.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![This project uses GitHub Actions for continuous integration.](https://github.com/ijlee2/ember-codemod-add-component-signatures/actions/workflows/ci.yml/badge.svg)](https://github.com/ijlee2/ember-codemod-add-component-signatures/actions/workflows/ci.yml)\n\n# ember-codemod-add-component-signatures\n\n_Codemod to add component signatures_\n\n\n## What is it?\n\nTo introduce Glint, you will need to write the [signature](https://typed-ember.gitbook.io/glint/environments/ember/component-signatures) and [template registry](https://typed-ember.gitbook.io/glint/environments/ember/template-registry) for each component. This can be an error-prone, onerous task for large projects.\n\nYou can run this codemod to get started.\n\n\n## Features\n\n- Scaffolds signature for components\n- Adds template registry for components (Glint v1)\n- Supports `\u003ctemplate\u003e` tag (Glint v2)\n\n\u003cdiv align=\"center\"\u003e\n  \u003cfigure\u003e\n    \u003cimg alt=\"A code diff to show what template-only components can look like before and after running ember-codemod-add-component-signatures\" src=\"https://github.com/ijlee2/ember-codemod-add-component-signatures/assets/16869656/55115b27-682e-4f5a-9a03-36d7aa1cc0c2\" width=\"640\"\u003e\n    \u003cbr\u003e\n    \u003cfigcaption\u003eTemplate-only components\u003c/figcaption\u003e\n  \u003c/figure\u003e\n  \u003cbr\u003e\u003cbr\u003e\n  \u003cfigure\u003e\n    \u003cimg alt=\"A code diff to show what Glimmer components can look like before and after running ember-codemod-add-component-signatures\" src=\"https://github.com/ijlee2/ember-codemod-add-component-signatures/assets/16869656/4feb1fcd-5a31-419e-9feb-2af99073ae75\" width=\"640\"\u003e\n    \u003cimg alt=\"Another code diff for a Glimmer component\" src=\"https://github.com/ijlee2/ember-codemod-add-component-signatures/assets/16869656/c8c1c9b0-28a1-4957-9c49-5cc853499a4f\" width=\"640\"\u003e\n    \u003cbr\u003e\n    \u003cfigcaption\u003eGlimmer components\u003c/figcaption\u003e\n  \u003c/figure\u003e\n\u003c/div\u003e\n\n\n## Usage\n\nStep 1. Quickly migrate.\u003csup\u003e1\u003c/sup\u003e\n\n```sh\ncd \u003cpath/to/your/project\u003e\npnpx ember-codemod-add-component-signatures \u003carguments\u003e\n```\n\nStep 2. Review the package.\n\n- [x] Fill in missing type information.\n- [x] Confirm that you can run all scripts in `package.json`.\n\nFor more information, please check the [FAQ](#frequently-asked-questions).\n\n\u003csup\u003e1. The codemod assumes that your apps and addons follow the Octane layout (flat or nested). If not, you can run codemods to move away from [classic](https://github.com/ember-codemods/ember-component-template-colocation-migrator) and [pod](https://github.com/ijlee2/ember-codemod-pod-to-octane).\u003c/sup\u003e\n\n\n### Arguments\n\n\u003cdetails\u003e\n\n\u003csummary\u003eOptional: Limit entity to consider\u003c/summary\u003e\n\nBy default, the codemod considers all files and folders for components, routes, and tests. Pass `--entity` to limit the search to 1 entity and its sub-entities (if any). You may use curly braces to specify multiple entities.\n\n```sh\n# `ui/form` only\npnpx ember-codemod-add-component-signatures --entity ui/form\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003eOptional: Specify the component structure\u003c/summary\u003e\n\nBy default, an Octane project has the flat component structure. Pass `--component-structure` to indicate otherwise.\n\n```sh\npnpx ember-codemod-add-component-signatures --component-structure nested\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003eOptional: Convert \u003ccode\u003e*.{js,gjs}\u003c/code\u003e files\u003c/summary\u003e\n\nBy default, the codemod ignores component classes written in `*.{js,gjs}`. Pass `--convert-javascript` to allow the codemod to change the file extension to `*.{ts,gts}` and add the component signature.\n\n```sh\npnpx ember-codemod-add-component-signatures --convert-javascript\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003eOptional: Create registries\u003c/summary\u003e\n\nBy default, the codemod doesn't add registries to component classes, because these registries are unnecessary for Glint v2 (strict mode templates). Pass `--create-registries` if you use Glint v1 (loose mode templates).\n\n```sh\npnpx ember-codemod-add-component-signatures --create-registries\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003eOptional: Specify the project root\u003c/summary\u003e\n\nPass `--root` to run the codemod on a project somewhere else (i.e. not in the current directory).\n\n```sh\npnpx ember-codemod-add-component-signatures --root \u003cpath/to/your/project\u003e\n```\n\n\u003c/details\u003e\n\n\n### Limitations\n\nThe codemod is designed to cover typical cases. It is not designed to cover one-off cases. (Classic components are not supported.)\n\nTo better meet your needs, consider cloning the repo and running the codemod locally.\n\n```sh\ncd \u003cpath/to/cloned/repo\u003e\n\n# Compile TypeScript\npnpm build\n\n# Run codemod\n./dist/bin/ember-codemod-add-component-signatures.js --root \u003cpath/to/your/project\u003e\n```\n\n\n## Compatibility\n\n- Node.js v22 or above\n\n\n## Contributing\n\nSee the [Contributing](CONTRIBUTING.md) guide for details.\n\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fijlee2%2Fember-codemod-add-component-signatures","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fijlee2%2Fember-codemod-add-component-signatures","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fijlee2%2Fember-codemod-add-component-signatures/lists"}