ngx-changelog
Muestra el changelog de la aplicación mediante un timeline; Show the changelog of the application using a timeline.
Instalación
npm install ngx-changelog --saveImportar el módulo
import { ChangelogModule } from 'ngx-changelog';
@NgModule({
imports: [
..
ChangelogModule,
..
]
})En example.component.html
<cmp-changelog [changelog]="changelog"></cmp-changelog>En example.component.ts
import { IChangelog, Colores, TipoLog } from 'ngx-changelog';
@Component({
selector: 'app-example',
templateUrl: './example.component.html',
styleUrls: ['./example.component.scss']
})
export class ExampleComponent {
changelog: IChangelog[];
constructor() {
this.changelog = [
{
version: 'v2.0.0',
dias: [
{
fecha: new Date('2018/09/22'),
logs: [
{
tipo: TipoLog.agregado,
color: Colores.success,
contenido: 'Agregado cambios en pedido cotizacion'
},
{
tipo: TipoLog.eliminado,
color: Colores.danger,
contenido: 'Eliminado pedido cotizacion'
}
]
},
{
fecha: new Date('2018/09/23'),
logs: [
{
tipo: TipoLog.agregado,
color: Colores.success,
contenido: 'Agregado cambios en pedido cotizacion'
},
{
tipo: TipoLog.eliminado,
color: Colores.danger,
contenido: 'Eliminado pedido cotizacion'
}
]
}
]
},
{
version: 'v1.0.0',
dias: [
{
fecha: new Date('2018/09/22'),
logs: [
{
tipo: TipoLog.agregado,
color: Colores.success,
contenido: 'Agregado cambios en pedido cotizacion'
},
{
tipo: TipoLog.eliminado,
color: Colores.danger,
contenido: 'Eliminado pedido cotizacion'
}
]
},
{
fecha: new Date('2018/09/23'),
logs: [
{
tipo: TipoLog.modificado,
color: Colores.info,
contenido: 'Agregado cambios en pedido cotizacion'
},
{
tipo: TipoLog.pruebas,
color: Colores.warning,
contenido: 'Eliminado pedido cotizacion'
}
]
}
]
}
];
}
}Testing
The following command runs unit & integration tests that are in the tests folder (you can change the folder in spec.bundle.js file):
npm testor in watch mode:
npm run test:watchIt also reports coverage using Istanbul.
Building
The following command:
npm run build- starts TSLint with Codelyzer using Angular TSLint Preset
- starts AoT compilation using ngc compiler
- creates
distfolder with all the files of distribution, following Angular Package Format (APF) v6.0:
└── dist
├── bundles
| ├── my-library.umd.js
| ├── my-library.umd.js.map
| ├── my-library.umd.min.js
| └── my-library.umd.min.js.map
├── esm5
| ├── **/*.js
| └── **/*.js.map
├── esm2015
| ├── **/*.js
| └── **/*.js.map
├── fesm5
| ├── my-library.js
| └── my-library.js.map
├── fesm2015
| ├── my-library.js
| └── my-library.js.map
├── src
| └── **/*.d.ts
├── my-library.d.ts
├── my-library.metadata.json
├── LICENSE
├── package.json
├── public_api.d.ts
└── README
To test locally the npm package before publishing:
npm run pack:libThen you can install it in an app to test it:
npm install [path]my-library-[version].tgzPublishing
Before publishing the first time:
- you can register your library on Travis CI: you have already configured
.travis.ymlfile - you must have a user on the npm registry: Publishing npm packages
npm run publish:libDocumentation
To generate the documentation, this starter uses compodoc:
npm run compodoc
npm run compodoc:serveAoT compilation
The library is compatible with AoT compilation.
License
MIT
