feat: CI/CD improvements + translations

- Translate entire test suite from Portuguese to English
- Update GitHub Actions with Node.js 22.x and coverage upload
- Add test:watch script and update dependencies
- Improve README documentation and structure

Author: marcelo-lourenco

.github/workflows/node-test-runner.yml

@@ -1,29 +1,45 @@
 name: Node Test Runner
+
 on:
   push:
     branches: [ main, master ]
   pull_request:
     branches: [ main, master ]
   schedule:
-    - cron: '0 */12 * * *'
+    - cron: '0 0 * * 0' # Every Sunday at midnight
+
+permissions:
+  contents: read
+
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
+    timeout-minutes: 10
 
     strategy:
       matrix:
-        node-version: [20.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+        node-version: [22.x]
 
     steps:
     - name: Checkout repository
       uses: actions/checkout@v4
+
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
+
     - name: Install dependencies
       run: npm ci
-    - name: Run tests
-      ###run: npm test
+
+    - name: Run Node.js native tests
+      run: npm test
+
+    - name: Upload Coverage Results
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: node-test-coverage
+        path: coverage/ # Caso você use a flag --experimental-test-coverage
+        retention-days: 30

.gitignore

@@ -1 +1,2 @@
-node_modules
+# Dependencies
+node_modules/

README.md

@@ -4,21 +4,20 @@ Example project for automated tests using **Node Test Runner** and **Gerador BR*
 
 ## Setup
 
-**Prerequisites:**
+## Prerequisites
 
 * [Node.js](https://nodejs.org/) (includes npm)
 
-**Installation:**
+## Installation
 
-1. Clone this repository.
-2. Open your terminal in the project's root folder.
-3. Run the command to install dependencies:
+1. Clone this repository
+2. Install dependencies:
 
 ```bash
 npm install
 ```
 
-## Running the Tests
+## Running Tests
 
 To execute the tests, use the following command:
 
@@ -37,5 +36,5 @@ Test files are located in the `test` folder.
 The tests use data generated by Gerador-BR to validate forms or business logic with realistic Brazilian data.
 
 ## Documentation
-
-* [Gerador-BR Documentation](https://box4.dev/gerador-br/)
+* [Node Test Runner](https://nodejs.org/api/test.html)
+* [Gerador-BR documentation](https://box4.dev/gerador-br/documentacao/?utm_source=github&utm_medium=node_data_generator)

package-lock.json

@@ -4,10 +4,11 @@
   "description": "Example of using Node Test Runner with the Gerador-BR data generator",
   "type":"module",
   "scripts": {
-    "test": "node --test test"
+    "test": "node --test",
+    "test:watch": "node --test --watch"
   },
   "devDependencies": {
-    "gerador-br": "^1.2.3"
+    "gerador-br": "latest"
   },
   "keywords": [
     "node",

package.json

@@ -2,7 +2,7 @@ import { describe, test } from 'node:test';
 import { strictEqual } from 'node:assert';
 import { cartaoCredito } from 'gerador-br';
 
-describe('Cartão de Crédito Generator', () => {
+describe('Credit Card Generator', () => {
   test('should generate a valid credit card number without mask', () => {
     const creditCardData = cartaoCredito(false);
     strictEqual(typeof creditCardData.numero, 'string');
@@ -12,7 +12,7 @@ describe('Cartão de Crédito Generator', () => {
   test('should generate a valid credit card number with mask', () => {
     const creditCardData = cartaoCredito(true);
     strictEqual(typeof creditCardData.numero, 'string');
-    strictEqual(creditCardData.numero.length, 19); // formato: xxxx xxxx xxxx xxxx
+    strictEqual(creditCardData.numero.length, 19); // format: xxxx xxxx xxxx xxxx
     strictEqual(creditCardData.numero.split(' ').length, 4);
   });
 

test/cartao-credito.test.js

@@ -2,85 +2,85 @@ import { describe, test } from 'node:test';
 import { match, strictEqual } from 'node:assert';
 import { certidao } from 'gerador-br';
 
-describe('certidao.js', () => {
-  test('Geração de número de certidão de nascimento com máscara', () => {
+describe('Certificate Generator', () => {
+  test('Generate birth certificate number with mask', () => {
     const result = certidao.nascimento(true);
-    // Verifica a máscara do número de certidão
-    match(result, /^\d{6} \d{2} \d{4} 1001 \d \d{5} \d{3} \d{7}$/, 'A máscara da certidão de nascimento está incorreta');
+    // Checks the certificate number mask
+    match(result, /^\d{6} \d{2} \d{4} 1001 \d \d{5} \d{3} \d{7}$/, 'Birth certificate mask is incorrect');
   });
 
-  test('Geração de número de certidão de nascimento sem máscara', () => {
+  test('Generate birth certificate number without mask', () => {
     const result = certidao.nascimento(false);
-    // Verifica a ausência da máscara no número de certidão
-    match(result, /^\d{32}$/, 'O número de certidão de nascimento sem máscara deve ter 32 dígitos');
+    // Checks the absence of mask in the certificate number
+    match(result, /^\d{32}$/, 'Birth certificate number without mask must have 32 digits');
   });
 
-  test('Geração de número de certidão de casamento com máscara', () => {
+  test('Generate marriage certificate number with mask', () => {
     const result = certidao.casamento(true);
-    // Verifica a máscara do número de certidão
-    match(result, /^\d{6} \d{2} \d{4} 2001 \d \d{5} \d{3} \d{7}$/, 'A máscara da certidão de casamento está incorreta');
+    // Checks the certificate number mask
+    match(result, /^\d{6} \d{2} \d{4} 2001 \d \d{5} \d{3} \d{7}$/, 'Marriage certificate mask is incorrect');
   });
 
-  test('Geração de número de certidão de casamento sem máscara', () => {
+  test('Generate marriage certificate number without mask', () => {
     const result = certidao.casamento(false);
-    // Verifica a ausência da máscara no número de certidão
-    match(result, /^\d{32}$/, 'O número de certidão de casamento sem máscara deve ter 32 dígitos');
+    // Checks the absence of mask in the certificate number
+    match(result, /^\d{32}$/, 'Marriage certificate number without mask must have 32 digits');
   });
 
-  test('Geração de número de certidão de óbito com máscara', () => {
+  test('Generate death certificate number with mask', () => {
     const result = certidao.obito(true);
-    // Verifica a máscara do número de certidão
-    match(result, /^\d{6} \d{2} \d{4} 3001 \d \d{5} \d{3} \d{7}$/, 'A máscara da certidão de óbito está incorreta');
+    // Checks the certificate number mask
+    match(result, /^\d{6} \d{2} \d{4} 3001 \d \d{5} \d{3} \d{7}$/, 'Death certificate mask is incorrect');
   });
 
-  test('Geração de número de certidão de óbito sem máscara', () => {
+  test('Generate death certificate number without mask', () => {
     const result = certidao.obito(false);
-    // Verifica a ausência da máscara no número de certidão
-    match(result, /^\d{32}$/, 'O número de certidão de óbito sem máscara deve ter 32 dígitos');
+    // Checks the absence of mask in the certificate number
+    match(result, /^\d{32}$/, 'Death certificate number without mask must have 32 digits');
   });
 
-  test('Geração de objeto detalhado para certidão de nascimento', () => {
+  test('Generate detailed object for birth certificate', () => {
     const result = certidao.nascimentoObj();
-    strictEqual(result.tipoCertidao, 'Nascimento', 'Tipo da certidão deve ser "Nascimento"');
-    match(result.cartorio, /^\d{6}$/, 'O código do cartório deve ter 6 dígitos');
-    match(result.estado, /^\d{2}$/, 'O código do estado deve ter 2 dígitos');
-    match(result.anoRegistro, /^\d{4}$/, 'O ano de registro deve ter 4 dígitos');
-    strictEqual(result.tipoLivro, '1001', 'Tipo de livro deve ser "1001" para certidão de nascimento');
+    strictEqual(result.tipoCertidao, 'Nascimento', 'Certificate type should be "Nascimento"');
+    match(result.cartorio, /^\d{6}$/, 'Registry office code must have 6 digits');
+    match(result.estado, /^\d{2}$/, 'State code must have 2 digits');
+    match(result.anoRegistro, /^\d{4}$/, 'Registration year must have 4 digits');
+    strictEqual(result.tipoLivro, '1001', 'Book type should be "1001" for birth certificate');
   });
 
-  test('Geração de objeto detalhado para certidão de casamento', () => {
+  test('Generate detailed object for marriage certificate', () => {
     const result = certidao.casamentoObj();
-    strictEqual(result.tipoCertidao, 'Casamento', 'Tipo da certidão deve ser "Casamento"');
-    match(result.cartorio, /^\d{6}$/, 'O código do cartório deve ter 6 dígitos');
-    match(result.estado, /^\d{2}$/, 'O código do estado deve ter 2 dígitos');
-    match(result.anoRegistro, /^\d{4}$/, 'O ano de registro deve ter 4 dígitos');
-    strictEqual(result.tipoLivro, '2001', 'Tipo de livro deve ser "2001" para certidão de casamento');
+    strictEqual(result.tipoCertidao, 'Casamento', 'Certificate type should be "Casamento"');
+    match(result.cartorio, /^\d{6}$/, 'Registry office code must have 6 digits');
+    match(result.estado, /^\d{2}$/, 'State code must have 2 digits');
+    match(result.anoRegistro, /^\d{4}$/, 'Registration year must have 4 digits');
+    strictEqual(result.tipoLivro, '2001', 'Book type should be "2001" for marriage certificate');
   });
 
-  test('Geração de objeto detalhado para certidão de óbito', () => {
+  test('Generate detailed object for death certificate', () => {
     const result = certidao.obitoObj();
-    strictEqual(result.tipoCertidao, 'Óbito', 'Tipo da certidão deve ser "Óbito"');
-    match(result.cartorio, /^\d{6}$/, 'O código do cartório deve ter 6 dígitos');
-    match(result.estado, /^\d{2}$/, 'O código do estado deve ter 2 dígitos');
-    match(result.anoRegistro, /^\d{4}$/, 'O ano de registro deve ter 4 dígitos');
-    strictEqual(result.tipoLivro, '3001', 'Tipo de livro deve ser "3001" para certidão de óbito');
+    strictEqual(result.tipoCertidao, 'Óbito', 'Certificate type should be "Óbito"');
+    match(result.cartorio, /^\d{6}$/, 'Registry office code must have 6 digits');
+    match(result.estado, /^\d{2}$/, 'State code must have 2 digits');
+    match(result.anoRegistro, /^\d{4}$/, 'Registration year must have 4 digits');
+    strictEqual(result.tipoLivro, '3001', 'Book type should be "3001" for death certificate');
   });
 
-  test('Geração de certidão aleatória', () => {
+  test('Generate random certificate', () => {
     const result = certidao.aleatoriaObj();
-    match(result.tipoCertidao, /^(Nascimento|Casamento|Óbito)$/, 'Tipo da certidão aleatória deve ser "Nascimento", "Casamento" ou "Óbito"');
-    match(result.cartorio, /^\d{6}$/, 'O código do cartório deve ter 6 dígitos');
-    match(result.estado, /^\d{2}$/, 'O código do estado deve ter 2 dígitos');
-    match(result.anoRegistro, /^\d{4}$/, 'O ano de registro deve ter 4 dígitos');
+    match(result.tipoCertidao, /^(Nascimento|Casamento|Óbito)$/, 'Random certificate type should be "Nascimento", "Casamento" or "Óbito"');
+    match(result.cartorio, /^\d{6}$/, 'Registry office code must have 6 digits');
+    match(result.estado, /^\d{2}$/, 'State code must have 2 digits');
+    match(result.anoRegistro, /^\d{4}$/, 'Registration year must have 4 digits');
   });
 
-  test('Geração de certidão aleatória com máscara', () => {
+  test('Generate random certificate with mask', () => {
     const result = certidao.aleatoria();
-    match(result, /^\d{6} \d{2} \d{4} \d{4} \d \d{5} \d{3} \d{7}$/, 'A máscara da certidão aleatória está incorreta');
+    match(result, /^\d{6} \d{2} \d{4} \d{4} \d \d{5} \d{3} \d{7}$/, 'Random certificate mask is incorrect');
   });
 
-  test('Geração de certidão aleatória sem máscara', () => {
+  test('Generate random certificate without mask', () => {
     const result = certidao.aleatoria(false);
-    match(result, /^\d{32}$/, 'O número de certidão aleatória sem máscara deve ter 32 dígitos');
+    match(result, /^\d{32}$/, 'Random certificate number without mask must have 32 digits');
   });
 });

test/certidao.test.js

@@ -2,7 +2,7 @@ import { describe, test } from 'node:test';
 import { strictEqual } from 'node:assert';
 import { endereco } from 'gerador-br';
 
-describe('Endereço Generator', () => {
+describe('Address Generator', () => {
   test('should generate a valid address with mask', () => {
     const addressWithMask = endereco(true);
     strictEqual(addressWithMask.cep.length, 9);

test/endereco.test.js

@@ -2,7 +2,7 @@ import { describe, test } from 'node:test';
 import { strictEqual } from 'node:assert';
 import { escolaridade } from 'gerador-br';
 
-describe('Escolaridade Generator', () => {
+describe('Education Level Generator', () => {
   test('should generate a valid education level', () => {
     const educationLevel = escolaridade();
     strictEqual(typeof educationLevel, 'string');

test/escolaridade.test.js

@@ -2,7 +2,7 @@ import { describe, test } from 'node:test';
 import { strictEqual, ok } from 'node:assert';
 import { genero } from 'gerador-br';
 
-describe('Genero Generator', () => {
+describe('Gender Generator', () => {
   test('should return "Feminino" for input "f"', () => {
     strictEqual(genero('f'), 'Feminino');
   });