@imolko/ultra-reporter

Como usar ultra-reporter

1. Instale el paquete @imolko/ultra-reporter en su ultima version:

npm install @imolko/ultra-reporter

2. Agregue la siguiente configuracion al jest en su archivo jest.config.js:

module.exports = {
  ...
  reporters: [
    "default",
    [
      "jest-html-reporters",
      {
        publicPath: "./html-report",
        filename: "journal.html",
        openReport: true,
        pageTitle: "Journal report",
      },
    ],
    [
      "./ultra-reporter-workspace/generate-domain-documentation.js",
      {
        contextName: "my-context",
      },
    ],
  ],
  ...
};

Nota: El valor de contextName debe ser el nombre del contexto que se esta documentando.

3. Corra el comando para crear/actualizar los archivos relacionados con la documentacion:

npx @imolko/ultra-reporter

4. Corra los test de jest:

npm run test

ó

npx jest

5. Estando dentro de la carpeta documentation instale las dependencias:

npm install

6. Corra el servidor de documentacion:

npm run start

Consideraciones

1. La documentacion relacionada al contexto debe estar en un archivo llamado context-intro.md en la carpeta src.

2. Este paquete asume que la estructura de los archivos en la capeta src hace uso del paquete @imolko/ultra-ddd y por tanto tiene una estructura como la siguiente:

src
├── domain
│   ├── Artifact1
│   │   ├── attachments.md
│   │   ├── conditions.ts
│   │   ├── definition.ts
│   │   ├── definition.yaml
│   │   ├── entity.spec.ts
│   │   ├── entity.ts
│   │   ├── index.ts
│   │   ├── payload.ts
│   │   ├── primitive.ts
│   │   ├── props.ts
│   └── Artifact2
│   │   ├── ...
├── features
│   ├── Feature1
│   └── Feature2
└── context-intro.md

Los archivos attachments.md y definition.yaml contiene parte importante de la documentacion de los artefactos, por lo que es importante que esten presentes en la estructura de los archivos y este bien documentados.

3. En la carpeta documentation se generan los archivos relacionados con la documentacion de los artefactos y una introducccion al contexto.

4. Dentro de documentation no se pueden realizar cambios a los archivos generados:

• documentation/docs/aggragate/*
• documentation/docs/domain/*
• documentation/docs/intro.md

5. Dentro de documentation hay archivos que deben ser editados para ajustarlos a cada contexto, como:

• /documentation/docusaurus.config.ts

6. Dentro de documentation se pueden generar paginas y blogs para documentar de forma manual otros aspectos del contexto. Vea Docusaurus