Skip to content

Commit 5b9a0dd

Browse files
committed
chore: Update documentation files and fixing tests
1 parent 72b527d commit 5b9a0dd

26 files changed

+416
-121
lines changed

.github/FUNDING.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# These are supported funding model platforms
22

3-
github: [gabriel-logan] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
3+
github: [ gabriel-logan ] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
44
patreon: # Replace with a single Patreon username
55
open_collective: # Replace with a single Open Collective username
66
ko_fi: # Replace with a single Ko-fi username

.github/ISSUE_TEMPLATE/bug_report.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ A clear and concise description of what the bug is.
1212

1313
**To Reproduce**
1414
Steps to reproduce the behavior:
15+
1516
1. Go to '...'
1617
2. Click on '....'
1718
3. Scroll down to '....'
@@ -24,15 +25,17 @@ A clear and concise description of what you expected to happen.
2425
If applicable, add screenshots to help explain your problem.
2526

2627
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
28+
29+
- OS: [e.g. iOS]
30+
- Browser [e.g. chrome, safari]
31+
- Version [e.g. 22]
3032

3133
**Smartphone (please complete the following information):**
32-
- Device: [e.g. iPhone6]
33-
- OS: [e.g. iOS8.1]
34-
- Browser [e.g. stock browser, safari]
35-
- Version [e.g. 22]
34+
35+
- Device: [e.g. iPhone6]
36+
- OS: [e.g. iOS8.1]
37+
- Browser [e.g. stock browser, safari]
38+
- Version [e.g. 22]
3639

3740
**Additional context**
3841
Add any other context about the problem here.

.github/workflows/java-pr-check.yml

+10-10
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
branches: [ main ]
66

77
pull_request:
8-
branches: [ main ]
8+
branches: [ main ]
99

1010
workflow_dispatch:
1111

@@ -14,13 +14,13 @@ jobs:
1414
runs-on: ubuntu-latest
1515

1616
steps:
17-
- uses: actions/checkout@v4
17+
- uses: actions/checkout@v4
1818

19-
- name: Set up JDK 8
20-
uses: actions/setup-java@v4
21-
with:
22-
java-version: '8'
23-
distribution: 'temurin'
24-
cache: maven
25-
- name: Build with Maven
26-
run: mvn -B package --file pom.xml
19+
- name: Set up JDK 8
20+
uses: actions/setup-java@v4
21+
with:
22+
java-version: '8'
23+
distribution: 'temurin'
24+
cache: maven
25+
- name: Build with Maven
26+
run: mvn -B package --file pom.xml

.github/workflows/maven-publish.yml

+15-15
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ name: Maven Package
55

66
on:
77
release:
8-
types: [created]
8+
types: [ created ]
99

1010
jobs:
1111
build:
@@ -16,19 +16,19 @@ jobs:
1616
packages: write
1717

1818
steps:
19-
- uses: actions/checkout@v4
20-
- name: Set up JDK 8
21-
uses: actions/setup-java@v3
22-
with:
23-
java-version: '8'
24-
distribution: 'temurin'
25-
server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
26-
settings-path: ${{ github.workspace }} # location for the settings.xml file
19+
- uses: actions/checkout@v4
20+
- name: Set up JDK 8
21+
uses: actions/setup-java@v3
22+
with:
23+
java-version: '8'
24+
distribution: 'temurin'
25+
server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
26+
settings-path: ${{ github.workspace }} # location for the settings.xml file
2727

28-
- name: Build with Maven
29-
run: mvn -B package --file pom.xml
28+
- name: Build with Maven
29+
run: mvn -B package --file pom.xml
3030

31-
- name: Publish to GitHub Packages Apache Maven
32-
run: mvn deploy -s $GITHUB_WORKSPACE/settings.xml
33-
env:
34-
GITHUB_TOKEN: ${{ github.token }}
31+
- name: Publish to GitHub Packages Apache Maven
32+
run: mvn deploy -s $GITHUB_WORKSPACE/settings.xml
33+
env:
34+
GITHUB_TOKEN: ${{ github.token }}

.idea/sonarlint/issuestore/0/8/0834ae016f8fea5cff771880c0be1d55299732ff

Whitespace-only changes.

.idea/sonarlint/issuestore/3/f/3f454a98e586d1aa0d322e19afd5e67e08f2d3c8

Whitespace-only changes.

.idea/sonarlint/issuestore/7/c/7c875fef54268bc433a7fc46aa5fd6e96d58f32f

Whitespace-only changes.

.idea/sonarlint/issuestore/index.pb

+7-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/sonarlint/securityhotspotstore/0/8/0834ae016f8fea5cff771880c0be1d55299732ff

Whitespace-only changes.

.idea/sonarlint/securityhotspotstore/3/f/3f454a98e586d1aa0d322e19afd5e67e08f2d3c8

Whitespace-only changes.

.idea/sonarlint/securityhotspotstore/7/c/7c875fef54268bc433a7fc46aa5fd6e96d58f32f

Whitespace-only changes.

.idea/sonarlint/securityhotspotstore/index.pb

+7-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/workspace.xml

+47-33
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

CODE_OF_CONDUCT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
106106
### 4. Permanent Ban
107107

108108
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
109+
standards, including sustained inappropriate behavior, harassment of an
110110
individual, or aggression toward or disparagement of classes of individuals.
111111

112112
**Consequence**: A permanent ban from any sort of public interaction within

CONTRIBUTING.md

+17-15
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,29 @@
11
# multiform-validator - Contribution Guide
22

3-
The multiform-validator is a powerful Multilanguage library for validating form fields in multiple languages. This guide describes the guidelines for contributing to the project efficiently and effectively.
3+
The multiform-validator is a powerful Multilanguage library for validating form fields in multiple languages. This guide
4+
describes the guidelines for contributing to the project efficiently and effectively.
45

56
## How to Contribute
67

78
1. **Fork the Repository**
8-
- Fork the multiform-validator repository to your GitHub account.
9+
- Fork the multiform-validator repository to your GitHub account.
910

1011
2. **Clone the Repository**
11-
- Clone the forked repository to your local environment:
12-
```
13-
git clone https://github.com/gabriel-logan/multiform-validator.git
14-
```
15-
12+
- Clone the forked repository to your local environment:
13+
```
14+
git clone https://github.com/gabriel-logan/multiform-validator.git
15+
```
16+
1617
4. **Commit and Push**
17-
- Commit your changes and push them to the forked repository:
18-
```
19-
git add .
20-
git commit -m "Concise description of the changes"
21-
git push origin my-feature
22-
```
18+
- Commit your changes and push them to the forked repository:
19+
```
20+
git add .
21+
git commit -m "Concise description of the changes"
22+
git push origin my-feature
23+
```
2324
2425
5. **Open a Pull Request (PR)**
25-
- Go to the forked repository on GitHub and open a PR to the main branch of the project.
26+
- Go to the forked repository on GitHub and open a PR to the main branch of the project.
2627
2728
## Contribution Guidelines
2829
@@ -65,4 +66,5 @@ ci: Configure CI pipeline to automatically test the controller
6566
6667
## License
6768
68-
By contributing to multiform-validator, you agree that your contributions will be licensed under the MIT license. Make sure you're familiar with the terms of this license.
69+
By contributing to multiform-validator, you agree that your contributions will be licensed under the MIT license. Make
70+
sure you're familiar with the terms of this license.

SECURITY.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,17 @@
44

55
If you find a vulnerability in the project, please follow these steps to report it:
66

7-
1. **Report Submission**: Send a detailed email to [[email protected]] with information about the vulnerability.
8-
2. **Required Information**: Include in the report details such as a description of the vulnerability, steps to reproduce it, the potential impact, and any suggested fixes.
7+
1. **Report Submission**: Send a detailed email to [[email protected]] with information about the
8+
vulnerability.
9+
2. **Required Information**: Include in the report details such as a description of the vulnerability, steps to
10+
reproduce it, the potential impact, and any suggested fixes.
911
3. **Initial Response**: You can expect an initial response within 72 hours of submitting the report.
10-
4. **Review Process**: The vulnerability will be reviewed by our team. During this period, we may request additional information.
11-
5. **Updates**: We will provide regular updates on the status of the review and the action plan to resolve the vulnerability.
12-
6. **Disclosure**: If the vulnerability is confirmed, we will work on a fix and release a security update along with a vulnerability disclosure note.
12+
4. **Review Process**: The vulnerability will be reviewed by our team. During this period, we may request additional
13+
information.
14+
5. **Updates**: We will provide regular updates on the status of the review and the action plan to resolve the
15+
vulnerability.
16+
6. **Disclosure**: If the vulnerability is confirmed, we will work on a fix and release a security update along with a
17+
vulnerability disclosure note.
1318

1419
We appreciate your help in keeping the project safe and secure.
1520

docs/classes/CnpjValidator.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ public class Main {
1515
System.out.println(cnpjIsTrue()); // true
1616
System.out.println(cnpjIsFalse()); // false
1717
}
18-
18+
1919
public static boolean cnpjIsTrue() {
2020
String cnpjTrue = "69.807.668/0001-41";
2121
return CnpjValidator.cnpjIsValid(cnpjTrue);
2222
}
23-
23+
2424
public static boolean cnpjIsFalse() {
2525
String cnpjFalse = "61.807.661/0001-48";
2626
return CnpjValidator.cnpjIsValid(cnpjFalse);

docs/classes/FileValidator.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ public class Main {
3232
public static void main(String[] args) {
3333
File file = new File("src/main/resources/audio.mp3");
3434
System.out.println(isValidAudio(file)); // true | false
35-
35+
3636
exampleExcludingExtensions();
3737
}
38-
38+
3939
public static void exampleExcludingExtensions() {
4040
File file = new File("src/main/resources/audio.mp3");
4141
String[] audioExtensions = {"mp3"};
@@ -55,17 +55,17 @@ public class Main {
5555
public static void main(String[] args) {
5656
File file = new File("src/main/resources/image.png");
5757
System.out.println(isValidImage(file)); // true | false
58-
58+
5959
exampleExcludingExtensions();
6060
example2ExcludingExtensions();
6161
}
62-
62+
6363
public static void exampleExcludingExtensions() {
6464
File file = new File("src/main/resources/image.png");
6565
String[] imageExtensions = {"ico", "jpeg", "png"};
6666
System.out.println(isValidImage(file, imageExtensions)); // false
6767
}
68-
68+
6969
public static void example2ExcludingExtensions() {
7070
File file = new File("src/main/resources/image.png");
7171
String[] imageExtensions = {"ico", "jpeg"};

src/main/java/io/github/multiform_validator/CnpjValidator.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ private static int calculateFirstVerifier(int[] cnpjBase) {
2929
/**
3030
* Calculate the second verifier digit of a CNPJ
3131
*
32-
* @param cnpjBase an array of integers with the first 12 digits of a CNPJ
32+
* @param cnpjBase an array of integers with the first 12 digits of a CNPJ
3333
* @param firstVerifier the first verifier digit
3434
* @return the second verifier digit
3535
*/

0 commit comments

Comments
 (0)