From f64e562d1f9e941ee2a1a801898b44d02182a1d8 Mon Sep 17 00:00:00 2001
From: wendellast <wendelalves01a@hotmail.com>
Date: Sun, 23 Feb 2025 21:32:38 -0300
Subject: [PATCH] feat: add examples cpf

---
 examples/CPF/FormatCPF.md          | 25 +++++++++++++++++
 examples/CPF/FormatGeneratedCPF.md | 21 +++++++++++++++
 examples/CPF/GenerateCPF.md        | 43 ++++++++++++++++++++++++++++++
 examples/CPF/UnformatCPF.md        | 34 +++++++++++++++++++++++
 examples/CPF/ValidateCPF.md        | 35 ++++++++++++++++++++++++
 5 files changed, 158 insertions(+)
 create mode 100644 examples/CPF/FormatCPF.md
 create mode 100644 examples/CPF/FormatGeneratedCPF.md
 create mode 100644 examples/CPF/GenerateCPF.md
 create mode 100644 examples/CPF/UnformatCPF.md
 create mode 100644 examples/CPF/ValidateCPF.md

diff --git a/examples/CPF/FormatCPF.md b/examples/CPF/FormatCPF.md
new file mode 100644
index 0000000..604804b
--- /dev/null
+++ b/examples/CPF/FormatCPF.md
@@ -0,0 +1,25 @@
+---
+sidebar_position: 2
+---
+
+# FormatCPF
+
+
+Formats an unformatted CPF to the standard `XXX.XXX.XXX-XX` pattern.
+
+Parameters:
+- cpfString (string): The unformatted CPF.
+
+Return:
+- string: The formatted CPF.
+- error: An error if the CPF is invalid.
+
+Usage example:
+```go
+formattedCPF, err := validgen.FormatCPF("12345678909")
+if err != nil {
+    fmt.Println("Error formatting CPF:", err)
+} else {
+    fmt.Println("Formatted CPF:", formattedCPF)
+}
+```
diff --git a/examples/CPF/FormatGeneratedCPF.md b/examples/CPF/FormatGeneratedCPF.md
new file mode 100644
index 0000000..164c32c
--- /dev/null
+++ b/examples/CPF/FormatGeneratedCPF.md
@@ -0,0 +1,21 @@
+---
+sidebar_position: 5
+---
+
+# FormatGeneratedCPF
+
+Generates a valid random CPF and returns it formatted.
+
+Return:
+- string: The formatted CPF.
+- error: An error if something goes wrong.
+
+Usage example:
+```go
+cpf, err := cpf.CPFFunctions{}.FormatGeneratedCPF()
+if err != nil {
+    fmt.Println("Error generating CPF:", err)
+} else {
+    fmt.Println("Generated CPF:", cpf)
+}
+```
diff --git a/examples/CPF/GenerateCPF.md b/examples/CPF/GenerateCPF.md
new file mode 100644
index 0000000..10ffbd6
--- /dev/null
+++ b/examples/CPF/GenerateCPF.md
@@ -0,0 +1,43 @@
+---
+sidebar_position: 3
+---
+
+# GenerateCPF
+
+Generates a valid random CPF.
+
+Return:
+- string: The generated CPF.
+- error: An error if something goes wrong.
+
+Usage example:
+```go
+cpf, err := validgen.GenerateCPF()
+if err != nil {
+    fmt.Println("Error generating CPF:", err)
+} else {
+    fmt.Println("Generated CPF:", cpf)
+}
+```
+
+---
+sidebar_position: 3
+---
+
+# FormatGeneratedCPF
+
+Generates a valid random CPF and returns it formatted.
+
+Return:
+- string: The formatted CPF.
+- error: An error if something goes wrong.
+
+Usage example:
+```go
+cpf, err := cpf.CPFFunctions{}.FormatGeneratedCPF()
+if err != nil {
+    fmt.Println("Error generating CPF:", err)
+} else {
+    fmt.Println("Generated CPF:", cpf)
+}
+```
diff --git a/examples/CPF/UnformatCPF.md b/examples/CPF/UnformatCPF.md
new file mode 100644
index 0000000..0a1c87d
--- /dev/null
+++ b/examples/CPF/UnformatCPF.md
@@ -0,0 +1,34 @@
+---
+sidebar_position: 4
+---
+
+# UnformatCPF
+Removes formatting from a CPF.
+
+Parameters:
+- cpfString (string): The CPF formatted in the `XXX.XXX.XXX-XX` pattern.
+
+Return:
+- string: The unformatted CPF.
+- error: An error if the CPF is invalid.
+
+## Usage example
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/yourusername/validgen"
+)
+
+func main() {
+    unformattedCPF, err := validgen.UnformatCPF("123.456.789-09")
+
+    if err != nil {
+        fmt.Println("Error removing formatting:", err)
+    } else {
+        fmt.Println("Unformatted CPF:", unformattedCPF)
+    }
+}
+```
diff --git a/examples/CPF/ValidateCPF.md b/examples/CPF/ValidateCPF.md
new file mode 100644
index 0000000..73906f7
--- /dev/null
+++ b/examples/CPF/ValidateCPF.md
@@ -0,0 +1,35 @@
+---
+sidebar_position: 1
+---
+# ValidateCPF
+
+
+Validates whether a given CPF is valid.
+
+Parameters:
+- cpfString (string): The CPF to be validated (formatted or unformatted).
+
+Return:
+- error: Returns an error if the CPF is invalid, or `nil` if it is valid.
+
+Usage example:
+```go
+package main
+
+import (
+	"fmt"
+	"github.com/Hublastt/ValidGen/validgen"
+)
+
+func main() {
+	cpf := "123.456.789-09" // The CPF does not need to be formatted to be validated
+
+	if err := validgen.ValidateCPF(cpf); err != nil {
+		fmt.Println("Invalid CPF:", err)
+	} else {
+		fmt.Println("Valid CPF")
+	}
+
+}
+```
+