Skip to content

Commit 1a43d90

Browse files
authored
docs: Descrição do npm run
1 parent 24fc917 commit 1a43d90

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,18 @@ WIP
7171
WIP
7272

7373
## Entendendo os running do NPM
74-
75-
- test
76-
- format
77-
- doc
78-
- lint
79-
- local
80-
- coverage
81-
WIP
74+
- **unit-test**: Realiza uma bateria de testes unitários dos arquivos de js presentes na pasta test/unit;
75+
- **integration-test**: Realiza uma bateria de testes de integração dos arquivos de js presentes na pasta test/integration;
76+
- **all-test**:Realiza uma bateria de todos os testes presentes na pasta test/;
77+
- **test**: alias para o comando `all-test`;
78+
- **lint-md**: Submete o código a markdown a uma avaliação do `remark`;
79+
- **lint-prettier**: Submete o código a uma avaliação utilizando o [Prettier](https://prettier.io/), de acordo com a configuração descrita no arquivo .prettierrc;,
80+
- **lint**: Alias para executar todos os lints;
81+
- **format**: Formata todo o código do projeto, utilizando o [Prettier](https://prettier.io/), de acordo com a configuração descrita no arquivo .prettierrc;
82+
- **coverage**: Análise da cobertura dos testes;
83+
- **local**: Executa a cloud function localmente utilizando o functions-frameworks;
84+
- **coverage**: "nyc --reporter=lcov --reporter=cobertura npm run unit-test",
85+
- **docs**: Gera a documentção do código fonte seguindo o padrão do `jsdoc2md` aplicado no arquivo index.js, a doc é armanezada em docs/index.md",
8286

8387
## 1. Requisitos para utilização
8488

0 commit comments

Comments
 (0)