introsvect-beta v0.0.8

INTROSVECT

Generate a documentation of your sveltekit component library from it's source files.

how to use

npx introsvect-beta init
npx introsvect generate

output

    interface Library{
        name:string 
        version:string 
        description:string|null 
        components: [Component] 
    }

    interface Component{
        name: string 
        description: string|null 
        properties:[Property] 
        events:[Event]
        slots:[Slot]
    }

    interface Property{
        name: string
        type: string|null
        default: string|null
        description:string|null
    }

    interface Event{
        name: string
        description:string|null
    }

    interface Slot{
        name: string
        description:string|null
    }

descriptions

Descriptions can be added via comments:

<script lang="ts">
    type integer = number
    export let count:integer //@description{ set the initial value of the counter }
</script>