ng-enova v1.0.8

Ng-Enova

Este es un paquete que cuenta con una serie de módulos genéricos para su uso en proyectos de la empresa Enova.

Instalacion

Instala el paquete ng-enova usando npm y guardarlo como una dependencia de tu proyecto:

npm install --save ng-enova

Uso

Importa los módulos que desees utilizar en tu aplicación en la configuración de tu módulo principal (app.module.ts llamado generalmente).

import { EnovaGreetModule, EnovaButtonModule } from 'ng-enova'

@NgModule({
	imports: [
		EnovaGreetModule,
		EnovaButtonModule
	]
})

export class AppModule {}

Colaboracion

Si eres parte del equipo de Enova y te gustaría colaborar creando módulos, debes seguir los siguientes pasos.

1. Descarga este repo con git:

// Clone with HTTPS
git clone https://***.com/***/ng-enova.git

// Clone with SSH
git clone git@***.com:***/ng-enova.git

2. Escribe el nuevo módulo utilizando las reglas de estilos empleadas en los proyectos de Enova y respetando la estructura de carpetas despues mencionado.

3. Crea, prueba y sube tus cambios al repo, aumentando la versión del paquete siguiendo las reglas del versionamiento según npm.

4. Pública los cambios en npm con el siguiente comando.

npm publish

Si tienes dudas sobre la publicación en los paquetes de npm pueder mirar aquí para familiarizarte mas en ello

Scaffolding

|-- tsconfig.json
|-- rollup.config.js
|-- readme.md
|-- package.json
|-- package-lock.json
|-- gulpfile.js
|-- .gitignore
|-- .npmignore
|-- src/
	|-- index.ts
	|-- modules/
		|-- button/
			|-- index.ts
			|-- module.ts
			|-- components/
				|-- button/
					|-- component.ts
					|-- template.ts
					|-- style.ts
			|-- services
				|-- service-1.ts
				|-- service-2.ts
			|-- pipes
				|-- pipe-1.ts
				|-- pipe-2.ts
			|-- interfaces
				|-- interface-1.ts
				|-- interface-2.ts
			|-- directives
				|-- directive-1.ts
				|-- directive-2.ts
		|-- greet/
			|-- index.ts
			|-- module.ts
			|-- components/
				|-- greet/
					|-- component.ts
					|-- template.ts
					|-- style.ts

Todos los archivos que están en raíz son archivos de configuración y documentación, necesarios para construir y compilar los módulos.

• tsconfig.json
• rollup.config.js
• gulpfile.js
• ...

La carpeta src/ que encontramos en raíz, contienen todo nuestro código fuente listo para ser compilado y publicado.

Dentro de la carpeta src/ encontraremos un archivo index.ts es la entrada de todo nuestro paquete y dentro se encuentra todos nuestros módulos que serán exportados, también una carpeta modules/ donde estaran escritos todos nuestros módulos para ser exportados.

Cada módulo puede exportar components, directives, services, pipes y/o interfaces, que son las carpetas que contiene cada módulo.

Todos los components, directives, services, pipes y interfaces deben siempre ser exportados como parte de un módulo y no como un recurso individual.

Los index.ts y de cada nodulo, serán la puerta de importacion y exportacion de los módulos.