Skip to content

Commit 475bb7f

Browse files
committed
Configure Spotless formatting, fix Javadoc links, and modernize README
- Add spotless-maven-plugin to pom.xml configured for 2-space indentation, trailing whitespace trimming, and newline termination. - Bind spotless:check to verify phase and format all source files with spotless:apply. - Fix all Javadoc reference warnings in Parser, Functions, and CharacterRepeaterRule. - Modernize README.md links (HTTPS, main branch) and fix typo. - Add Code Formatting & Spotless instructions to AGENTS.md.
1 parent 5fd2652 commit 475bb7f

17 files changed

Lines changed: 66 additions & 21 deletions

File tree

‎AGENTS.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,3 +160,21 @@ Execute the Maven wrapper from the repository root:
160160
```bash
161161
./mvnw clean test
162162
```
163+
164+
---
165+
166+
## Code Formatting & Spotless
167+
168+
Execute Spotless through the Maven wrapper:
169+
170+
- Apply formatting across all source and test files:
171+
172+
```bash
173+
./mvnw spotless:apply
174+
```
175+
176+
- Verify formatting without modifying files (also run automatically during `verify` and CI):
177+
178+
```bash
179+
./mvnw spotless:check
180+
```

‎README.md‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,20 @@
55
[![GitHub Issues](https://img.shields.io/github/issues/petitparser/java-petitparser.svg)](https://github.com/petitparser/java-petitparser/issues)
66
[![GitHub Forks](https://img.shields.io/github/forks/petitparser/java-petitparser.svg)](https://github.com/petitparser/java-petitparser/network)
77
[![GitHub Stars](https://img.shields.io/github/stars/petitparser/java-petitparser.svg)](https://github.com/petitparser/java-petitparser/stargazers)
8-
[![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/petitparser/java-petitparser/master/LICENSE)
8+
[![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/petitparser/java-petitparser/main/LICENSE)
99

1010
Grammars for programming languages are traditionally specified statically. They
1111
are hard to compose and reuse due to ambiguities that inevitably arise.
12-
PetitParser combines ideas
13-
from [scannnerless parsing](https://en.wikipedia.org/wiki/Scannerless_parsing)
14-
, [parser combinators](https://en.wikipedia.org/wiki/Parser_combinator)
15-
, [parsing expression grammars](https://en.wikipedia.org/wiki/Parsing_expression_grammar) (
16-
PEG) and packrat parsers to model grammars and parsers as objects that can be
12+
PetitParser combines ideas from [scannerless parsing](https://en.wikipedia.org/wiki/Scannerless_parsing),
13+
[parser combinators](https://en.wikipedia.org/wiki/Parser_combinator),
14+
[parsing expression grammars](https://en.wikipedia.org/wiki/Parsing_expression_grammar) (PEG),
15+
and packrat parsers to model grammars and parsers as objects that can be
1716
reconfigured dynamically.
1817

19-
This library is open source, stable and well tested. Development happens
18+
This library is open source, stable, and well tested. Development happens
2019
on [GitHub](https://github.com/petitparser/java-petitparser). Feel free to
2120
report issues or create a pull-request there. General questions are best asked
22-
on [StackOverflow](http://stackoverflow.com/questions/tagged/petitparser+java).
21+
on [StackOverflow](https://stackoverflow.com/questions/tagged/petitparser+java).
2322

2423
## Installation
2524

@@ -67,7 +66,6 @@ Alternatively, if you'd like the latest code clone the repository:
6766
```bash
6867
git clone https://github.com/petitparser/java-petitparser.git
6968
cd java-petitparser
70-
git checkout master
7169
```
7270

7371
Then build with [Bazel](http://bazel.io/):
@@ -405,4 +403,4 @@ implementations adopt best practises of the target language.
405403

406404
### License
407405

408-
The MIT License, see [LICENSE](https://raw.githubusercontent.com/petitparser/java-petitparser/master/LICENSE).
406+
The MIT License, see [LICENSE](https://raw.githubusercontent.com/petitparser/java-petitparser/main/LICENSE).

‎petitparser-core/src/main/java/module-info.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@
1111
exports org.petitparser.utils.linter;
1212
exports org.petitparser.utils.optimizer;
1313
exports org.petitparser.utils.tuples;
14-
}
14+
}

‎petitparser-core/src/main/java/org/petitparser/parser/Parser.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import org.petitparser.context.Context;
44
import org.petitparser.context.Result;
5+
import org.petitparser.context.Token;
56
import org.petitparser.parser.actions.ActionParser;
67
import org.petitparser.parser.actions.CastListParser;
78
import org.petitparser.parser.actions.CastParser;

‎petitparser-core/src/main/java/org/petitparser/parser/actions/PermuteParser.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ private Object permuteList(List<?> list, int size) {
5555
return result;
5656
}
5757
}
58-
58+
5959
@Override
6060
public int fastParseOn(String buffer, int position) {
6161
return delegate.fastParseOn(buffer, position);

‎petitparser-core/src/main/java/org/petitparser/parser/repeating/GreedyRepeatingParser.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,4 +101,3 @@ public GreedyRepeatingParser copy() {
101101
return new GreedyRepeatingParser(delegate, limit, min, max);
102102
}
103103
}
104-

‎petitparser-core/src/main/java/org/petitparser/tools/GrammarDefinition.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,4 +233,4 @@ public int hashCode() {
233233
return name.hashCode();
234234
}
235235
}
236-
}
236+
}

‎petitparser-core/src/main/java/org/petitparser/tools/GrammarParser.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ public GrammarParser(GrammarDefinition definition, Production<?> production) {
2323
public int fastParseOn(String buffer, int position) {
2424
return delegate.fastParseOn(buffer, position);
2525
}
26-
}
26+
}

‎petitparser-core/src/main/java/org/petitparser/utils/Functions.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
package org.petitparser.utils;
22

3+
import org.petitparser.parser.Parser;
4+
35
import java.util.ArrayList;
46
import java.util.List;
57
import java.util.function.Function;

‎petitparser-core/src/main/java/org/petitparser/utils/optimizer/CharacterRepeaterRule.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
import org.petitparser.parser.combinators.SettableParser;
77
import org.petitparser.parser.primitive.CharacterParser;
88
import org.petitparser.parser.repeating.PossessiveRepeatingParser;
9+
import org.petitparser.parser.repeating.RepeatingCharacterParser;
910

1011
import java.util.HashSet;
1112
import java.util.Set;

0 commit comments

Comments
 (0)