Skip to content
This repository was archived by the owner on Jan 18, 2022. It is now read-only.
This repository was archived by the owner on Jan 18, 2022. It is now read-only.

Complete rollup example for Vue 2 component lang="ts" #382

@mesqueeb

Description

@mesqueeb

What problem does this feature solve?

If we have a single Vue 2 component with lang="ts", and we want to host this component on NPM to use it in multiple projects,
it's not 100% clear to me - given the requirements below - how to best use rollup to prepare the component for publishing on NPM.

Requirements:

  • generate .d.ts file based on prop types.
  • make sure the .d.ts creates autocomplete suggestions for props in VSCode when the component is imported into a project
  • make sure the component is usable in JS projects
  • make it clear how the component can be written in a way it's compatible with Vue 3 projects (or is this not possible at all?)
  • bonus feature: convert "sass" style-block to regular "css"

If there's a concrete example of how to do the above, I believe that would benefit a lot of Vue developers that wanna publish single Vue components!

What does the proposed API look like?

An example of such an example would be:

  1. example input from vue file:
<template>// ...
<style>// ...
<script lang="ts">// ...
  1. required config:
// required rollup config file contents
  1. execute this:
# the command we need to execute to rollup the component
  1. this will be the compiled output:
// an example of what kind of file is generated based on the above

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions