meme-docs es una extensión para Visual Studio Code diseñada para documentar los componentes del monorepo de meme.js.
Características
Documenta eventos y triggers en archivos .mj.
Proporciona una vista jerárquica de los eventos y triggers en el panel de actividad.
Permite expandir, colapsar y recargar la vista de documentación desde la barra de comandos.
Instalación
Clona este repositorio en tu máquina local.
Abre Visual Studio Code y dirígete al directorio del proyecto.
Ejecuta el comando npm install para instalar las dependencias.
Usa vsce package para empaquetar la extensión.
Instala la extensión generada (.vsix) en VS Code.
Uso
Comandos Disponibles
Recargar: Recarga los datos de la documentación.
Colapsar: Colapsa todos los elementos en la vista de documentación.
Expandir: Expande todos los elementos en la vista de documentación.
Activación de la Extensión
La extensión se activa mediante los siguientes eventos:
onCommand:meme-docs.start
onLanguage:javascript
onStartupFinished
Panel de Actividad
La extensión agrega un nuevo contenedor de vista en la barra de actividad con el icono de meme.js. Dentro de este contenedor, encontrarás la vista "Documentador de meme.js" que muestra los eventos y triggers organizados jerárquicamente.
Desarrollo
Estructura del Proyecto
commands.js: Define los comandos y la lógica principal de la extensión.
provider_events.js: Proporciona los datos para la vista jerárquica de eventos y triggers.
transpilers.js: Contiene las funciones para analizar los archivos .mj.
Scripts de NPM
build: Empaqueta la extensión para su distribución.
deploy: Publica la extensión en el marketplace de VS Code.
Dependencias
meme-sdk: Biblioteca SDK utilizada para analizar y manejar los archivos de meme.js.
Contribuciones
Si deseas contribuir a este proyecto, por favor sigue los siguientes pasos:
Haz un fork de este repositorio.
Crea una nueva rama (git checkout -b feature/nueva-funcionalidad).
Realiza los cambios y haz commit (git commit -am 'Agrega nueva funcionalidad').
Sube los cambios a tu rama (git push origin feature/nueva-funcionalidad).
Abre un Pull Request.
Licencia
Este proyecto está bajo la licencia MIT. Consulta el archivo LICENSE para más detalles.
