wordxml-builder

WordXML Builder

Librería TypeScript para construir documentos XML compatibles con Microsoft Word.

🚀 Características

• Construcción de documentos XML compatibles con Word
• Tipado fuerte con TypeScript
• API simple y fácil de usar
• Documentación completa

📋 Requisitos Previos

• Node.js (v14 o superior)
• npm (v6 o superior)

🛠️ Instalación

npm install wordxml-builder

💻 Uso

import { WordXMLBuilder } from 'wordxml-builder';

const builder = new WordXMLBuilder();
builder.addParagraph('Este es un párrafo de ejemplo');
const xmlContent = builder.getContent();

🏗️ Estructura del Proyecto

wordxml-builder/
├── src/                    # Código fuente
│   ├── index.ts           # Punto de entrada principal
│   ├── types/             # Definiciones de tipos
│   ├── builders/          # Clases constructoras
│   └── utils/             # Utilidades
├── dist/                   # Código compilado (generado)
├── tests/                  # Pruebas unitarias
├── docs/                   # Documentación
└── examples/              # Ejemplos de uso

🔧 Desarrollo

Instalación de Dependencias

npm install

Compilación

npm run build

Linting

npm run lint

Formateo de Código

npm run format

🧪 Testing

npm test

📦 Publicación

• Incrementa la versión en package.json siguiendo Semantic Versioning
• Actualiza el CHANGELOG.md
• Crea un nuevo tag en git
• Publica en npm:

npm publish

🔄 GitFlow

Este proyecto sigue la metodología GitFlow para el control de versiones:

Ramas Principales

• main: Código en producción
• develop: Código en desarrollo

Ramas de Soporte

• feature/*: Nuevas características
• bugfix/*: Corrección de errores
• hotfix/*: Correcciones urgentes en producción
• release/*: Preparación de releases

Flujo de Trabajo

• Crear una rama desde develop:

  git checkout -b feature/nueva-caracteristica develop
  

• Desarrollar y hacer commits:

  git commit -m "feat: agregar nueva característica"
  

• Fusionar con develop:

  git checkout develop
  git merge feature/nueva-caracteristica
  

• Crear release:

  git checkout -b release/1.0.0 develop
  

• Fusionar con main y develop:

  git checkout main
  git merge release/1.0.0
  git checkout develop
  git merge release/1.0.0
  

📝 Convención de Commits

Usamos Conventional Commits:

• feat: Nueva característica
• fix: Corrección de error
• docs: Cambios en documentación
• style: Cambios de formato
• refactor: Refactorización de código
• test: Agregar o corregir pruebas
• chore: Actualización de tareas, configuración, etc.

🔄 Versionamiento

Seguimos Semantic Versioning:

• MAJOR: Cambios incompatibles con versiones anteriores
• MINOR: Nuevas características compatibles
• PATCH: Correcciones de errores compatibles

Ejemplo: 1.2.3

• 1: Versión mayor
• 2: Versión menor
• 3: Parche

📄 Licencia

Este proyecto está bajo la Licencia MIT - ver el archivo LICENSE para más detalles.

🤝 Contribuciones

Las contribuciones son bienvenidas. Por favor, lee CONTRIBUTING.md para detalles sobre nuestro código de conducta y el proceso para enviar pull requests.