{"_id":"@datawrapper/svelte-component-info","_rev":"16-a940ebc0e83776a3ce4b0532044dcd69","name":"@datawrapper/svelte-component-info","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@datawrapper/svelte-component-info","version":"0.1.0","keywords":["typescript","npm","ts","svelte","documentation","autogenerator","sveltejs","sveltekit"],"author":{"url":"Original author: Samuele C. De Tomasi","name":"Datawrapper GmbH"},"license":"MIT","_id":"@datawrapper/svelte-component-info@0.1.0","maintainers":[{"name":"lucguillemot","email":"luc.guillemot@gmail.com"},{"name":"sarcevic","email":"sarcevicantonio@gmail.com"},{"name":"jack_g","email":"jack@datawrapper.de"},{"name":"inga-datawrapper","email":"inga@datawrapper.de"},{"name":"elliot_b","email":"elliot@datawrapper.de"},{"name":"pabueco","email":"pbue@proton.me"},{"name":"msigwart","email":"marten@okamaja.de"},{"name":"gka","email":"gregor@datawrapper.de"},{"name":"ilokhov","email":"ilokhov.dev@gmail.com"},{"name":"davidkokkelink","email":"david@datawrapper.de"},{"name":"dw-deploy-bot","email":"hello@datawrapper.de"},{"name":"elanals","email":"elana@hotmail.co.uk"},{"name":"lisacrost","email":"lisacharlotterost@gmail.com"},{"name":"jakubdatawrapper","email":"jakub@datawrapper.de"},{"name":"exo_dw","email":"exo@datawrapper.de"},{"name":"anna-dw","email":"anna@datawrapper.de"},{"name":"davidw-dw","email":"david.wendler@datawrapper.de"},{"name":"danieladw","email":"daniela@datawrapper.de"},{"name":"margauxbourdon","email":"margaux@datawrapper.de"}],"homepage":"https://github.com/el3um4s/svelte-get-component-info#readme","bugs":{"url":"https://github.com/el3um4s/svelte-get-component-info/issues"},"dist":{"shasum":"345c438dfef2b1c5fc304cd033fd794b548360cb","tarball":"https://registry.npmjs.org/@datawrapper/svelte-component-info/-/svelte-component-info-0.1.0.tgz","fileCount":23,"integrity":"sha512-ks9wltHsth5SQB4cso0joxoAM1dMaJi7NdQ9vToFX4qrbGn+8/u+dOrRLaZVMF85DuY8CEz0asiQ+baORYqo+g==","signatures":[{"sig":"MEYCIQC+U7Hy58CGSbK3fEl3KuFdBJOiq8Fnqi/18ZLPwDC/CQIhAIaxR42p5zehGtzmsO4dyGbMIxlDLHk4s4nGKhavQNb4","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":17096},"main":"lib/index.js","types":"lib/index.d.ts","gitHead":"a14ef4f3c899ba435337f3fdba455fe2c68b67b5","scripts":{"lint":"eslint . --ext .ts","test":"jest --config jestconfig.json","build":"tsc","prepare":"npm run build","version":"git add -A src","preversion":"npm run lint","postversion":"git push && git push --tags","check-updates":"npx npm-check-updates","version:patch":"npm version patch","prepublishOnly":"npm test && npm run lint","test:no-coverage":"jest --config jestconfig.json --coverage=false","check-updates:minor":"npx npm-check-updates --target minor","check-updates:patch":"npx npm-check-updates --target patch"},"_npmUser":{"name":"msigwart","email":"marten@okamaja.de"},"repository":{"url":"git+https://github.com/datawrapper/svelte-component-info.git","type":"git"},"_npmVersion":"7.24.2","description":"A library to read the component infos from Svelte source code","directories":{},"_nodeVersion":"18.7.0","dependencies":{"@el3um4s/to-try":"^0.0.5"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^27.4.5","eslint":"^8.5.0","ts-jest":"^27.1.2","typescript":"^4.5.4","@types/jest":"^27.0.3","@types/node":"^17.0.5","eslint-plugin-node":"^11.1.0","eslint-plugin-import":"^2.25.3","eslint-plugin-promise":"^6.0.0","eslint-config-prettier":"^8.3.0","eslint-config-standard":"^16.0.3","@typescript-eslint/parser":"^5.8.1","@typescript-eslint/eslint-plugin":"^5.8.1"},"_npmOperationalInternal":{"tmp":"tmp/svelte-component-info_0.1.0_1689944984796_0.16000124813763628","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-07-21T13:09:44.668Z","modified":"2025-11-19T11:06:28.323Z","0.1.0":"2023-07-21T13:09:44.943Z"},"bugs":{"url":"https://github.com/el3um4s/svelte-get-component-info/issues"},"author":{"url":"Original author: Samuele C. De Tomasi","name":"Datawrapper GmbH"},"license":"MIT","homepage":"https://github.com/el3um4s/svelte-get-component-info#readme","keywords":["typescript","npm","ts","svelte","documentation","autogenerator","sveltejs","sveltekit"],"repository":{"url":"git+https://github.com/datawrapper/svelte-component-info.git","type":"git"},"description":"A library to read the component infos from Svelte source code","maintainers":[{"email":"gregor@datawrapper.de","name":"gka"},{"email":"ilokhov.dev@gmail.com","name":"ilokhov"},{"email":"david@datawrapper.de","name":"davidkokkelink"},{"email":"hello@datawrapper.de","name":"dw-deploy-bot"},{"email":"elana@hotmail.co.uk","name":"elanals"},{"email":"jack@datawrapper.de","name":"jack_g"},{"email":"lisacharlotterost@gmail.com","name":"lisacrost"},{"email":"exo@datawrapper.de","name":"exo_dw"},{"email":"david.wendler@datawrapper.de","name":"davidw-dw"},{"email":"julian@datawrapper.de","name":"julian_freyberg"},{"email":"alex@datawrapper.de","name":"alex.datawrapper"},{"email":"daniela@datawrapper.de","name":"danieladw"},{"email":"margaux@datawrapper.de","name":"margauxbourdon"},{"email":"marten@okamaja.de","name":"msigwart"},{"email":"sarcevicantonio@gmail.com","name":"sarcevic"},{"email":"pbue@proton.me","name":"pabueco"},{"email":"elliot@datawrapper.de","name":"elliot_b"},{"email":"jonathan@datawrapper.de","name":"jonathanmuth-datawrapper"},{"email":"linus.aarnio@gmail.com","name":"linusaarnio"},{"email":"gustav@datawrapper.de","name":"gustavkneustadt"},{"email":"erle@datawrapper.de","name":"erle"},{"email":"luc.guillemot@gmail.com","name":"lucguillemot"},{"email":"alicia@datawrapper.de","name":"dataliciawrapper"},{"email":"moritz@datawrapper.de","name":"moritz-dw"},{"email":"ceren@datawrapper.de","name":"cerendo"},{"email":"jona@datawrapper.de","name":"jonawrapper"}],"readme":"# Svelte - Get Component Info\n\n_A function to extract information about the props, actions, slots and css variables from a Svelte file. Designed to simplify the creation of documentation_\n\nNPM link: [@el3um4s/svelte-get-component-info](https://www.npmjs.com/package/@el3um4s/svelte-get-component-info)\n\nI recommend using it with [el3um4s/svelte-component-info](https://github.com/el3um4s/svelte-component-info) (npm: [@el3um4s/svelte-component-info](https://www.npmjs.com/package/@el3um4s/svelte-component-info))\n\n### Install and use the package\n\nTo use the package in a project:\n\n```bash\nnpm i @el3um4s/svelte-get-component-info\n```\n\nand then in a file:\n\n```ts\nimport type { SvelteInformations } from \"@el3um4s/svelte-get-component-info\";\nimport { getInfo, readFileSvelte } from \"@el3um4s/svelte-get-component-info\";\n\nconst info: SvelteInformations = getInfo(readFileSvelte(\"./src/lib/hello.svelte\").content.content);\nconsole.log(info.props); //  [{ name: \"message\", type: \"string\", defaultValue: \"Hello World\" }]\nconsole.log(info.actions); /// [ { name: \"notify\" }]\n```\n\n`info` looks like this:\n\n```json\n{\n    \"props\": [\n        { \"name\": \"color\", \"type\":\"string\", \"defaultValue\":\"red\" },\n        { \"name\": \"steps\", \"type\":\"number\", \"defaultValue\":\"8\" }\n        { \"name\": \"title\", \"type\":\"string\" },\n        { \"name\": \"description\"}\n    ],\n    \"actions\": [\n        { \"name\": \"click\" },\n        { \"name\": \"hover\" },\n        { \"name\": \"customAction\" }\n    ],\n    \"slots\": [\n        { \"anonymous\": true },\n        { \"name\": \"header\", \"anonymous\": false },\n        { \"name\": \"footer\", \"anonymous\": false }\n    ],\n    \"css\": [\n      { \"name\": \"--color-primary\" },\n      { \"name\": \"--color-secondary\" }\n    ]\n}\n```\n\n### To Do List:\n\n- [x] get props:\n  - [x] name\n  - [x] type\n  - [x] defaultValue\n- [x] actions\n- [x] slots\n  - [x] anonyms\n  - [x] named\n- [x] css variables\n","readmeFilename":"README.md"}