Skip to content

Commit

Permalink
build(dependencia): adiciona rollup
Browse files Browse the repository at this point in the history
  • Loading branch information
marcelo-lourenco committed Oct 18, 2024
1 parent dac6fcb commit 226371f
Show file tree
Hide file tree
Showing 19 changed files with 579 additions and 56 deletions.
7 changes: 7 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,11 @@ end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
max_line_length = 80
trim_trailing_whitespace = true

[*.md]
max_line_length = 0
trim_trailing_whitespace = false

root = true
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
coverage
node_modules
post
dist
10 changes: 6 additions & 4 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
.gitignore
.npmignore
eslint.config.js
package.lock.json
eslint-results.sarif
coverage
lib/
post/
package.lock.json
coverage/
src/
data/
test/
rollup.config.js
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ Todas as mudanças notáveis neste projeto serão documentadas neste arquivo.

---

## 1.1.0 (2024-10-18)

### Adiciona Dependência

* Adicionado Rollup como ferramenta de build para empacotamento do projeto.
* Configurado Rollup para gerar builds nos formatos CommonJS e ESModule.
* Melhorado o processo de build para melhor performance e compatibilidade com diferentes sistemas de módulos.

---

## 1.0.6 (2024-10-09)

### Adiciona Funcionalidades
Expand Down
34 changes: 28 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,31 +47,49 @@ O pacote foi testado e é compatível com as versões mais recentes dos seguinte
npm install gerador-br
```

## Uso
## Importação

### *Named import*
### *CommonsJS*
```js
const gerar = require('gerador-br');
```

### *ES Module*
```js
import gerar from 'gerador-br';
```

## Utilização

Importe apenas a(s) função(ões) que desejar
***Named import:*** Importe apenas a(s) função(ões) que desejar

```js
// ES Module
import { nome, cpf, cnpj, placaMercosul } from 'gerador-br';

// CommonJS
// const { nome, cpf, cnpj, placaMercosul } = require('gerador-br');

console.log(nome.femininoCompleto()); // Ex: "Maria"
console.log(cpf()); // Gera CPF sem máscara e do estado aleatório
console.log(cpf(false, "PE")); // Gera CPF sem máscara e do estado info
console.log(cnpj(true)); // Gera CNPJ com máscara
console.log(placaMercosul(true)); // Gera placa no formato Mercosul com máscara "ABC-1D23"
```

### *Default import*

Importe todo o módulo `gerar` e depois use qualquer função que desejar
***Default import:*** Importe todo o módulo **`gerar`** e depois use qualquer função que desejar

> Observação: Todas as funções do modulo `gerar` podem ser importadas individualmente (como nos exemplos acima - *named import*)
```js
// Para ES Module:
import gerar from 'gerador-br';

// Para CommonJS:
// const gerar = require('gerador-br');

// Exemplos:

/* ******************** DOCUMENTOS ********************** */
// Gera CNH aleatória
console.log(gerar.cnh());
Expand Down Expand Up @@ -448,6 +466,10 @@ console.log(gerar.paragrafo(5));
console.log(gerar.paragrafo(3,8));
```

## Contribuições

Contribuições são bem-vindas! Faça um *fork* do repositório e sinta-se à vontade para enviar seus *pull requests*.

## Extensão Chrome - Gerador de Dados Fictícios

Todas essas funções foram utilizadas na [Extensão Chrome - Gerador de Dados Fictícios](https://chromewebstore.google.com/detail/ipfihnddjaepajgdamecijfdefikdgam).
Expand Down
Loading

0 comments on commit 226371f

Please sign in to comment.