gerar 0.0.2

package/.github/workflows/publish.yml

@@ -0,0 +1,51 @@
+name: Publish to NPM Registry
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+
+      - name: Enable Corepack & setup pnpm v10.20.0
+        run: |
+          corepack enable
+          corepack prepare pnpm@10.20.0 --activate
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22.12.0"
+          registry-url: "https://registry.npmjs.org/"
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Test project
+        run: pnpm test
+
+      - name: Build project
+        run: pnpm build
+
+      - name: Detect tag and bump version in package.json
+        run: |
+          if [[ "${GITHUB_REF}" == refs/tags/* ]]; then
+            TAG_VERSION="${GITHUB_REF##*/}"
+            NEW_VERSION="${TAG_VERSION#v}"
+            jq --arg version "$NEW_VERSION" '.version = $version' package.json > package.tmp.json
+            mv package.tmp.json package.json
+          else
+            echo "::error::Este workflow só pode ser disparado por uma tag!"
+            exit 1
+          fi
+
+      - name: Publish to NPM
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/Makefile

@@ -0,0 +1,22 @@
+.PHONY: build install check-node-version check-pnpm-version check-installation unit-tests watch-unit-tests
+
+check-node-version:
+	@node -v | grep -q 'v22' || (echo "Node.js LTS version is required." && exit 1)
+
+check-pnpm-version: check-node-version
+	@pnpm -v | grep -q '10.' || (echo "pnpm version 10.x is required." && exit 1)
+
+check-installation: check-node-version check-pnpm-version
+	@if [ ! -d "node_modules" ]; then echo "Dependencies are not installed. Run make install." && exit 1; fi
+
+install: check-node-version check-pnpm-version
+	@pnpm install;
+
+build: check-node-version check-pnpm-version check-installation
+	@pnpm build;
+
+unit-tests: check-node-version check-pnpm-version check-installation
+	@pnpm test;
+
+watch-unit-tests: check-node-version check-pnpm-version check-installation
+	@pnpm test:watch;

package/dist/commands/cpf/index.d.ts

@@ -0,0 +1,2 @@
+import { CommandStructure } from "../../shared/utils/command-structure";
+export declare const cpfCommand: CommandStructure;

package/dist/commands/cpf/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cpfCommand = void 0;
+const utils_1 = require("./utils");
+exports.cpfCommand = {
+    name: "cpf",
+    description: "Gera um CPF fictício válido.",
+    action: (options) => {
+        const generatedCpfs = Array.from({ length: options.amount ?? 1 }, utils_1.generateCpf);
+        generatedCpfs.forEach((generatedCpf, index) => {
+            console.log(`CPF ${index + 1}) Com Máscara: ${generatedCpf.withMask} - Sem Máscara: ${generatedCpf.withoutMask}`);
+        });
+    },
+};
+//# sourceMappingURL=index.js.map

package/dist/commands/cpf/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/cpf/index.ts"],"names":[],"mappings":";;;AACA,mCAAsC;AAEzB,QAAA,UAAU,GAAqB;IAC1C,IAAI,EAAE,KAAK;IACX,WAAW,EAAE,8BAA8B;IAC3C,MAAM,EAAE,CAAC,OAA4B,EAAE,EAAE;QACvC,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAC9B,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,EAAE,EAC/B,mBAAW,CACZ,CAAC;QAEF,aAAa,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE;YAC5C,OAAO,CAAC,GAAG,CACT,OAAO,KAAK,GAAG,CAAC,kBACd,YAAY,CAAC,QACf,mBAAmB,YAAY,CAAC,WAAW,EAAE,CAC9C,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAC"}

package/dist/commands/cpf/utils.d.ts

@@ -0,0 +1,7 @@
+type GenerateCpfResponse = {
+    withMask: string;
+    withoutMask: string;
+};
+export declare const calculateCpfDigit: (cpf: string) => number;
+export declare const generateCpf: () => GenerateCpfResponse;
+export {};

package/dist/commands/cpf/utils.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateCpf = exports.calculateCpfDigit = void 0;
+const calculateCpfDigit = (cpf) => {
+    const length = cpf.length + 1;
+    const sum = cpf
+        .split("")
+        .reduce((acc, num, index) => acc + Number(num) * (length - index), 0);
+    const remainder = sum % 11;
+    return remainder < 2 ? 0 : 11 - remainder;
+};
+exports.calculateCpfDigit = calculateCpfDigit;
+const generateCpf = () => {
+    const baseCpf = Array.from({ length: 9 }, () => Math.floor(Math.random() * 10)).join("");
+    const firstDigit = (0, exports.calculateCpfDigit)(baseCpf);
+    const lastDigit = (0, exports.calculateCpfDigit)(baseCpf + firstDigit);
+    const fullCpf = baseCpf + firstDigit.toString() + lastDigit.toString();
+    return {
+        // TODO: Improve this as soon as possible.
+        withMask: `${fullCpf.slice(0, 3)}.${fullCpf.slice(3, 6)}.${fullCpf.slice(6, 9)}-${fullCpf.slice(9, 11)}`,
+        withoutMask: fullCpf,
+    };
+};
+exports.generateCpf = generateCpf;
+//# sourceMappingURL=utils.js.map

package/dist/commands/cpf/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/commands/cpf/utils.ts"],"names":[],"mappings":";;;AAKO,MAAM,iBAAiB,GAAG,CAAC,GAAW,EAAU,EAAE;IACvD,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;IAC9B,MAAM,GAAG,GAAG,GAAG;SACZ,KAAK,CAAC,EAAE,CAAC;SACT,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IAExE,MAAM,SAAS,GAAG,GAAG,GAAG,EAAE,CAAC;IAE3B,OAAO,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC;AAC5C,CAAC,CAAC;AATW,QAAA,iBAAiB,qBAS5B;AAEK,MAAM,WAAW,GAAG,GAAwB,EAAE;IACnD,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,CAC7C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAC/B,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEX,MAAM,UAAU,GAAG,IAAA,yBAAiB,EAAC,OAAO,CAAC,CAAC;IAC9C,MAAM,SAAS,GAAG,IAAA,yBAAiB,EAAC,OAAO,GAAG,UAAU,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,OAAO,GAAG,UAAU,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;IAEvE,OAAO;QACL,0CAA0C;QAC1C,QAAQ,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,CACtE,CAAC,EACD,CAAC,CACF,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE;QAC3B,WAAW,EAAE,OAAO;KACrB,CAAC;AACJ,CAAC,CAAC;AAlBW,QAAA,WAAW,eAkBtB"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/index.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const cpf_1 = require("./commands/cpf");
+const program = new commander_1.Command();
+program
+    .name("gerar")
+    .description("CLI brasileiro para gerar dados fictícios para testes.")
+    .version("0.0.1");
+program.helpCommand("help", "Exibe informações de ajuda do CLI.");
+// TODO: Create automatic registration for commands.
+program
+    .command(cpf_1.cpfCommand.name)
+    .description(cpf_1.cpfCommand.description)
+    .option("-a, --amount <amount>", "Quantidade a ser gerado.", (value) => Number(value))
+    .action(cpf_1.cpfCommand.action);
+program.parse();
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,yCAAoC;AACpC,wCAA4C;AAE5C,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,OAAO,CAAC;KACb,WAAW,CAAC,wDAAwD,CAAC;KACrE,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpB,OAAO,CAAC,WAAW,CAAC,MAAM,EAAE,oCAAoC,CAAC,CAAC;AAElE,oDAAoD;AACpD,OAAO;KACJ,OAAO,CAAC,gBAAU,CAAC,IAAI,CAAC;KACxB,WAAW,CAAC,gBAAU,CAAC,WAAW,CAAC;KACnC,MAAM,CACL,uBAAuB,EACvB,0BAA0B,EAC1B,CAAC,KAAa,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CACjC;KACA,MAAM,CAAC,gBAAU,CAAC,MAAM,CAAC,CAAC;AAE7B,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/dist/shared/utils/command-structure.d.ts

@@ -0,0 +1,6 @@
+import { Command } from "commander";
+export type CommandStructure = {
+    name: string;
+    description: string;
+    action: (this: Command, ...args: any[]) => void | Promise<void>;
+};

package/dist/shared/utils/command-structure.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=command-structure.js.map

package/dist/shared/utils/command-structure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command-structure.js","sourceRoot":"","sources":["../../../src/shared/utils/command-structure.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "gerar",
+  "version": "0.0.2",
+  "description": "CLI brasileiro para gerar dados fictícios para testes.",
+  "main": "dist/index.js",
+  "author": "Victor Ribeiro Boechat",
+  "bin": {
+    "gerar": "dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc -p .",
+    "dev": "tsx src/index.ts",
+    "start": "node dist/index.js",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "keywords": [],
+  "license": "ISC",
+  "dependencies": {
+    "commander": "^14.0.2"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "tsx": "^4.19.2",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.13"
+  },
+  "packageManager": "pnpm@10.20.0"
+}

package/src/commands/cpf/index.ts

@@ -0,0 +1,21 @@
+import { CommandStructure } from "../../shared/utils/command-structure";
+import { generateCpf } from "./utils";
+
+export const cpfCommand: CommandStructure = {
+  name: "cpf",
+  description: "Gera um CPF fictício válido.",
+  action: (options: { amount?: number }) => {
+    const generatedCpfs = Array.from(
+      { length: options.amount ?? 1 },
+      generateCpf
+    );
+
+    generatedCpfs.forEach((generatedCpf, index) => {
+      console.log(
+        `CPF ${index + 1}) Com Máscara: ${
+          generatedCpf.withMask
+        } - Sem Máscara: ${generatedCpf.withoutMask}`
+      );
+    });
+  },
+};

package/src/commands/cpf/tests/utils.test.ts

@@ -0,0 +1,114 @@
+import { describe, it, expect, expectTypeOf } from "vitest";
+import { calculateCpfDigit, generateCpf } from "../utils";
+
+describe("calculateCpfDigit", () => {
+  it("should calculate the first check digit correctly for known CPF", () => {
+    const firstDigit = calculateCpfDigit("111444777");
+
+    expect(firstDigit).toBe(3);
+  });
+
+  it("should calculate the second check digit correctly for known CPF", () => {
+    const secondDigit = calculateCpfDigit("1114447773");
+
+    expect(secondDigit).toBe(5);
+  });
+
+  it("should return 0 when remainder is less than 2", () => {
+    const digit = calculateCpfDigit("000000000");
+
+    expect(digit).toBe(0);
+  });
+
+  it("should return correct digit when remainder is 2 or greater", () => {
+    const digit = calculateCpfDigit("123456789");
+
+    expect(digit).toBeGreaterThanOrEqual(0);
+    expect(digit).toBeLessThanOrEqual(9);
+  });
+
+  it("should handle 9-digit input correctly", () => {
+    const digit = calculateCpfDigit("123456789");
+
+    expect(digit).toBeTypeOf("number");
+    expect(digit).toBeGreaterThanOrEqual(0);
+    expect(digit).toBeLessThanOrEqual(9);
+  });
+
+  it("should handle 10-digit input correctly (for second digit calculation)", () => {
+    const digit = calculateCpfDigit("1234567890");
+
+    expect(digit).toBeTypeOf("number");
+    expect(digit).toBeGreaterThanOrEqual(0);
+    expect(digit).toBeLessThanOrEqual(9);
+  });
+});
+
+describe("generateCpf", () => {
+  it("should generate a CPF with correct structure", () => {
+    const result = generateCpf();
+
+    expect(result).toHaveProperty("withMask");
+    expect(result).toHaveProperty("withoutMask");
+  });
+
+  it("should generate CPF withoutMask with exactly 11 digits", () => {
+    const result = generateCpf();
+
+    expect(result.withoutMask).toMatch(/^\d{11}$/);
+    expect(result.withoutMask.length).toBe(11);
+  });
+
+  it("should generate CPF withMask in correct format (XXX.XXX.XXX-XX)", () => {
+    const result = generateCpf();
+
+    expect(result.withMask).toMatch(/^\d{3}\.\d{3}\.\d{3}-\d{2}$/);
+  });
+
+  it("should generate valid CPF digits (check digits are correct)", () => {
+    const result = generateCpf();
+    const cpf = result.withoutMask;
+
+    const base = cpf.slice(0, 9);
+    const firstCheckDigit = Number(cpf[9]);
+    const secondCheckDigit = Number(cpf[10]);
+
+    const calculatedFirstDigit = calculateCpfDigit(base);
+    expect(firstCheckDigit).toBe(calculatedFirstDigit);
+
+    const calculatedSecondDigit = calculateCpfDigit(base + firstCheckDigit);
+    expect(secondCheckDigit).toBe(calculatedSecondDigit);
+  });
+
+  it("should generate different CPFs on multiple calls", () => {
+    const results = Array.from({ length: 10 }, () => generateCpf());
+    const uniqueCpfs = new Set(results.map((r) => r.withoutMask));
+
+    expect(uniqueCpfs.size).toBeGreaterThan(1);
+  });
+
+  it("should generate CPF where withMask and withoutMask represent the same number", () => {
+    const result = generateCpf();
+
+    const unmasked = result.withMask.replace(/[.-]/g, "");
+
+    expect(unmasked).toBe(result.withoutMask);
+  });
+
+  it("should generate multiple valid CPFs", () => {
+    const results = Array.from({ length: 100 }, () => generateCpf());
+
+    results.forEach((result) => {
+      const cpf = result.withoutMask;
+      const base = cpf.slice(0, 9);
+      const firstCheckDigit = Number(cpf[9]);
+      const secondCheckDigit = Number(cpf[10]);
+
+      const calculatedFirstDigit = calculateCpfDigit(base);
+      const calculatedSecondDigit = calculateCpfDigit(base + firstCheckDigit);
+
+      expect(firstCheckDigit).toBe(calculatedFirstDigit);
+      expect(secondCheckDigit).toBe(calculatedSecondDigit);
+    });
+  });
+});

package/src/commands/cpf/utils.ts

@@ -0,0 +1,35 @@
+type GenerateCpfResponse = {
+  withMask: string;
+  withoutMask: string;
+};
+
+export const calculateCpfDigit = (cpf: string): number => {
+  const length = cpf.length + 1;
+  const sum = cpf
+    .split("")
+    .reduce((acc, num, index) => acc + Number(num) * (length - index), 0);
+
+  const remainder = sum % 11;
+
+  return remainder < 2 ? 0 : 11 - remainder;
+};
+
+export const generateCpf = (): GenerateCpfResponse => {
+  const baseCpf = Array.from({ length: 9 }, () =>
+    Math.floor(Math.random() * 10)
+  ).join("");
+
+  const firstDigit = calculateCpfDigit(baseCpf);
+  const lastDigit = calculateCpfDigit(baseCpf + firstDigit);
+
+  const fullCpf = baseCpf + firstDigit.toString() + lastDigit.toString();
+
+  return {
+    // TODO: Improve this as soon as possible.
+    withMask: `${fullCpf.slice(0, 3)}.${fullCpf.slice(3, 6)}.${fullCpf.slice(
+      6,
+      9
+    )}-${fullCpf.slice(9, 11)}`,
+    withoutMask: fullCpf,
+  };
+};

package/src/index.ts

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+import { Command } from "commander";
+import { cpfCommand } from "./commands/cpf";
+
+const program = new Command();
+
+program
+  .name("gerar")
+  .description("CLI brasileiro para gerar dados fictícios para testes.")
+  .version("0.0.1");
+
+program.helpCommand("help", "Exibe informações de ajuda do CLI.");
+
+// TODO: Create automatic registration for commands.
+program
+  .command(cpfCommand.name)
+  .description(cpfCommand.description)
+  .option(
+    "-a, --amount <amount>",
+    "Quantidade a ser gerado.",
+    (value: string) => Number(value)
+  )
+  .action(cpfCommand.action);
+
+program.parse();

package/src/shared/utils/command-structure.ts

@@ -0,0 +1,7 @@
+import { Command } from "commander";
+
+export type CommandStructure = {
+  name: string;
+  description: string;
+  action: (this: Command, ...args: any[]) => void | Promise<void>;
+};

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "module": "commonjs",
+    "lib": ["es2022"],
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "sourceMap": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "src/**/tests/**"]
+}