Este projeto visa ser a ferramenta principal para desenvolvedores brasileiros que desejam lidar com dados relacionados ao Brasil. A ideia é proporcionar todo tipo de recursos para facilitar a vida do desenvolvedor: lib, skds, cli, documentação, etc.
No presente momento o projeto possui 2 libraries:
- @brasil-interface/utils: Uma lib com funções utilitárias para lidar com dados do governo brasileiro, CPF, CNPJ, CEP, etc.
- @brasil-interface/cli: Uma cli para facilitar o acesso do desenvolvedor aos dados e funcionalidades que as outras libraries do projeto disponibilizam.
Este projeto é uma iniciativa pessoal e não possui nenhum vínculo com o governo brasileiro.
- Dê uma olhada no roadmap para saber o que ainda está por vir.
Uma lib com funções utilitárias para lidar com dados do governo brasileiro, atualmente a lib conta com funções para lidar com:
- CPF
- CNPJ
- PIS
- CNH
- RG - SSP-SP
- Titulo de Eleitor
- Inscrição Estadual - Todos os estados
Para todos estes dados, a lib conta com funções para validar, gerar aleatoriamente, aplicar máscara e remover máscara. Existem também alguns casos específicos para cada tipo de dado, por exemplo, para CPF, a lib conta com uma função para verificar o estado de origem do CPF.
Instalação:
yarn add @brasil-interface/utilsou
npm install @brasil-interface/utilsou
pnpm add @brasil-interface/utilsApós instalar basta importar a lib e utilizar as funções:
import { CPF } from "@brasil-interface/utils";
console.log(CPF.isValid("04379547060")); // true
console.log(CPF.isValid("11111547060")); // false
console.log(CPF.mask("04379547060"))); // 043.795.470-60
console.log(CPF.unmask("043.795.470-60"))); // 04379547060
console.log(CPF.generate()); // 04379547060Leia mais sobre todos os métodos disponíveis em @brasil-interface/utils.
Uma cli para facilitar o acesso do desenvolvedor aos dados e funcionalidades que as outras libraries do projeto disponibilizam. Atualmente todas as funcionalidades da cli são baseadas na lib @brasil-interface/utils.
Instalação:
yarn global add @brasil-interface/cliou
npm install -g @brasil-interface/cliou
pnpm add -g @brasil-interface/cliApós instalar basta executar o comando @brasil-interface/cli e começar a usar, alguns exemplos:
Verificar todas as funcionalidades disponíveis:
$ brasili --helpGerando 5 CPFs aleatórios e salvando em um arquivo JSON:
$ brasili cpf generate -a 5 -o ./output.jsonValidando um CPF:
$ brasili cpf validate 04379547060Aplicando máscara em um CPF:
$ brasili cpf mask 04379547060Removendo máscara de um CPF:
$ brasili cpf unmask 043.795.470-60Leia mais sobre todos os métodos disponíveis em @brasil-interface/cli.
Este é um projeto monorepo, ou seja, possui várias libraries dentro de um mesmo repositório. Para gerenciar as dependências entre as libraries, foi utilizado o yarn workspaces e para gerenciar o publish/versionamento das libraries, foi utilizado o lerna.
Leia mais em CONTRIBUTING.md.