solidjs / solidjs/solid-vite-plugin

Document how to build a library for SolidJS

Abierto
#97 3 comentarios 11 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
TypeScript
Estrellas
520
Forks
70
Merge medio
23 h 35 min
PR fusionados (30 d)
39

Descripción

My team had difficulties in building a component library for SolidJS because we couldn't find any documentation for it.

We have a monorepo where one package is an application which should use components from another package in the repo.
Each has their own build. We use Vite and vite-plugin-solid to build.

vite-plugin-solid seems to use the package.json exports field with a custom import condition solid.

We couldn't find any documentation about this behavior (if there is one please let me know). Only after scouring through this plugin's source code and the NodeJs docs and looking at existing SolidJS component libs we got some idea about how this works.

IMO it the documentation should answer the following questions:

  • How to build a library for solid JS components?
  • How to use package.json exports to export SolidJS code
  • What's the difference in libraries compared to VDOM Frameworks like React, Vue etc (build done by the application vs build done in each package)
  • What's the recommended approach for building in combination with Typescript and/or some CSS preprocessing.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con el código fuente de vite-plugin-solid, la documentación de Node.js sobre package.json exports y las bibliotecas de componentes SolidJS existentes mencionadas en el issue. Se considera completado cuando se añada documentación que explique los builds de bibliotecas SolidJS, la condición de exportación solid, los builds de aplicaciones frente a los de paquetes y los enfoques recomendados para el preprocesamiento de TypeScript y CSS.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript, vite
Área
build-system, documentation, frontend
Tipo de issue
Documentación
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
28/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.