ApΓ³s um longo hiato, queremos comeΓ§ar pedindo desculpas por nΓ£o termos dado a devida atenΓ§Γ£o Γ biblioteca. Mas temos Γ³timas notΓcias: em 2025, voltaremos com tudo! π
Aqui estΓ‘ o que estamos planejando:
- RefatoraΓ§Γ£o do cΓ³digo: Vamos simplificar e padronizar a estrutura do projeto para facilitar contribuiΓ§Γ΅es e tornΓ‘-lo mais acessΓvel a todos.
- Nova documentaΓ§Γ£o: Teremos uma documentaΓ§Γ£o renovada, abrangendo nΓ£o apenas a biblioteca em JavaScript, mas tambΓ©m versΓ΅es em outras linguagens.
- PublicaΓ§Γ£o da versΓ£o 1.0: Finalmente, lanΓ§aremos a V1 oficial, acompanhada de um guia de migraΓ§Γ£o completo para facilitar a atualizaΓ§Γ£o.
- ResoluΓ§Γ£o de issues abertas: Nos comprometemos a revisar e resolver todas as issues pendentes da comunidade.
Estamos super empolgados com o futuro do projeto e esperamos que vocΓͺs tambΓ©m estejam! π
Por favor, fiquem Γ vontade para abrir issues ou iniciar discussions. Vamos construir algo incrΓvel juntos! β€οΈ
Table of Contents
Brazilian Utils is a library focused on solving problems that we face daily in the development of applications for the Brazilian business.
Using Brazilian Utils is quite simple and you can use it in some ways:
as npm package:
npm install --save @brazilian-utils/brazilian-utils
with yarn package manager:
yarn add @brazilian-utils/brazilian-utils
or <script>
tag (global brazilianUtils
):
<script src="https://unpkg.com/@brazilian-utils/brazilian-utils/dist/brazilian-utils.cjs.production.min.js"></script>
To use one of our utilities you just need to import the required function as in the example below:
import { isValidCPF } from '@brazilian-utils/brazilian-utils';
isValidCPF('1232454233345'); // false
You can check a list of utilities by clicking here.
Our "thank you" goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind are welcome!