docs(geradores): adiciona páginas gerar cpf e cnpj

marcelo-lourenco · Nov 1, 2024 · 31509cb · 31509cb
1 parent caaf1f0
commit 31509cb
Show file tree

Hide file tree

Showing 23 changed files with 7,888 additions and 2,608 deletions.
diff --git a/.npmignore b/.npmignore
@@ -9,7 +9,7 @@ eslint-results.sarif
 package.lock.json
 coverage/
 src/
-data/
 docs/
 test/
+temp/
 rollup.config.js
diff --git a/README.md b/README.md
@@ -10,21 +10,21 @@
 [![FOSSA Licence](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmarcelo-lourenco%2Fgerador-br.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmarcelo-lourenco%2Fgerador-br)
 [![FOSSA Security](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmarcelo-lourenco%2Fgerador-br.svg?type=shield&issueType=security)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmarcelo-lourenco%2Fgerador-br)
 
-Gere dados fictícios, mas válidos, para testes e desenvolvimento.
+Gere dados fictícios/válidos, para testes e desenvolvimento de Software.
 
 Ideal para testes automatizados com **Cypress**, **Jest**, **Node.js Test Runner**, **Jasmine**, **Mocha**, **Chai**, **Supertest**, **Sinon** e **Puppeteer**.
 
 O pacote fornece uma coleção de funções para gerar dados brasileiros aleatórios, como:
 
-* [Gerador de Documento](https://marcelo-lourenco.github.io/gerador-br/#/geradores?id=documentos-pf): CPF, RG, CNH, Título de Eleitor, PIS, CNS (Cartão Nacional Saúde), Passaporte,
-* [Gerador de Pessoa](https://marcelo-lourenco.github.io/gerador-br/#/geradores?id=pessoas): Nome, Nickname, Data de Nascimento, Cor de Pele, Orientação Sexual, Identidade de Gênero, Tipo Sanguíneo, Escolaridade e Profissão;
-* [Gerador de Empresa](https://marcelo-lourenco.github.io/gerador-br/#/geradores?id=documentos-pj): CNPJ e Inscrição Estadual;
-* [Gerador de Endereço](https://marcelo-lourenco.github.io/gerador-br/#/geradores?id=cep): CEP, Logradouro, Número, Bairro, Localidade e Estado;
-* [Gerador de Contato](https://marcelo-lourenco.github.io/gerador-br/#/geradores?id=contatos): E-mail, DDD, Operadora, Celular e Telefone;
-* [Gerador de Conta Bancária](https://marcelo-lourenco.github.io/gerador-br/#/geradores?id=bancos): Código do Banco, Nome do Banco, Agência Bancária e Conta Bancária;
-* [Gerador de Cartão de Crédito](https://marcelo-lourenco.github.io/gerador-br/#/geradores?id=cartaocredito): Número, Bandeira, CVV e Validade;
-* [Gerador de Veículo](https://marcelo-lourenco.github.io/gerador-br/#/geradores?id=ve%c3%8dculos): Placa Antiga, Placa Mercosul e RENAVAM;
-* [Gerador de Texto (Lorem Ipsum)](https://marcelo-lourenco.github.io/gerador-br/#/geradores?id=lorem-ipsum): Palavras, Sentenças e Parágrafos;
+* [Gerador de Documento](https://marcelo-lourenco.github.io/gerador-br/#/guia-utilizacao?id=documentos-pf): CPF, RG, CNH, Título de Eleitor, PIS, CNS (Cartão Nacional Saúde), Passaporte,
+* [Gerador de Pessoa](https://marcelo-lourenco.github.io/gerador-br/#/guia-utilizacao?id=pessoas): Nome, Nickname, Data de Nascimento, Cor de Pele, Orientação Sexual, Identidade de Gênero, Tipo Sanguíneo, Escolaridade e Profissão;
+* [Gerador de Empresa](https://marcelo-lourenco.github.io/gerador-br/#/guia-utilizacao?id=documentos-pj): CNPJ e Inscrição Estadual;
+* [Gerador de Endereço](https://marcelo-lourenco.github.io/gerador-br/#/guia-utilizacao?id=cep): CEP, Logradouro, Número, Bairro, Localidade e Estado;
+* [Gerador de Contato](https://marcelo-lourenco.github.io/gerador-br/#/guia-utilizacao?id=contatos): E-mail, DDD, Operadora, Celular e Telefone;
+* [Gerador de Conta Bancária](https://marcelo-lourenco.github.io/gerador-br/#/guia-utilizacao?id=bancos): Código do Banco, Nome do Banco, Agência Bancária e Conta Bancária;
+* [Gerador de Cartão de Crédito](https://marcelo-lourenco.github.io/gerador-br/#/guia-utilizacao?id=cartaocredito): Número, Bandeira, CVV e Validade;
+* [Gerador de Veículo](https://marcelo-lourenco.github.io/gerador-br/#/guia-utilizacao?id=ve%c3%8dculos): Placa Antiga, Placa Mercosul e RENAVAM;
+* [Gerador de Texto (Lorem Ipsum)](https://marcelo-lourenco.github.io/gerador-br/#/guia-utilizacao?id=lorem-ipsum): Palavras, Sentenças e Parágrafos;
 
 ## Compatibilidade
 
@@ -62,7 +62,7 @@ const gerar = require('gerador-br');
 
 ## Utilização
 
-> Veja todos os exemplos na [documentação](https://marcelo-lourenco.github.io/gerador-br/#/geradores).
+> Veja todos os exemplos na [documentação](https://marcelo-lourenco.github.io/gerador-br/#/guia-utilizacao).
 
 **Importe apenas a(s) função(ões) que desejar:**
 

diff --git a/docs/README.md b/docs/README.md
@@ -18,15 +18,15 @@ Ideal para testes automatizados com **Cypress**, **Jest**, **Node.js Test Runner
 
 O pacote fornece uma coleção de funções para gerar dados brasileiros aleatórios, como:
 
-* [Gerador de Documento](geradores?id=documentos-pf): CPF, RG, CNH, Título de Eleitor, PIS, CNS (Cartão Nacional Saúde), Passaporte,
-* [Gerador de Pessoa](geradores?id=pessoas): Nome, Nickname, Data de Nascimento, Cor de Pele, Orientação Sexual, Identidade de Gênero, Tipo Sanguíneo, Escolaridade e Profissão;
-* [Gerador de Empresa](geradores?id=documentos-pj): CNPJ e Inscrição Estadual;
-* [Gerador de Endereço](geradores?id=cep): CEP, Logradouro, Número, Bairro, Localidade e Estado;
-* [Gerador de Contato](geradores?id=contatos): E-mail, DDD, Operadora, Celular e Telefone;
-* [Gerador de Conta Bancária](geradores?id=bancos): Código do Banco, Nome do Banco, Agência Bancária e Conta Bancária;
-* [Gerador de Cartão de Crédito](geradores?id=cartaocredito): Número, Bandeira, CVV e Validade;
-* [Gerador de Veículo](geradores?id=ve%c3%8dculos): Placa Antiga, Placa Mercosul e RENAVAM;
-* [Gerador de Texto (Lorem Ipsum)](geradores?id=lorem-ipsum): Palavras, Sentenças e Parágrafos;
+* [Gerador de Documento](guia-utilizacao?id=documentos-pf): CPF, RG, CNH, Título de Eleitor, PIS, CNS (Cartão Nacional Saúde), Passaporte,
+* [Gerador de Pessoa](guia-utilizacao?id=pessoas): Nome, Nickname, Data de Nascimento, Cor de Pele, Orientação Sexual, Identidade de Gênero, Tipo Sanguíneo, Escolaridade e Profissão;
+* [Gerador de Empresa](guia-utilizacao?id=documentos-pj): CNPJ e Inscrição Estadual;
+* [Gerador de Endereço](guia-utilizacao?id=cep): CEP, Logradouro, Número, Bairro, Localidade e Estado;
+* [Gerador de Contato](guia-utilizacao?id=contatos): E-mail, DDD, Operadora, Celular e Telefone;
+* [Gerador de Conta Bancária](guia-utilizacao?id=bancos): Código do Banco, Nome do Banco, Agência Bancária e Conta Bancária;
+* [Gerador de Cartão de Crédito](guia-utilizacao?id=cartaocredito): Número, Bandeira, CVV e Validade;
+* [Gerador de Veículo](guia-utilizacao?id=ve%c3%8dculos): Placa Antiga, Placa Mercosul e RENAVAM;
+* [Gerador de Texto (Lorem Ipsum)](guia-utilizacao?id=lorem-ipsum): Palavras, Sentenças e Parágrafos;
 
 ## Compatibilidade
 

diff --git a/docs/_coverpage.md b/docs/_coverpage.md
@@ -1,9 +1,9 @@
-# Gerador-BR <small>1.1.0</small>
-
 ![logo](_media/icon-128.svg)
 
+# Gerador-BR<!-- <small>1.1.0</small> -->
+
 > Gerador de Dados Fictícios - Brasil.
 
 <!-- [NPM](https://www.npmjs.com/package/gerador-br) -->
 <!-- [GitHub](https://github.com/marcelo-lourenco/gerador-br) -->
-[Get Started](comecando.md)
+[Get Started](inicio.md)
diff --git a/docs/_css/style.css b/docs/_css/style.css
@@ -0,0 +1,115 @@
+.aside-custom {
+  display: grid;
+  background-color: #f0f0f0;
+  padding: 20px 0;
+  justify-content: center;
+  justify-items: center;
+  align-content: center;
+  align-items: center;
+}
+
+.pre-custom {
+  width: 400px;
+}
+
+.code {
+  padding: 15px !important;
+}
+
+.sidebar .sidebar-nav {
+  line-height: 25px;
+}
+
+.app-sub-sidebar li:before {
+  content: "";
+}
+
+.sidebar li {
+  margin: 0px;
+}
+
+.sidebar h1 {
+  font-size: 1.5rem;
+  font-weight: 300;
+  text-align: center;
+}
+
+button {
+  background-color: #0d6efd;
+  color: white;
+  padding: 12px 20px;
+  border: none;
+  cursor: pointer;
+  border-radius: 5px;
+  font-size: 16px;
+}
+
+.input-container {
+  position: relative;
+  display: inline-block;
+  padding: 20px 0 40px 0;
+}
+
+.input-gerador {
+  width: 250px;
+  padding: 12px;
+  padding-right: 30px;
+  border: 1px solid #ccc;
+  border-radius: 5px;
+  font-size: 16px;
+  margin-top: 20px;
+  margin-bottom: 20px;
+  text-align: center;
+}
+
+.icon-copy {
+  position: absolute;
+  top: 30%;
+  right: 10px;
+  transform: translateY(-50%);
+  background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16'%3E%3Cpath fill='%23cccccc' d='M11.4 0a.85.85 0 0 1 .622.273l2.743 3a.884.884 0 0 1 .235.602v9.25a.867.867 0 0 1-.857.875H3.857A.867.867 0 0 1 3 13.125V.875C3 .392 3.384 0 3.857 0zM14 4h-2.6a.4.4 0 0 1-.4-.4V1H4v12h10z'/%3E%3Cpath fill='%23cccccc' d='M3 1H2a1 1 0 0 0-1 1v13a1 1 0 0 0 1 1h10a1 1 0 0 0 1-1v-1h-1v1H2V2h1z'/%3E%3C/svg%3E");
+  background-repeat: no-repeat;
+  background-size: 100% 100%;
+  cursor: pointer;
+}
+
+.icon-copy:hover {
+  background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16'%3E%3Cpath fill='%230d6efd' d='M11.4 0a.85.85 0 0 1 .622.273l2.743 3a.884.884 0 0 1 .235.602v9.25a.867.867 0 0 1-.857.875H3.857A.867.867 0 0 1 3 13.125V.875C3 .392 3.384 0 3.857 0zM14 4h-2.6a.4.4 0 0 1-.4-.4V1H4v12h10z'/%3E%3Cpath fill='%230d6efd' d='M3 1H2a1 1 0 0 0-1 1v13a1 1 0 0 0 1 1h10a1 1 0 0 0 1-1v-1h-1v1H2V2h1z'/%3E%3C/svg%3E");
+}
+
+.icon-copy-position {
+  position: absolute;
+  top: 50px;
+  right: 200px;
+  transform: translateY(-50%);
+  color: #0d6efd;
+}
+
+.icon {
+  display: none;
+  background-repeat: no-repeat;
+  background-size: 100% 100%;
+  cursor: pointer;
+}
+
+.icon-16 {
+  width: 16px;
+  height: 16px;
+}
+
+.copiado {
+  position: absolute;
+  top: -10px;
+  left: 50%;
+  transform: translateX(-50%);
+  background-color: #4CAF50;
+  color: white;
+  padding: 7px;
+  border-radius: 5px;
+  opacity: 0;
+  transition: opacity 0.3s;
+}
+
+.mostrar {
+  opacity: 1;
+}
diff --git a/docs/_js/gerador-br.min.js b/docs/_js/gerador-br.min.js
diff --git a/docs/_js/script.js b/docs/_js/script.js
@@ -0,0 +1,17 @@
+function copiarTexto() {
+  const campoTexto = document.getElementById('vlrGerado');
+  campoTexto.select();
+  document.execCommand('copy');
+
+  const mensagem = document.getElementById('msgCopiado');
+  mensagem.classList.add('mostrar');
+  setTimeout(() => {
+    mensagem.classList.remove('mostrar');
+  }, 1500);
+}
+
+function toggleIcon() {
+  const campoTexto = document.getElementById('vlrGerado');
+  const icon = document.getElementById('iconCopy');
+  icon.style.display = campoTexto.value ? 'inline-block' : 'none';
+}
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -1,3 +1,34 @@
-* [Home](/)
-* [Começando](comecando.md)
-* [Geradores](geradores.md)
+* [Home](./?id=gerador-de-dados-fictícios-brasi "Gerador-BR - Home")
+* [Início](inicio.md "Gerador-BR - Começar")
+* [Guia de Utilização](guia-utilizacao.md "Gerador-BR - Guia de Utilização")
+
+---
+
+<h1>Geradores</h1>
+
+* DOCUMENTOS PF
+  * [Gerador de CPF](gerar/cpf.md "Gerador de CPF")
+  * [Gerador de CNH](gerar/cnh.md "Gerador de CNH")
+  * [Gerador de RG](gerar/rg.md "Gerador de RG")
+  * [Gerador de CNS](gerar/cns.md "Gerador de CNS")
+  * [Gerador de PIS](gerar/pis.md "Gerador de PIS")
+  * [Gerador de Título de Eleitor](gerar/tituloEleitor.md "Gerador de Título de Eleitor")
+  * [Gerador de Passaporte](gerar/passaporte.md "Gerador de Passaporte")
+* DOCUMENTOS PJ
+  * [Gerador de CNPJ](gerar/cnpj.md "Gerador de CNPJ")
+  * [Gerador de Inscrição Estadual](gerar/inscricaoEstadual.md "Gerador de Inscrição Estadual")
+* BANCOS
+  * [Gerador de Banco](gerar/banco.md "Gerador de Banco")
+  * [Gerador de Cartão de Crédito](gerar/cartaoCredito.md "Gerador de Cartão de Crédito")
+  * [Gerador de Conta Bancária](gerar/contaBancaria.md "Gerador de Conta Bancária")
+* CONTATOS
+  * [Gerador de E-mail](gerar/email.md "Gerador de email")
+  * [Gerador de CEP](gerar/cep.md "Gerador de CEP")
+  * [Gerador de Endereço](gerar/endereco.md "Gerador de Endereço")
+* VEÍCULOS
+  * [Gerador de Placa Antiga](gerar/placaAntiga.md "Gerador de Placa Antiga")
+  * [Gerador de Placa MERCOSUL](gerar/placaMercosul.md "Gerador de Placa MERCOSUL")
+  * [Gerador de RENAVAM](gerar/renavam.md "Gerador de RENAVAM")
+* LOREM IPSUM
+  * [Gerador de Sentenca](gerar/sentenca.md "Gerador de Sentença")
+  * [Gerador de Parágrafos](gerar/paragrafo.md "Gerador de Parágrafo")
diff --git a/docs/gerar/_navbar.md b/docs/gerar/_navbar.md
@@ -0,0 +1,4 @@
+
+- Pacote
+  - [NPM](https://www.npmjs.com/package/gerador-br)
+  - [GitHub](https://github.com/marcelo-lourenco/gerador-br)
diff --git a/docs/gerar/_sidebar.md b/docs/gerar/_sidebar.md
@@ -0,0 +1,27 @@
+* [Home](../?id=gerador-de-dados-fictícios-brasil "Gerador-BR - Home")
+* DOCUMENTOS PF
+  * [Gerador de CPF](gerar/cpf.md "Gerador de CPF")
+  * [Gerador de CNH](gerar/cnh.md "Gerador de CNH")
+  * [Gerador de RG](gerar/rg.md "Gerador de RG")
+  * [Gerador de CNS](gerar/cns.md "Gerador de CNS")
+  * [Gerador de PIS](gerar/pis.md "Gerador de PIS")
+  * [Gerador de Título de Eleitor](gerar/tituloEleitor.md "Gerador de Título de Eleitor")
+  * [Gerador de Passaporte](gerar/passaporte.md "Gerador de Passaporte")
+* DOCUMENTOS PJ
+  * [Gerador de CNPJ](gerar/cnpj.md "Gerador de CNPJ")
+  * [Gerador de Inscrição Estadual](gerar/inscricaoEstadual.md "Gerador de Inscrição Estadual")
+* BANCOS
+  * [Gerador de Banco](gerar/banco.md "Gerador de Banco")
+  * [Gerador de Cartão de Crédito](gerar/cartaoCredito.md "Gerador de Cartão de Crédito")
+  * [Gerador de Conta Bancária](gerar/contaBancaria.md "Gerador de Conta Bancária")
+* CONTATOS
+  * [Gerador de E-mail](gerar/email.md "Gerador de email")
+  * [Gerador de CEP](gerar/cep.md "Gerador de CEP")
+  * [Gerador de Endereço](gerar/endereco.md "Gerador de Endereço")
+* VEÍCULOS
+  * [Gerador de Placa Antiga](gerar/placaAntiga.md "Gerador de Placa Antiga")
+  * [Gerador de Placa MERCOSUL](gerar/placaMercosul.md "Gerador de Placa MERCOSUL")
+  * [Gerador de RENAVAM](gerar/renavam.md "Gerador de RENAVAM")
+* LOREM IPSUM
+  * [Gerador de Sentença](gerar/sentenca.md "Gerador de Sentença")
+  * [Gerador de Parágrafos](gerar/paragrafo.md "Gerador de Parágrafos")
diff --git a/docs/gerar/cnpj.md b/docs/gerar/cnpj.md
@@ -0,0 +1,8 @@
+<div class="input-container">
+ <input id="vlrGerado" class="input-gerador" type="text" readonly><br><br>
+ <i id="iconCopy" class="icon icon-16 icon-copy" onclick="copiarTexto() "></i>
+ <button onclick="document.getElementById('vlrGerado').value = cnpj(true); toggleIcon();">Gerar CNPJ</button>
+ <div id="msgCopiado" class="copiado">Copiado!</div>
+</div>
+
+
diff --git a/docs/gerar/cpf.md b/docs/gerar/cpf.md
@@ -0,0 +1,6 @@
+<div class="input-container">
+  <input id="vlrGerado" class="input-gerador" type="text" readonly><br><br>
+  <i id="iconCopy" class="icon icon-16 icon-copy" onclick="copiarTexto() "></i>
+  <button onclick="document.getElementById('vlrGerado').value = cpf(true); toggleIcon();">Gerar CPF</button>
+  <div id="msgCopiado" class="copiado">Copiado!</div>
+</div>
diff --git a/docs/geradores.md → docs/guia-utilizacao.md b/docs/geradores.md → docs/guia-utilizacao.md
@@ -1,4 +1,4 @@
-# GERADORES
+# Guia de Utilização
 
 ## DOCUMENTOS PF