docs: move the v1 to v2 migration guide into the guides by hyanmandian · Pull Request #626 · brazilian-utils/javascript

hyanmandian · 2026-10-09T03:35:29Z

docs/migration-v1-to-v2.md → docs/guides/migration-v1-to-v2.md, and the same for docs/pt-br/. The docs site (brazilian-utils/docs) reads docs/guides/ as this library's guides, so the migration guide now shows up under Guides → JavaScript.
order: 1 in the front matter puts it after the other guides (Site: a /guides page, and the guides grouped by library in the sidebar docs#5 reads it).
The relative links inside the English file, the two _sidebar.md entries and the noscript link in docs/index.html follow the move.
.bestpractices.json keeps https://brazilian-utils.com.br/migration-v1-to-v2: the new site redirects it to the guide (Site: Cloudflare Pages, a /guides page by library, team roles docs#4).

scripts/llms.ts and scripts/site.ts run clean.

🤖 Generated with Claude Code

https://claude.ai/code/session_01RaUEDkvXY8rVWTJG2GKfhu

The docs site lists the files of docs/guides/ as the library's guides, so the migration guide shows up there next to the others. `order: 1` puts it after them. Links to it (sidebars, the noscript fallback) point at the new path. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RaUEDkvXY8rVWTJG2GKfhu

vercel · 2026-10-09T03:35:35Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated
brazilian-utils	Ready	Preview	Oct 9, 2026 3:37am UTC

coderabbitai · 2026-10-09T03:35:40Z

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI
Review profile: CHILL
Plan: Advanced
Run ID: b5d9ce6b-a6f9-4b37-85c3-8bb1c4d2c752

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

pkg-pr-new · 2026-10-09T03:36:18Z

Open in StackBlitz

npm i https://pkg.pr.new/@brazilian-utils/brazilian-utils@626

commit: 9bc5981

github-actions · 2026-10-09T03:36:49Z

Tree-shaking report

✅ No bundle size impact. All 200 exports are the same size as on the base branch (full import 1387.9 KB, gzip 293.3 KB).

All exports (200)

Export	Base	Head	gzip
⚪ `GetAddressInfoByCepError`	112 B	112 B	124 B
⚪ `GetAddressInfoByCepNotFoundError`	205 B	205 B	145 B
⚪ `GetAddressInfoByCepServiceError`	204 B	204 B	143 B
⚪ `GetAddressInfoByCepValidationError`	203 B	203 B	144 B
⚪ `GetCepInfoByAddressError`	112 B	112 B	124 B
⚪ `GetCepInfoByAddressNotFoundError`	205 B	205 B	145 B
⚪ `GetCepInfoByAddressValidationError`	203 B	203 B	144 B
⚪ `addBusinessDays`	9.2 KB	9.2 KB	3.2 KB
⚪ `capitalize`	2.5 KB	2.5 KB	1.3 KB
⚪ `convertCurrencyToWords`	2.0 KB	2.0 KB	1.0 KB
⚪ `convertDateToWords`	2.4 KB	2.4 KB	1.2 KB
⚪ `convertLicensePlateToMercosul`	632 B	632 B	425 B
⚪ `convertNumberToWords`	1.6 KB	1.6 KB	817 B
⚪ `differenceInBusinessDays`	9.1 KB	9.1 KB	3.2 KB
⚪ `formatBoleto`	668 B	668 B	407 B
⚪ `formatCEP`	489 B	489 B	348 B
⚪ `formatCNPJ`	639 B	639 B	430 B
⚪ `formatCPF`	540 B	540 B	376 B
⚪ `formatCaepf`	506 B	506 B	358 B
⚪ `formatCbo`	491 B	491 B	350 B
⚪ `formatCei`	503 B	503 B	356 B
⚪ `formatCep`	489 B	489 B	348 B
⚪ `formatCertidao`	532 B	532 B	361 B
⚪ `formatCest`	493 B	493 B	350 B
⚪ `formatCfop`	489 B	489 B	349 B
⚪ `formatCid10`	478 B	478 B	339 B
⚪ `formatCnae`	493 B	493 B	352 B
⚪ `formatCnh`	536 B	536 B	374 B
⚪ `formatCno`	507 B	507 B	357 B
⚪ `formatCnpj`	639 B	639 B	430 B
⚪ `formatCns`	506 B	506 B	352 B
⚪ `formatCpf`	540 B	540 B	376 B
⚪ `formatCurrency`	1023 B	1023 B	613 B
⚪ `formatIban`	267 B	267 B	228 B
⚪ `formatIsbn`	15.3 KB	15.3 KB	5.5 KB
⚪ `formatLegalNature`	489 B	489 B	349 B
⚪ `formatLicensePlate`	361 B	361 B	270 B
⚪ `formatNbs`	496 B	496 B	353 B
⚪ `formatNcm`	494 B	494 B	352 B
⚪ `formatNfeKey`	724 B	724 B	461 B
⚪ `formatPassport`	187 B	187 B	174 B
⚪ `formatPhone`	2.6 KB	2.6 KB	1.2 KB
⚪ `formatPis`	540 B	540 B	377 B
⚪ `formatProcessoJuridico`	509 B	509 B	357 B
⚪ `formatSuframa`	499 B	499 B	354 B
⚪ `formatVoterId`	542 B	542 B	377 B
⚪ `generateBoleto`	1.4 KB	1.4 KB	779 B
⚪ `generateCNPJ`	843 B	843 B	524 B
⚪ `generateCPF`	694 B	694 B	456 B
⚪ `generateCep`	1.3 KB	1.3 KB	471 B
⚪ `generateCnh`	565 B	565 B	343 B
⚪ `generateCnpj`	843 B	843 B	524 B
⚪ `generateCpf`	694 B	694 B	456 B
⚪ `generateLegalNature`	5.0 KB	5.0 KB	1.6 KB
⚪ `generateLicensePlate`	308 B	308 B	243 B
⚪ `generatePassport`	226 B	226 B	191 B
⚪ `generatePhone`	670 B	670 B	419 B
⚪ `generatePis`	357 B	357 B	273 B
⚪ `generatePixPayload`	5.0 KB	5.0 KB	2.2 KB
⚪ `generateProcessoJuridico`	821 B	821 B	523 B
⚪ `generateRenavam`	378 B	378 B	284 B
⚪ `generateSuframa`	451 B	451 B	335 B
⚪ `generateVoterId`	922 B	922 B	587 B
⚪ `getAddressInfoByCep`	5.3 KB	5.3 KB	2.1 KB
⚪ `getAreaCodeByMunicipalityCode`	23.6 KB	23.6 KB	5.6 KB
⚪ `getAreaCodeInfo`	3.1 KB	3.1 KB	989 B
⚪ `getAreaCodesByState`	814 B	814 B	463 B
⚪ `getBankByCode`	26.6 KB	26.6 KB	7.9 KB
⚪ `getBankByIspb`	26.5 KB	26.5 KB	7.8 KB
⚪ `getBanks`	26.2 KB	26.2 KB	7.6 KB
⚪ `getBoletoInfo`	2.7 KB	2.7 KB	1.4 KB
⚪ `getCbo`	80.6 KB	80.6 KB	24.1 KB
⚪ `getCepInfoByAddress`	2.2 KB	2.2 KB	1.1 KB
⚪ `getCertidaoInfo`	1.0 KB	1.0 KB	594 B
⚪ `getCest`	102.3 KB	102.3 KB	24.1 KB
⚪ `getCfop`	56.9 KB	56.9 KB	5.1 KB
⚪ `getCid10`	721.6 KB	721.6 KB	113.5 KB
⚪ `getCities`	64.2 KB	64.2 KB	26.4 KB
⚪ `getClassTrib`	50.0 KB	50.0 KB	9.0 KB
⚪ `getCnae`	66.8 KB	66.8 KB	17.7 KB
⚪ `getCnpjInfo`	964 B	964 B	542 B
⚪ `getCodeByMunicipalityName`	76.3 KB	76.3 KB	29.6 KB
⚪ `getCpfInfo`	1.1 KB	1.1 KB	683 B
⚪ `getCstIbsCbs`	963 B	963 B	534 B
⚪ `getFormatLicensePlate`	420 B	420 B	301 B
⚪ `getGtinInfo`	821 B	821 B	559 B
⚪ `getHolidays`	8.4 KB	8.4 KB	2.9 KB
⚪ `getIbanInfo`	752 B	752 B	492 B
⚪ `getIsbnInfo`	15.1 KB	15.1 KB	5.4 KB
⚪ `getLegalNature`	5.7 KB	5.7 KB	1.9 KB
⚪ `getLegalNatures`	5.1 KB	5.1 KB	1.6 KB
⚪ `getLegalNaturesByCategory`	5.6 KB	5.6 KB	1.9 KB
⚪ `getMunicipalities`	76.3 KB	76.3 KB	29.5 KB
⚪ `getMunicipalitiesByAreaCode`	90.4 KB	90.4 KB	33.0 KB
⚪ `getMunicipality`	77.2 KB	77.2 KB	30.1 KB
⚪ `getMunicipalityByCode`	76.3 KB	76.3 KB	29.6 KB
⚪ `getNbs`	51.1 KB	51.1 KB	11.3 KB
⚪ `getNfeKeyInfo`	2.2 KB	2.2 KB	1.2 KB
⚪ `getNfseKeyInfo`	2.6 KB	2.6 KB	1.2 KB
⚪ `getPixKeyInfo`	2.7 KB	2.7 KB	1.3 KB
⚪ `getPixPayloadInfo`	5.1 KB	5.1 KB	2.3 KB
⚪ `getProcessoJuridicoInfo`	1.1 KB	1.1 KB	623 B
⚪ `getRegions`	255 B	255 B	165 B
⚪ `getServiceItem`	25.5 KB	25.5 KB	8.2 KB
⚪ `getStateByCep`	3.6 KB	3.6 KB	1.0 KB
⚪ `getStateByIbgeCode`	2.4 KB	2.4 KB	700 B
⚪ `getStateCapital`	955 B	955 B	638 B
⚪ `getStateCodeByName`	2.4 KB	2.4 KB	691 B
⚪ `getStateNameByCode`	2.2 KB	2.2 KB	594 B
⚪ `getStates`	2.2 KB	2.2 KB	539 B
⚪ `getStatesByRegion`	2.3 KB	2.3 KB	602 B
⚪ `getTimezoneByState`	755 B	755 B	342 B
⚪ `getVoterIdInfo`	1.3 KB	1.3 KB	752 B
⚪ `isBusinessDay`	8.6 KB	8.6 KB	3.0 KB
⚪ `isHoliday`	8.4 KB	8.4 KB	2.9 KB
⚪ `isValidBankAccount`	5.1 KB	5.1 KB	1.9 KB
⚪ `isValidBoleto`	1.8 KB	1.8 KB	970 B
⚪ `isValidCEP`	165 B	165 B	165 B
⚪ `isValidCNPJ`	796 B	796 B	447 B
⚪ `isValidCPF`	500 B	500 B	334 B
⚪ `isValidCaepf`	782 B	782 B	479 B
⚪ `isValidCbo`	6.7 KB	6.7 KB	1.7 KB
⚪ `isValidCei`	714 B	714 B	472 B
⚪ `isValidCep`	165 B	165 B	165 B
⚪ `isValidCertidao`	758 B	758 B	462 B
⚪ `isValidCest`	3.6 KB	3.6 KB	856 B
⚪ `isValidCfop`	2.0 KB	2.0 KB	700 B
⚪ `isValidCid10`	6.7 KB	6.7 KB	2.4 KB
⚪ `isValidClassTrib`	1.8 KB	1.8 KB	610 B
⚪ `isValidCnae`	4.6 KB	4.6 KB	1.9 KB
⚪ `isValidCnh`	612 B	612 B	372 B
⚪ `isValidCno`	718 B	718 B	474 B
⚪ `isValidCnpj`	796 B	796 B	447 B
⚪ `isValidCns`	746 B	746 B	475 B
⚪ `isValidCpf`	500 B	500 B	334 B
⚪ `isValidCreditCard`	555 B	555 B	389 B
⚪ `isValidCsosn`	330 B	330 B	262 B
⚪ `isValidCst`	978 B	978 B	549 B
⚪ `isValidCstIbsCbs`	890 B	890 B	504 B
⚪ `isValidEmail`	244 B	244 B	198 B
⚪ `isValidGtin`	432 B	432 B	315 B
⚪ `isValidIE`	5.2 KB	5.2 KB	1.8 KB
⚪ `isValidIban`	531 B	531 B	376 B
⚪ `isValidIe`	5.2 KB	5.2 KB	1.8 KB
⚪ `isValidIsbn`	422 B	422 B	328 B
⚪ `isValidLandlinePhone`	890 B	890 B	561 B
⚪ `isValidLegalNature`	918 B	918 B	554 B
⚪ `isValidLicensePlate`	372 B	372 B	280 B
⚪ `isValidMobilePhone`	923 B	923 B	590 B
⚪ `isValidNbs`	3.5 KB	3.5 KB	1.3 KB
⚪ `isValidNcm`	29.6 KB	29.6 KB	9.0 KB
⚪ `isValidNfeKey`	1.6 KB	1.6 KB	956 B
⚪ `isValidNfseKey`	2.2 KB	2.2 KB	1.1 KB
⚪ `isValidPIS`	418 B	418 B	315 B
⚪ `isValidPassport`	197 B	197 B	186 B
⚪ `isValidPhone`	1.9 KB	1.9 KB	963 B
⚪ `isValidPis`	418 B	418 B	315 B
⚪ `isValidPixKey`	2.5 KB	2.5 KB	1.2 KB
⚪ `isValidPixPayload`	4.7 KB	4.7 KB	2.1 KB
⚪ `isValidProcessoJuridico`	711 B	711 B	432 B
⚪ `isValidRegistroProfissional`	1.3 KB	1.3 KB	787 B
⚪ `isValidRenavam`	518 B	518 B	358 B
⚪ `isValidServiceItem`	1.1 KB	1.1 KB	570 B
⚪ `isValidServicePhone`	1.0 KB	1.0 KB	573 B
⚪ `isValidSuframa`	611 B	611 B	418 B
⚪ `isValidVin`	898 B	898 B	600 B
⚪ `isValidVoterId`	728 B	728 B	433 B
⚪ `parseBoleto`	247 B	247 B	215 B
⚪ `parseCaepf`	199 B	199 B	183 B
⚪ `parseCbo`	198 B	198 B	182 B
⚪ `parseCei`	199 B	199 B	183 B
⚪ `parseCep`	198 B	198 B	182 B
⚪ `parseCertidao`	199 B	199 B	183 B
⚪ `parseCest`	198 B	198 B	182 B
⚪ `parseCfop`	198 B	198 B	182 B
⚪ `parseCid10`	177 B	177 B	170 B
⚪ `parseCnae`	198 B	198 B	182 B
⚪ `parseCnh`	199 B	199 B	183 B
⚪ `parseCno`	199 B	199 B	183 B
⚪ `parseCnpj`	298 B	298 B	240 B
⚪ `parseCns`	199 B	199 B	184 B
⚪ `parseCpf`	199 B	199 B	183 B
⚪ `parseCurrency`	610 B	610 B	409 B
⚪ `parseIban`	227 B	227 B	202 B
⚪ `parseIsbn`	150 B	150 B	150 B
⚪ `parseLegalNature`	198 B	198 B	182 B
⚪ `parseLicensePlate`	177 B	177 B	169 B
⚪ `parseNbs`	198 B	198 B	181 B
⚪ `parseNcm`	198 B	198 B	182 B
⚪ `parseNfeKey`	412 B	412 B	312 B
⚪ `parseNfseKey`	253 B	253 B	219 B
⚪ `parsePassport`	177 B	177 B	169 B
⚪ `parsePhone`	497 B	497 B	341 B
⚪ `parsePis`	199 B	199 B	183 B
⚪ `parseProcessoJuridico`	199 B	199 B	182 B
⚪ `parseSuframa`	198 B	198 B	181 B
⚪ `parseVoterId`	199 B	199 B	183 B
⚪ `removeAccents`	99 B	99 B	119 B
⚪ `subBusinessDays`	9.3 KB	9.3 KB	3.3 KB
⚪ `toStandardSchema`	324 B	324 B	254 B

How this is measured

Every export is imported alone into an esbuild consumer bundle (minified, tree-shaken) built from the head and from the base of this pull request; the sizes are the resulting bundles, gzip is their gzipped size. 🔴 marks a regression: a pre-existing export that grew more than 20% and more than 256 B, or the bundle importing every pre-existing export growing more than 5%. 🟡 is growth under the threshold, 🟢 a decrease, ⚪ no change, 🆕 an export that does not exist on the base (never a regression), 🗑️ an export that was removed. An intentional increase is accepted with the tree-shaking: accepted label.

codecov · 2026-10-09T03:38:11Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (7a217e0) to head (9bc5981).

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #626   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          263       263           
  Lines         2656      2656           
  Branches       754       754           
=========================================
  Hits          2656      2656

Flag	Coverage Δ
node	`100.00% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

vercel Bot deployed to Preview October 9, 2026 03:37 View deployment

This was referenced Oct 9, 2026

Site: Cloudflare Pages, a /guides page by library, team roles brazilian-utils/docs#4

Merged

docs: retire the docsify site, now built by brazilian-utils/docs #627

Merged

chore(deps-dev): clear the new dev-dependency advisories #628

Merged

Merge branch 'main' into hyan/migration-guide

9bc5981

hyanmandian merged commit bc2816b into main Oct 9, 2026
28 checks passed

Navigation Menu

Repository navigation

docs: move the v1 to v2 migration guide into the guides - #626

docs: move the v1 to v2 migration guide into the guides#626
hyanmandian merged 2 commits into
mainfrom
hyan/migration-guide

hyanmandian commented Oct 9, 2026

Uh oh!

vercel Bot commented Oct 9, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Oct 9, 2026 •

edited

Loading

Review skipped

Uh oh!

pkg-pr-new Bot commented Oct 9, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 9, 2026

Uh oh!

codecov Bot commented Oct 9, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

hyanmandian commented Oct 9, 2026

Uh oh!

vercel Bot commented Oct 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Oct 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

pkg-pr-new Bot commented Oct 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Oct 9, 2026

Tree-shaking report

Uh oh!

codecov Bot commented Oct 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

vercel Bot commented Oct 9, 2026 •

edited

Loading

coderabbitai Bot commented Oct 9, 2026 •

edited

Loading

pkg-pr-new Bot commented Oct 9, 2026 •

edited

Loading

codecov Bot commented Oct 9, 2026 •

edited

Loading