Skip to content

Commit

Permalink
docs: Fix casing of 'Pomsky', consistently use the name 'Rulex' befor…
Browse files Browse the repository at this point in the history
…e v0.5
  • Loading branch information
Aloso committed Nov 6, 2023
1 parent 0513546 commit 5402c76
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 18 deletions.
20 changes: 10 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Remember that you can also help out by filing issues or contributing 😉

Optimizations are useful when making heavy use of variables to write readable code and still get the most efficient output. More optimizations are planned, stay tuned!

- Group names now must be no longer than 32 characters. For example, `:this_is_a_very_very_very_long_name()` is no longer allowed. The reason is that group names this long are unsupported by PCRE, and we're enforcing the same limit everywhere to make pomsky more consistent across regex flavors.
- Group names now must be no longer than 32 characters. For example, `:this_is_a_very_very_very_long_name()` is no longer allowed. The reason is that group names this long are unsupported by PCRE, and we're enforcing the same limit everywhere to make Pomsky more consistent across regex flavors.

### CLI changes

Expand Down Expand Up @@ -211,7 +211,7 @@ Remember that you can also help out by filing issues or contributing 😉
```

- Improved diagnostics for typos. When you spell a variable, capturing group or character class
wrong, pomsky will suggest the correct spelling:
wrong, Pomsky will suggest the correct spelling:

```
$ pomsky '[Alpabetic]'
Expand All @@ -226,7 +226,7 @@ Remember that you can also help out by filing issues or contributing 😉
```

- Many regex syntax diagnostics were added. Pomsky now recognizes most regex syntax and suggests
the equivalent pomsky syntax. For example:
the equivalent Pomsky syntax. For example:

```
$ pomsky '(?<grp> "test")'
Expand All @@ -246,7 +246,7 @@ Remember that you can also help out by filing issues or contributing 😉
parentheses: `('a'{2})+`

The reason is that this syntax is used by regular expressions for possessive quantifiers.
Forbidding this syntax in pomsky allows for better diagnostics.
Forbidding this syntax in Pomsky allows for better diagnostics.

- Deprecated `[.]`, `[codepoint]` and `[cp]`. They should have been deprecated before, but the
warnings were missed in the previous release.
Expand Down Expand Up @@ -363,8 +363,8 @@ The repository was moved to its own organization! 🎉 It also has a new website
- API to selectively disable some language features
- [Online playground](https://playground.pomsky-lang.org/) to try out Pomsky. You can write
pomsky expressions on the left and immediately see the output on the right.
- [Online playground](https://playground.pomsky-lang.org/) to try out Rulex. You can write
Rulex expressions on the left and immediately see the output on the right.
### Changed
Expand Down Expand Up @@ -417,9 +417,9 @@ The repository was moved to its own organization! 🎉 It also has a new website
- Improved Unicode support
- In addition to Unicode general categories and scripts, pomsky now supports blocks and other
- In addition to Unicode general categories and scripts, Rulex now supports blocks and other
boolean properties
- Pomsky now validates properties and tells you when a property isn't supported by the target
- Rulex now validates properties and tells you when a property isn't supported by the target
regex flavor
- Shorthands (`[h]` and `[v]`) are substituted with character classes when required to support
Unicode everywhere
Expand All @@ -445,7 +445,7 @@ The repository was moved to its own organization! 🎉 It also has a new website
### Changed
- Improved the Rust macro; pomsky expressions are written directly in the Rust source code, not in a
- Improved the Rust macro; Rulex expressions are written directly in the Rust source code, not in a
string literal:
```rs
let regex: &str = rulex!("hello" | "world" '!'+);
Expand All @@ -454,7 +454,7 @@ The repository was moved to its own organization! 🎉 It also has a new website
- Strings with more than 1 code point must be enclosed in double quotes, single quotes don't work
- Strings can't contain backslashes; this will be fixed in a future release
- Code points must be written without the `+`, e.g. `U10FFFF` instead of `U+10FFFF`
- Pomsky expressions can contain Rust comments; they can't contain comments starting with `#`
- Rulex expressions can contain Rust comments; they can't contain comments starting with `#`
## [0.1.0] - 2022-03-11
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to Pomsky

There are multiple ways to contribute to pomsky. The easiest way is to use Pomsky and report any bugs or issues you find in the [issue tracker](https://github.com/pomsky-lang/pomsky/issues) or propose new features. If you'd like to contribute code, please read on. You can also [sponsor me](https://github.com/sponsors/Aloso) to support Pomsky's development.
There are multiple ways to contribute to Pomsky. The easiest way is to use Pomsky and report any bugs or issues you find in the [issue tracker](https://github.com/pomsky-lang/pomsky/issues) or propose new features. If you'd like to contribute code, please read on. You can also [sponsor me](https://github.com/sponsors/Aloso) to support Pomsky's development.

## Conduct

Expand Down Expand Up @@ -82,7 +82,7 @@ You can optionally set the flavor with `#! flavor=FLAVOR`, for example:
foobar
```

You don't have to type all of this yourself, only the pomsky expression. Then run the integration test with the `--bless` flag to generate the rest: `just test-it --bless`, or `cargo test --test it --all-features -- --bless`.
You don't have to type all of this yourself, only the Pomsky expression. Then run the integration test with the `--bless` flag to generate the rest: `just test-it --bless`, or `cargo test --test it --all-features -- --bless`.

Test cases can also check if an input produces a certain error, using `#! expect=error`. Error test cases can also be generated with `--bless`.

Expand Down
12 changes: 6 additions & 6 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@ set positional-arguments

coverage_flags := '-Zprofile -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Cpanic=abort -Zpanic_abort_tests'

# run pomsky (debug mode)
# run Pomsky (debug mode)
run S *args:
cargo run -- "$@"

# install pomsky
# install Pomsky
install:
cargo install --path=pomsky-bin

# benchmark pomsky
# benchmark Pomsky
bench *flags:
cargo bench -p benchmark -- {{flags}}

# benchmark pomsky with the plotters backend
# benchmark Pomsky with the plotters backend
bench-plotters *flags:
cargo bench -p benchmark -- --plotting-backend plotters {{flags}}

Expand All @@ -24,14 +24,14 @@ coverage:
zip -0 cov.zip $(find . -name "pomsky*.gc*" -print)
grcov cov.zip -s . -t lcov --llvm --ignore-not-existing --ignore "/*" -o lcov.info

# test pomsky
# test Pomsky
test *args:
cargo test "$@"

test-it *args:
cargo test --test it --all-features -- "$@"

# fuzz pomsky ranges
# fuzz Pomsky ranges
fuzz-ranges *flags:
cargo test --test it -- --fuzz-ranges {{flags}}

Expand Down

0 comments on commit 5402c76

Please sign in to comment.