{"id":16226203,"url":"https://github.com/ghostdevv/extractinator","last_synced_at":"2025-07-31T23:03:51.023Z","repository":{"id":200060107,"uuid":"704295008","full_name":"ghostdevv/extractinator","owner":"ghostdevv","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-24T04:52:11.000Z","size":253,"stargazers_count":6,"open_issues_count":9,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-01T23:40:39.536Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/ghostdevv.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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":"2023-10-13T00:54:50.000Z","updated_at":"2024-09-19T17:50:38.000Z","dependencies_parsed_at":"2024-07-12T15:14:02.632Z","dependency_job_id":"fa92a0cd-10eb-4c2d-b699-d71d85d05e98","html_url":"https://github.com/ghostdevv/extractinator","commit_stats":null,"previous_names":["ghostdevv/extractinator"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/ghostdevv/extractinator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghostdevv%2Fextractinator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghostdevv%2Fextractinator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghostdevv%2Fextractinator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghostdevv%2Fextractinator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ghostdevv","download_url":"https://codeload.github.com/ghostdevv/extractinator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ghostdevv%2Fextractinator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268133595,"owners_count":24201374,"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-07-31T02:00:08.723Z","response_time":66,"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-10T12:48:26.944Z","updated_at":"2025-07-31T23:03:50.994Z","avatar_url":"https://github.com/ghostdevv.png","language":"TypeScript","readme":"# Extractinator\n\nA tool to extract the api information from Svelte and TS/JS files. Extract slots, events, module exports, props, and css props all with parsed tsdoc comments.\n\n\u003cbr\u003e\n\n## Usage\n\nInstall\n\n`pnpm i -D extractinator`\n\nExtract\n\n`pnpm extractinator extract \u003cinput_folder\u003e \u003coutput_folder\u003e`\n\n\u003cbr\u003e\n\n## Requirements\n\n| Tool   | Version                           |\n| ------ | --------------------------------- |\n| Node   | v18 \u003e=                            |\n| TS     | 5.3 (other v5 may work, untested) |\n| Svelte | v4                                |\n\n\u003cbr\u003e\n\n## CLI\n\n```bash\n$ extractinator --help\n\n  Usage\n    $ extractinator \u003ccommand\u003e [options]\n\n  Available Commands\n    extract    Extract the nator\n\n  For more info, run any command with the `--help` flag\n    $ extractinator extract --help\n\n  Options\n    --version  -v   Displays current version\n    --help     -h   Displays this message\n    --quiet    -q   Disabled all logging\n    --verbose\t    Enables verbose logging\n```\n\n\u003cbr\u003e\n\n## JS API\n\n```ts\nimport { extractinator } from 'extractinator'\n\ninterface ExtractinatorOptions {\n\tinput: string\n\ttsdocConfigPath?: string\n}\n\nconst results = await extractinator({\n\t// Path to the input file(s).  Will recursively search for svelte and ts files.\n\tinput: './playground',\n\n\t// (optional) Path to a custom tsdoc config.  This will be merged with the internal config.\n\ttsdocConfigPath: './tsdoc.json',\n})\n```\n\n\u003cbr\u003e\n\n## Example\n\nInput:\n\n`Example.svelte`\n\n````html\n\u003c!-- \n\t@component\n\tExample Svelte Component\n\n\t@example Simple\n\t```html\n\t\u003cExample /\u003e\n\t```\n\n\t@example Slots\n\t```html\n\t\u003cExample\u003e\n\t\t\u003cdiv slot=\"test\"\u003eTest\u003c/div\u003e\n\t\u003c/Example\u003e\n--\u003e\n\n\u003cscript context=\"module\"\u003e\n\timport { writable } from 'svelte/store'\n\n\t/**\n\t * The state the component is in\n\t * @default true\n\t */\n\texport const state = (writable \u003c string) | number | (boolean \u003e true)\n\u003c/script\u003e\n\n\u003cscript lang=\"ts\"\u003e\n\t/**\n\t * Let the thing know whether it's on earth\n\t */\n\texport let isExample: boolean\n\u003c/script\u003e\n\n\u003cbutton on:click\u003e Is an example: {isExample} \u003c/button\u003e\n\n\u003cdiv\u003e\n\t\u003cslot {isExample} /\u003e\n\t\u003cslot name=\"test\" /\u003e\n\u003c/div\u003e\n````\n\nOutput:\n\n`Example.svelte.doc.json`\n\n````json\n{\n\t\"type\": \"svelte\",\n\t\"fileName\": \"Example.svelte\",\n\t\"filePath\": \"playground/Example.svelte\",\n\t\"comment\": {\n\t\t\"raw\": \"/**\\n * Example Svelte Component\\n *\\n * @example\\n *\\n * Simple\\n * ```html\\n * \u003cExample /\u003e\\n * ```\\n *\\n * @example\\n *\\n * Slots ```html \u003cExample\u003e \u003cdiv slot=\\\"test\\\"\u003eTest\u003c/div\u003e \u003c/Example\u003e\\n */\",\n\t\t\"summary\": \"Example Svelte Component\",\n\t\t\"examples\": [\n\t\t\t{\n\t\t\t\t\"name\": \"Simple\",\n\t\t\t\t\"content\": \"```html\\n\u003cExample /\u003e\\n```\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"name\": \"Slots\",\n\t\t\t\t\"content\": \"```html\\n\u003cExample\u003e\\n\\t\u003cdiv slot=\\\"test\\\"\u003eTest\u003c/div\u003e\\n\u003c/Example\u003e\"\n\t\t\t}\n\t\t]\n\t},\n\t\"componentName\": \"Example\",\n\t\"props\": [\n\t\t{\n\t\t\t\"comment\": {\n\t\t\t\t\"raw\": \"/**\\n * Let the thing know whether it's an example or not.\\n */\",\n\t\t\t\t\"summary\": \"Let the thing know whether it's an example or not.\"\n\t\t\t},\n\t\t\t\"name\": \"isExample\",\n\t\t\t\"type\": \"boolean\"\n\t\t}\n\t],\n\t\"events\": [\n\t\t{\n\t\t\t\"name\": \"click\",\n\t\t\t\"type\": \"HTMLElementEventMap\"\n\t\t}\n\t],\n\t\"slots\": [\n\t\t{\n\t\t\t\"name\": \"default\",\n\t\t\t\"props\": [\n\t\t\t\t{\n\t\t\t\t\t\"name\": \"isExample\",\n\t\t\t\t\t\"type\": \"boolean\"\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"name\": \"test\",\n\t\t\t\"props\": []\n\t\t}\n\t],\n\t\"exports\": [\n\t\t{\n\t\t\t\"comment\": {\n\t\t\t\t\"raw\": \"/**\\n * The state the component is in\\n *\\n * @default\\n *\\n * true\\n */\",\n\t\t\t\t\"summary\": \"The state the component is in\",\n\t\t\t\t\"defaultValue\": \"true\"\n\t\t\t},\n\t\t\t\"name\": \"state\",\n\t\t\t\"type\": \"Writable\u003cstring | number | boolean\u003e\"\n\t\t}\n\t]\n}\n````\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fghostdevv%2Fextractinator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fghostdevv%2Fextractinator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fghostdevv%2Fextractinator/lists"}