Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tiagoporto/gerador-validador-cpf
JS lib to generate and validate CPF (Cadastro de Pessoas Físicas) of Brazil.
https://github.com/tiagoporto/gerador-validador-cpf
brasil brazil cpf generator gerador js lib open-source typescript validador validator
Last synced: 2 days ago
JSON representation
JS lib to generate and validate CPF (Cadastro de Pessoas Físicas) of Brazil.
- Host: GitHub
- URL: https://github.com/tiagoporto/gerador-validador-cpf
- Owner: tiagoporto
- License: mit
- Created: 2014-06-19T01:57:40.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2025-01-23T23:54:11.000Z (9 days ago)
- Last Synced: 2025-01-24T00:19:46.485Z (9 days ago)
- Topics: brasil, brazil, cpf, generator, gerador, js, lib, open-source, typescript, validador, validator
- Language: TypeScript
- Homepage: https://tiagoporto.github.io/gerador-validador-cpf/
- Size: 8.71 MB
- Stars: 393
- Watchers: 12
- Forks: 75
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gerador e Validador de CPF 
JS lib to generate and validate CPF (Cadastro de Pessoas Físicas) of Brazil.
[](https://www.npmjs.com/package/gerador-validador-cpf)
[](https://jsr.io/@tiagoporto/gerador-validador-cpf)
[](https://bundlephobia.com/package/gerador-validador-cpf)
[](https://www.npmjs.com/package/gerador-validador-cpf)
## 📚 Docs
Read in other languages: [English](packages/gerador-validador-cpf/README.en.md), [Español](packages/gerador-validador-cpf/README.es.md) e [Português(Brasil)](packages/gerador-validador-cpf/README.md)
## ✅ Status
[](https://github.com/tiagoporto/gerador-validador-cpf/actions/workflows/check-docs.yml?query=branch%3Amain)
[](https://github.com/tiagoporto/gerador-validador-cpf/actions/workflows/checks.yml?query=branch%3Amain)
[](https://github.com/tiagoporto/gerador-validador-cpf/actions/workflows/unit-tests.yml?query=branch%3Amain)
[](https://github.com/tiagoporto/gerador-validador-cpf/actions/workflows/e2e-tests.yml?query=branch%3Amain)
[](https://validator.nu/?doc=https%3A%2F%2Ftiagoporto.github.io%2Fgerador-validador-cpf)
[](https://coveralls.io/github/tiagoporto/gerador-validador-cpf)
[](https://dashboard.stryker-mutator.io/reports/github.com/tiagoporto/gerador-validador-cpf/main)
## 🧰 Stack
## 🎮 Playground
## 📦 Installation
Install with npm:
```bash
npm install gerador-validador-cpf
```
Install with deno(jsr):
```bash
deno add jsr:@tiagoporto/gerador-validador-cpf
```
## ➡️ Usage
### Generate CPF
```javascript
import { generate as generateCpf } from 'gerador-validador-cpf'
// jsr import from "@tiagoporto/gerador-validador-cpf"
const cpf = generateCpf()
console.log(cpf) // 00000000000
const formattedCpf = generateCpf({ format: true })
console.log(formattedCpf) // 000.000.000-00
```
### Validate CPF
```javascript
import { validate as validadeCpf } from 'gerador-validador-cpf'
// jsr import from "@tiagoporto/gerador-validador-cpf"
const isCpfValid = validadeCpf('12345678900')
const isFormattedCpfValid = validadeCpf('123.456.789-00')
```
## 🛠 Development
### Pre-requirements
- [git](https://git-scm.com)
- [nvm](https://github.com/nvm-sh/nvm)
### Install node
```bash
nvm install
```
### Install pnpm
```bash
corepack enable pnpm
```
### Install
```bash
pnpm install
```
### Running dev server
```bash
pnpm start
```
## 🤝 Contributing
[Check how to contribute](https://github.com/tiagoporto/.github/blob/main/CONTRIBUTING.md).
## 🤜🤛 Donating
This project is developed on my free time, any donation is welcome.
[](https://github.com/sponsors/tiagoporto)
[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=YTDUQ8RZ2G4Q8&lc=BR&item_name=tiagoporto&item_number=geradorcpf¤cy_code=BRL&bn=PP%2dDonationsBF:btn_donateCC_LG%2egif:NonHosted)
## 📄 License
This project is licensed under the [MIT License](LICENSE).