Skip to content

Commit a4da37c

Browse files
feat: add issue templates, update README, and include sample usage files
1 parent 3e4e57d commit a4da37c

5 files changed

Lines changed: 20 additions & 22 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: "Relatar um Bug 🐛"
2-
description: "Crie um relatório de bug para nos ajudar a melhorar o gerador-br"
2+
description: "Crie um relatório de bug para nos ajudar a melhorar o @box4dev/gerador-br"
33
title: "[BUG]: "
44
labels: ["bug"]
55
body:
@@ -57,14 +57,14 @@ body:
5757
description: Forneça um exemplo de código simples ou repositório mínimo para reproduzir o erro.
5858
placeholder: |
5959
```typescript
60-
import { cpf } from 'gerador-br';
60+
import { cpf } from '@box4dev/gerador-br';
6161
console.log(cpf(true));
6262
```
6363
6464
- type: input
6565
id: version
6666
attributes:
67-
label: Versão do gerador-br
67+
label: Versão do @box4dev/gerador-br
6868
placeholder: "Ex: 2.0.0"
6969
validations:
7070
required: false

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
name: "Proposta de Novo Recurso 🚀"
2-
description: "Proponha um novo gerador ou funcionalidade para o gerador-br"
2+
description: "Proponha um novo gerador ou funcionalidade para o @box4dev/gerador-br"
33
title: "[FEATURE]: "
44
labels: ["enhancement"]
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
Obrigado por contribuir com ideias para o gerador-br!
9+
Obrigado por contribuir com ideias para o @box4dev/gerador-br!
1010
1111
- type: checkboxes
1212
id: checkboxes
@@ -31,7 +31,7 @@ body:
3131
description: Como você imagina o funcionamento ou a chamada desta função?
3232
placeholder: |
3333
```typescript
34-
import { novoGerador } from 'gerador-br';
34+
import { novoGerador } from '@box4dev/gerador-br';
3535
console.log(novoGerador());
3636
```
3737
validations:

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
<p align="center">
1212
<a href="https://npmjs.org/package/@box4dev/gerador-br"><img src="https://img.shields.io/npm/v/@box4dev/gerador-br?logo=npm&logoColor=ffffff" alt="NPM version" /></a>
13+
<a href="https://github.com/box4dev/gerador-br/blob/master/LICENSE"><img src="https://img.shields.io/github/license/box4dev/gerador-br" alt="License" /></a>
1314
<a href="https://npmcharts.com/compare/@box4dev/gerador-br?minimal=true"><img src="https://img.shields.io/npm/dm/@box4dev/gerador-br.svg?logo=npm&logoColor=ffffff" alt="NPM downloads" /></a>
1415
<a href="https://www.jsdelivr.com/package/npm/@box4dev/gerador-br"><img src="https://img.shields.io/jsdelivr/npm/hm/@box4dev/gerador-br?logo=jsDelivr&logoColor=ff5627" alt="jsDelivr" /></a>
1516
<a href="https://github.com/box4dev/gerador-br/actions/workflows/ci.yml"><img src="https://github.com/box4dev/gerador-br/actions/workflows/ci.yml/badge.svg" alt="CI" /></a>
@@ -36,10 +37,10 @@ O pacote fornece uma coleção de funções para gerar dados brasileiros aleató
3637
## Instalação
3738

3839
```bash
39-
pnpm add @box4dev/gerador-br
40-
# ou
4140
npm install @box4dev/gerador-br
4241
# ou
42+
pnpm add @box4dev/gerador-br
43+
# ou
4344
yarn add @box4dev/gerador-br
4445
```
4546

@@ -61,7 +62,7 @@ const { gerar } = require('@box4dev/gerador-br');
6162

6263
> Veja todos os exemplos na [documentação](https://box4.dev/pt-br/pacotes-npm/gerador-br/docs).
6364
64-
**Importe apenas a(s) função(ões) que desejar:**
65+
**Importe apenas a(s) função(ões) que desejar (recomendado):**
6566

6667
```js
6768
import { nome, cpf, cnpj, placaMercosul } from '@box4dev/gerador-br'; // ES Module
@@ -70,6 +71,7 @@ import { nome, cpf, cnpj, placaMercosul } from '@box4dev/gerador-br'; // ES Modu
7071
console.log(nome.femininoCompleto());
7172
console.log(cpf());
7273
console.log(cnpj());
74+
console.log(cnpjAlfanumerico());
7375
console.log(placaMercosul());
7476
```
7577

@@ -86,7 +88,7 @@ console.log(gerar.contaBancaria());
8688
console.log(gerar.cartaoCredito());
8789
```
8890

89-
## Projetos com exemplos de utilização do Gerador-BR
91+
## Projetos com exemplos de utilização do @box4dev/gerador-br
9092

9193
[![Cypress](https://img.shields.io/badge/Cypress-%23007780?logo=cypress&logoColor=white)](https://github.com/marcelo-lourenco/cypress-data-generator)
9294
[![Playwright](https://img.shields.io/badge/Playwright-%232EAD33?logo=playwright&logoColor=white)](https://github.com/marcelo-lourenco/playwright-data-generator)
@@ -97,8 +99,8 @@ console.log(gerar.cartaoCredito());
9799
## Outros exemplos de utilização
98100

99101
```js
100-
import { gerar } from 'gerador-br'; // ES Module:
101-
// const gerar = require('gerador-br'); // CommonJS:
102+
import { gerar } from '@box4dev/gerador-br'; // ES Module:
103+
// const gerar = require('@box4dev/gerador-br'); // CommonJS:
102104

103105
/* ******************** APELIDO ************************ */
104106
// Gera apelido aleatório
@@ -391,11 +393,11 @@ console.log(gerar.tituloEleitor(false, 'PR'));
391393

392394
O pacote foi testado e é compatível com as versões mais recentes dos seguinte frameworks:
393395

396+
[![Playwright](https://img.shields.io/badge/Playwright-%232EAD33?logo=playwright&logoColor=white)](https://github.com/marcelo-lourenco/playwright-data-generator)
394397
[![Cypress](https://img.shields.io/badge/Cypress-%23007780?logo=cypress&logoColor=white)](https://github.com/marcelo-lourenco/cypress-data-generator)
395398
[![Jest](https://img.shields.io/badge/Jest-%2315c213?logo=jest&logoColor=white)](https://github.com/marcelo-lourenco/jest-data-generator)
396399
[![Node.js Test Runner](https://img.shields.io/badge/Node.js%20Test%20Runner-%235FA04E?logo=nodedotjs&logoColor=white)](https://github.com/marcelo-lourenco/node-data-generator)
397400
[![Jasmine](https://img.shields.io/badge/Jasmine-%238a4182?logo=jasmine&logoColor=white)](https://github.com/marcelo-lourenco/jasmine-data-generator)
398-
[![Playwright](https://img.shields.io/badge/Playwright-%232EAD33?logo=playwright&logoColor=white)](https://github.com/marcelo-lourenco/playwright-data-generator)
399401
[![Mocha](https://img.shields.io/badge/Mocha-%238d6748?logo=mocha&logoColor=white)](#)
400402
[![Chai](https://img.shields.io/badge/Chai-%23a40802?logo=chai&logoColor=white)](#)
401403
[![Supertest](https://img.shields.io/badge/Supertest-%23F44336?logo=apachesuperset&logoColor=white)](#)
@@ -410,14 +412,10 @@ Contribuições são bem-vindas! Faça um *fork* do [repositório](https://gith
410412

411413
**Essas funções foram utilizadas nas seguintes aplicações:**
412414

413-
[Extensão Chrome - Gerador de Dados Fictícios](https://chromewebstore.google.com/detail/ipfihnddjaepajgdamecijfdefikdgam) - Muito útil para preencher automaticamente os campos de formulários em testes manuais.
414-
415-
[Gerador-BR](https://box4.dev/pt-br/brasil/geradores) - Gerador de dados on-line.
416-
417-
## Licença
415+
[Gerador de Dados Brasileiro](https://box4.dev/pt-br/brasil/geradores) - Gerador de dados on-line.
418416

419-
Este projeto está licenciado sob a [Licença MIT](LICENSE).
417+
[Extensão Chrome - Gerador de Dados Fictícios](https://chromewebstore.google.com/detail/ipfihnddjaepajgdamecijfdefikdgam) - Muito útil para preencher automaticamente os campos de formulários em testes manuais.
420418

421419
---
422420

423-
[Código de Conduta](https://github.com/box4dev/gerador-br?tab=coc-ov-file#readme)[Licença MIT](https://github.com/box4dev/gerador-br?tab=MIT-1-ov-file#readme)[Segurança](https://github.com/box4dev/gerador-br/security)[Changelog](https://github.com/box4dev/gerador-br/blob/master/CHANGELOG.md)[Fórum](https://github.com/box4dev/gerador-br/discussions)
421+
[Código de Conduta](https://github.com/box4dev/gerador-br?tab=coc-ov-file#readme)[Licença MIT](https://github.com/box4dev/gerador-br/blob/master/LICENSE)[Segurança](https://github.com/box4dev/gerador-br/security)[Changelog](https://github.com/box4dev/gerador-br/blob/master/CHANGELOG.md)[Fórum](https://github.com/box4dev/gerador-br/discussions)

sample/example.cjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const {
1414
placaMercosul,
1515
} = require('../dist/index.cjs');
1616

17-
console.log('--- Testando gerador-br com CommonJS ---\n');
17+
console.log('--- Testando @box4dev/gerador-br com CommonJS ---\n');
1818

1919
console.log('=== NAMED EXPORTS (Recomendado) ===');
2020
console.log('CPF com máscara:', cpf(true));

sample/example.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ import {
4747
tituloEleitor,
4848
} from '../dist/index.js';
4949

50-
console.log('--- Testando gerador-br com ES Modules ---\n');
50+
console.log('--- Testando @box4dev/gerador-br com ES Modules ---\n');
5151

5252
console.log('=== NAMED EXPORTS (Recomendado) ===');
5353
console.log('CPF com máscara:', cpf(true));

0 commit comments

Comments
 (0)