@followthecode/cli 1.2.40 → 1.2.42
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 +18 -18
- package/bin/linux-x64/ftc.cli +0 -0
- package/bin/osx-x64/ftc.cli +0 -0
- package/bin/win-x64/ftc.cli.exe +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -69,7 +69,7 @@ docker run --rm ftc:latest --help
|
|
|
69
69
|
|
|
70
70
|
> **Resumo:**
|
|
71
71
|
> - Sempre use `-v "$PWD:/repo"` (Linux/macOS) ou `-v "%cd%:/repo"` (Windows) para acessar repositórios locais.
|
|
72
|
-
> - O caminho passado para `code` deve ser o caminho dentro do container, por exemplo, `"/repo/meu-repo"`.
|
|
72
|
+
> - O caminho passado para `collect code` deve ser o caminho dentro do container, por exemplo, `"/repo/meu-repo"`.
|
|
73
73
|
> - Para repositórios remotos, basta passar a URL.
|
|
74
74
|
|
|
75
75
|
## Uso moderno via Docker CLI
|
|
@@ -107,7 +107,7 @@ Se você encontrar problemas durante a instalação do CLI, como:
|
|
|
107
107
|
- Erros de permissão EPERM no Windows
|
|
108
108
|
- Problemas de limpeza de cache
|
|
109
109
|
|
|
110
|
-
Consulte
|
|
110
|
+
Consulte a seção de troubleshooting abaixo.
|
|
111
111
|
|
|
112
112
|
### Solução Rápida para Windows
|
|
113
113
|
|
|
@@ -162,8 +162,8 @@ bin/ftc collect code ./test-repo --json
|
|
|
162
162
|
bin/ftc collect code https://github.com/microsoft/vscode.git --json
|
|
163
163
|
```
|
|
164
164
|
|
|
165
|
-
Para mais detalhes, consulte
|
|
166
|
-
> - O comando `code "/repo/meu-repo"` deve apontar para o caminho dentro do container.
|
|
165
|
+
Para mais detalhes, consulte a seção de testes abaixo.
|
|
166
|
+
> - O comando `collect code "/repo/meu-repo"` deve apontar para o caminho dentro do container.
|
|
167
167
|
|
|
168
168
|
## Uso como ferramenta global (dotnet tool)
|
|
169
169
|
|
|
@@ -239,19 +239,19 @@ scripts\docker-run.bat collect code C:\caminho\para\repositorio
|
|
|
239
239
|
#### Análise de repositório remoto
|
|
240
240
|
```bash
|
|
241
241
|
# Linux/macOS
|
|
242
|
-
./scripts/docker-run.sh
|
|
242
|
+
./scripts/docker-run.sh code https://github.com/usuario/repositorio.git
|
|
243
243
|
|
|
244
244
|
# Windows
|
|
245
|
-
scripts\docker-run.bat
|
|
245
|
+
scripts\docker-run.bat code https://github.com/usuario/repositorio.git
|
|
246
246
|
```
|
|
247
247
|
|
|
248
248
|
#### Com filtros e JSON
|
|
249
249
|
```bash
|
|
250
250
|
# Linux/macOS
|
|
251
|
-
./scripts/docker-run.sh
|
|
251
|
+
./scripts/docker-run.sh code /caminho/para/repositorio --startDate 2024-01-01 --json
|
|
252
252
|
|
|
253
253
|
# Windows
|
|
254
|
-
scripts\docker-run.bat
|
|
254
|
+
scripts\docker-run.bat code C:\caminho\para\repositorio --startDate 2024-01-01 --json
|
|
255
255
|
```
|
|
256
256
|
|
|
257
257
|
#### Opções do Docker Runner
|
|
@@ -473,19 +473,19 @@ scripts\docker-run.bat [argumentos]
|
|
|
473
473
|
### Testar
|
|
474
474
|
```bash
|
|
475
475
|
# Testar com um repositório local
|
|
476
|
-
dotnet run -- C:\caminho\para\repositorio
|
|
476
|
+
dotnet run -- collect code C:\caminho\para\repositorio
|
|
477
477
|
|
|
478
478
|
# Testar com repositório remoto
|
|
479
|
-
dotnet run -- https://github.com/usuario/repositorio.git
|
|
479
|
+
dotnet run -- collect code https://github.com/usuario/repositorio.git
|
|
480
480
|
|
|
481
481
|
# Testar com filtros
|
|
482
|
-
dotnet run -- C:\caminho\para\repositorio --
|
|
482
|
+
dotnet run -- collect code C:\caminho\para\repositorio --startDate 2024-01-01 --endDate 2024-12-31 --json
|
|
483
483
|
|
|
484
484
|
# Executar testes
|
|
485
485
|
dotnet test ../../ftc.cli.tests
|
|
486
486
|
|
|
487
487
|
# Testar com Docker
|
|
488
|
-
./scripts/docker-run.sh C:\caminho\para\repositorio
|
|
488
|
+
./scripts/docker-run.sh collect code C:\caminho\para\repositorio
|
|
489
489
|
```
|
|
490
490
|
|
|
491
491
|
## Melhorias Implementadas
|
|
@@ -522,32 +522,32 @@ A CLI permite exportar o resultado da análise para um arquivo local ou diretame
|
|
|
522
522
|
|
|
523
523
|
### Exportar JSON localmente
|
|
524
524
|
```sh
|
|
525
|
-
ftc code "./meu-repo" --json --export local:./resultado.json
|
|
525
|
+
ftc collect code "./meu-repo" --json --export local:./resultado.json
|
|
526
526
|
```
|
|
527
527
|
|
|
528
528
|
### Exportar CSV localmente
|
|
529
529
|
```sh
|
|
530
|
-
ftc code "./meu-repo" --csv --export local:./resultado.csv
|
|
530
|
+
ftc collect code "./meu-repo" --csv --export local:./resultado.csv
|
|
531
531
|
```
|
|
532
532
|
|
|
533
533
|
### Exportar para S3 (JSON)
|
|
534
534
|
```sh
|
|
535
|
-
ftc code "./meu-repo" --json --export s3
|
|
535
|
+
ftc collect code "./meu-repo" --json --export s3
|
|
536
536
|
```
|
|
537
537
|
|
|
538
538
|
### Exportar para S3 (CSV)
|
|
539
539
|
```sh
|
|
540
|
-
ftc code "./meu-repo" --csv --export s3
|
|
540
|
+
ftc collect code "./meu-repo" --csv --export s3
|
|
541
541
|
```
|
|
542
542
|
|
|
543
543
|
### Exportar para S3 (bucket e key customizados)
|
|
544
544
|
```sh
|
|
545
|
-
ftc code "./meu-repo" --csv --export s3: --s3-bucket "meu-bucket"
|
|
545
|
+
ftc collect code "./meu-repo" --csv --export s3: --s3-bucket "meu-bucket"
|
|
546
546
|
```
|
|
547
547
|
|
|
548
548
|
### Exportar para S3 (bucket/key no próprio parâmetro)
|
|
549
549
|
```sh
|
|
550
|
-
ftc code "./meu-repo" --csv --export s3://meu-bucket/analises/resultado.csv
|
|
550
|
+
ftc collect code "./meu-repo" --csv --export s3://meu-bucket/analises/resultado.csv
|
|
551
551
|
```
|
|
552
552
|
|
|
553
553
|
- Se `--s3-bucket` não for informado, será usado o bucket padrão `ftc-analyzer`.
|
package/bin/linux-x64/ftc.cli
CHANGED
|
Binary file
|
package/bin/osx-x64/ftc.cli
CHANGED
|
Binary file
|
package/bin/win-x64/ftc.cli.exe
CHANGED
|
Binary file
|