@cbm-common/accounting-seat
v0.0.3
Published
This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.1.0.
Readme
AccountingSeat
This project was generated using Angular CLI version 20.1.0.
Code scaffolding
Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
ng generate component component-nameFor a complete list of available schematics (such as components, directives, or pipes), run:
ng generate --helpBuilding
To build the library, run:
cbm-accounting-seat — Documentación
Breve
accounting-seat es la librería que contiene el componente para visualizar y operar con asientos contables dentro del ecosistema CBM. Está pensada para integrarse tanto como componente standalone como parte de un módulo que pueda registrarse en la app principal.
Instalación (distribución interna)
La librería se publica como paquete local/privado con el nombre accounting-seat. Para instalarla desde un registro privado o desde dist/:
- Desde
disttras construir:
cd dist/accounting-seat
npm install --no-save ./- O, si está publicada en vuestro registro privado:
npm install --save accounting-seatUso rápido
Ejemplo mínimo (si se exporta como componente standalone CbmAccountingSeatComponent):
- Import en un componente padre (standalone):
import { CbmAccountingSeatComponent } from 'accounting-seat';
@Component({
standalone: true,
imports: [CbmAccountingSeatComponent],
template: `<cbm-accounting-seat [collectionOriginId]="''"></cbm-accounting-seat>`
})
export class Demo {}- Uso en plantilla HTML de la app (si la librería exporta un módulo
CbmAccountingSeatModule):
import { CbmAccountingSeatModule } from 'accounting-seat';
@NgModule({
imports: [CbmAccountingSeatModule]
})
export class AppModule {}Y en la plantilla:
<cbm-accounting-seat collectionOriginId="" ></cbm-accounting-seat>API (entradas / salida)
Nota: ajusta los nombres a los que exporta la librería en tu build. Ejemplo razonable de inputs que este componente suele exponer:
collectionOriginId: string— identificador del origen de datos a mostrar.disabled: boolean— desactiva la interacción.- Eventos emitidos:
save,cancel(EventEmitter) — si aplica.
Consulta el archivo src/app/cbm-common/components/accounting-seat/* del proyecto para confirmar las propiedades reales exportadas y actualiza esta sección si es necesario.
Desarrollo
Comandos útiles dentro del workspace raíz:
- Construir la librería (Angular CLI):
ng build accounting-seat- Ejecutar el script de Tailwind (se usa para compilar estilos locales):
# en el directorio projects/accounting-seat
npm run tailwind- Para trabajar en la librería y probarla desde la app principal:
- Ejecuta
ng build accounting-seat --watchy en otra terminal inicia la app principalnpm start. - Importa la librería desde
dist/accounting-seato publícala en tu registro local.
Publicación
- Asegúrate de actualizar la versión en
projects/accounting-seat/package.json. - Construye la librería:
ng build accounting-seat- Publica desde
dist:
cd dist/accounting-seat
npm publish --access restrictedTesting
Ejecuta los tests unitarios configurados en el workspace:
ng testSi la librería incluye pruebas propias en projects/accounting-seat, puedes ejecutar ng test accounting-seat.
Integración en la app (routing)
Para exponer el componente en el panel de componentes del ejemplo CBM, se añadió la ruta local cbm-common/components/accounting-seat y el enlace en el panel; para que la navegación funcione, el componente debe exportarse con el nombre AccountingSeat (o ajustar la import en components.routes.ts).
Comprobaciones a realizar tras integrar
- Asegúrate de que
projects/accounting-seat/src/public-api.tsexporta los símbolos que quieres usar (componente y/o módulo). - Confirma el nombre del paquete en
projects/accounting-seat/package.json(por defecto en este repositorio:accounting-seat).
Contribuir
- Crea una rama con tu cambio.
- Añade tests si modificas comportamiento.
- Abre un merge request con descripción y pasos para verificar.
Licencia
Incluye la información de licencia del repo principal aquí o reemplázala por la licencia que aplique a esta librería.
Contacto
Para dudas sobre integración o publicación, contacta al equipo CBM responsable del monorepo.
