hcm-clocking-event-angular-components v0.2.0

Repositório do projeto hcm-clocking-event-angular-components

Componentes angular de uso comum aos projetos do Gestão de Ponto (hcm-clocking-event).

As orientações de uso de cada componente estão dentro no diretório de cada componente, em lib/src/components.

Os componentes da biblioteca são sempre prefixados com cem (de Clocking Event Management).

Instruções gerais

Como fazer o build da lib

• Navegue para o diretório principal do projeto da lib (hcm-clocking-event-angular-components/);
• Execute o comando npm run build;
• A lib será construída no diretório: hcm-clocking-event-angular-components/dist.

Como utilizar durante os testes de desenvolvimento

• No projeto da lib, copie os arquivos gerados após o build: /dist.
• No projeto que utilizará a lib, cole os arquivos copiados na estrutura de diretórios a seguir: /node_modules/@senior-gestao-pessoas/hcm-clocking-event-angular-components.

Imports (sintaxe básica)

• import { Module, Service, DTO etc } from "@senior-gestao-pessoas/hcm-clocking-event-angular-components";

A orientação específica fica no diretório de cada componente.

Traduções

Devem seguir as orientações em /lib/src/locale.

Criação de novos componentes

• Sempre prefixar os componentes públicos com cem.

• Exemplo de criação do componente hipotético CEM-NomeComponente:

cd lib/src/components
ng g m CEM-NomeComponente
ng g c CEM-NomeComponente -m cem-nome-componente/cem-nome-componente

No cem-nome-componente.module.ts, tem que incluir no @NgModule:

exports: [CEMNomeComponenteComponent]

Recomendo que tenha um arquivo específicos para os dtos exclusivos do componente: cem-nome-componente-dtos.ts. Se o dto for usado apenas para obtenção de dados do backend, crie no core. Se for utilizado por mais de um componente, crie em shared.

Por crie um arquivo index.ts no diretório do componente e exporte inclua somente arquivos cujo conteúdo precise ser acessível pelo projeto que fará uso da lib. Inclua uma linha para ele no arquivo public-api.ts. Siga o exemplo de outros componentes.

• Crie o README.md com as instruções básicas para uso do componente.

• Crie o showcase para o componente.