ngx-sp-infra 2.0.12 → 2.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -7,6 +7,7 @@
7
7
 
8
8
  - [Introdução](#introdução)
9
9
  - [Uso](#uso)
10
+ - [Testes](#testes)
10
11
  - [Publicação](#publicação)
11
12
  - [Manual](#manual)
12
13
  - [Automatizada](#automatizada)
@@ -44,6 +45,37 @@ export class UsuariosModule { }
44
45
  > Nunca importe ambos os módulos ProjectModule e InfraModule juntos!
45
46
  > O InfraModule já está incluído dentro do ProjectModule, portanto, em projetos de Produtos, use apenas o ProjectModule.
46
47
 
48
+ ## Testes
49
+ Antes de publicar a biblioteca para o NPM é muito importante realizar testes robustos do funcionamento da nova feature ou correção que foi realizada. Para realizar testes locais segue-se o seguinte passo-a-passo:
50
+
51
+ 1. Com o projeto NgxSpInfra aberto em uma IDE execute o comando `ng build --watch`
52
+ 2. No projeto que será usado para teste modifique o arquivo angular.json e adicione a propriedade "preserveSymlinks" dentro de `build > options` como no exemplo abaixo:
53
+ ```json
54
+ {
55
+ // ...restante do conteúdo
56
+ "build": {
57
+ "builder": "@angular-devkit/build-angular:browser",
58
+ "options": {
59
+ "preserveSymlinks": true,
60
+ // ...restante do conteúdo
61
+ },
62
+ // ...restante do conteúdo
63
+ },
64
+ }
65
+ ```
66
+ 3. Por fim, execute os dois comandos abaixo:
67
+ ```bash
68
+ npm uninstall ngx-sp-infra --force
69
+ ```
70
+ ```bash
71
+ npm i "file:C:/SisproCloud/INFRA/Fontes/Sp_106_Imports/NgxSpInfra/dist/ngx-sp-infra"
72
+ ```
73
+
74
+ > [!TIP]
75
+ > Se for necessário, utilize o `--force` ...principalmente no uninstall
76
+
77
+ E pronto! Agora graças ao `ng build --watch` sempre que uma alteração for salva no projeto NgxSpInfra os arquivos na dist irão se atualizar também e a instalação no projeto de teste observavará exatamente estes arquivos.
78
+
47
79
  ## Publicação
48
80
  A publicação do pacote no NPM pode ser feita de forma manual ou automatizada.
49
81
 
@@ -99,7 +131,8 @@ A automatização da publicação é realizada utilizando GitHub Actions.
99
131
  Se você deseja contribuir para a biblioteca, siga estas etapas:
100
132
 
101
133
  1. Faça um clone do repositório.
102
- 2. Crie uma branch para sua feature ou correção.
103
- 3. Faça suas alterações e teste-as.
104
- 4. Realize um `git stash`, faça checkout para a branch `test` e `git stash pop` para levar suas alterações para essa branch.
105
- 5. Siga as instruções para publicação acima
134
+ 2. Crie uma branch para sua feature ou correção com base na main.
135
+ 3. Faça suas alterações e teste-as localmente (verifique o tópico de [Testes](#testes)).
136
+ 4. Faça um `git commit` e `git push` na sua branch.
137
+ 5. Abra um PR (Pull Request) para a branch test (ou main caso seja uma correção)
138
+ 6. Caso ela seja aprovada e o merge feito, siga as etapas no tópido de [Publicação](#publicação)