Skip to content

Commit 9b2795b

Browse files
jpikljpikl
committed
Replace docpress by hatcher
1 parent 50863ad commit 9b2795b

24 files changed

+356
-350
lines changed

‎.github/workflows/docs.yml ‎.github/workflows/pages.yml

+6-9
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
name: Deploy docs
1+
name: Deploy pages
22

33
on:
44
push:
55
branches: [ stable-docs ]
6-
paths: [ 'docs/**' ]
6+
paths: [ 'docs/**', 'CHANGELOG.md' , 'LICENSE.md' ]
77

88
jobs:
99
deploy:
@@ -15,15 +15,12 @@ jobs:
1515
with:
1616
persist-credentials: false
1717

18-
- name: Setup Node.js
19-
uses: actions/setup-node@v1
18+
- name: Generate pages
19+
uses: jpikl/hatcher@v0.1
2020

21-
- name: Generate docs
22-
run: npx docpress build
23-
24-
- name: Deploy docs
21+
- name: Deploy pages
2522
uses: peaceiris/actions-gh-pages@v3
2623
with:
2724
github_token: ${{ secrets.GITHUB_TOKEN }}
28-
publish_dir: ./_docpress
25+
publish_dir: ./pages
2926
force_orphan: true

‎.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
/_docpress
21
/.idea
2+
/pages
33
/target

‎.hatcherfiles

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
index.md
2+
install.md
3+
usage.md
4+
pattern.md
5+
filters/index.md
6+
filters/path.md
7+
filters/substr.md
8+
filters/field.md
9+
filters/replace.md
10+
filters/regex.md
11+
filters/format.md
12+
filters/generate.md
13+
input.md
14+
output.md
15+
compare.md|🔬 Comparison
16+
examples.md
17+
../CHANGELOG.md|📈 Changelog
18+
../LICENSE.md|📃 License

‎.hatcherrc

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
export OUTPUT_STANDALONE=true
2+
export OUTPUT_PDF=true
3+
4+
export CSS_RULES="
5+
th:empty,
6+
td:empty {
7+
border-top: none;
8+
border-bottom: none;
9+
background: transparent;
10+
}
11+
12+
@media screen {
13+
html[data-theme=dark] img[src='images/diagram.svg'] {
14+
filter: invert(1);
15+
}
16+
}
17+
"

‎CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Changelog
1+
# 📈 Changelog
22

33
All notable changes to this project will be documented in this file.
44

‎README.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -9,44 +9,44 @@ A text processing CLI tool that rewrites FS paths according to a pattern.
99
[![Downloads](https://img.shields.io/crates/d/rew)](https://crates.io/crates/rew)
1010
[![License](https://img.shields.io/crates/l/rew.svg)](https://github.com/jpikl/rew/blob/master/LICENSE.md)
1111

12-
## What rew does
12+
## How rew works
1313

1414
1. Reads values from standard [input](https://jpikl.github.io/rew/input.html).
1515
2. Rewrites them according to a [pattern](https://jpikl.github.io/rew/pattern.html).
1616
3. Prints results to standard [output](https://jpikl.github.io/rew/output.html).
1717

18-
![What rew does](docs/images/diagram.svg)
18+
![How rew works](docs/images/diagram.svg)
1919

2020
Input values are assumed to be FS paths, however, `rew` is able to process any UTF-8 encoded text.
2121

2222
```bash
2323
find -iname '*.jpeg' | rew 'img_{C}.{e|l|r:e}'
2424
```
2525

26-
Rew is also distributed with two accompanying utilities (`mvb` and `cpb`) which move/copy files and directories, based on `rew` output.
26+
`rew` is also distributed with two accompanying utilities (`mvb` and `cpb`) which move/copy files and directories, based on `rew` output.
2727

2828
```bash
2929
find -iname '*.jpeg' | rew 'img_{C}.{e|l|r:e}' -d | mvb
3030
```
3131

3232
## Documentation
3333

34-
- [📦 Installation](https://jpikl.github.io/rew/installation.html)
35-
- [🚀 Usage](https://jpikl.github.io/rew/usage.html)
36-
- [✏️ Pattern](https://jpikl.github.io/rew/pattern.html)
37-
- [🛤 Path filters](https://jpikl.github.io/rew/filters/path.html)
38-
- [🆎 Substring filters](https://jpikl.github.io/rew/filters/substr.html)
39-
- [📊 Field filters](https://jpikl.github.io/rew/filters/column.html)
40-
- [🔍 Replace filters](https://jpikl.github.io/rew/filters/replace.html)
41-
- [⭐️ Regex filters](https://jpikl.github.io/rew/filters/regex.html)
42-
- [🎨 Format filters](https://jpikl.github.io/rew/filters/format.html)
43-
- [🏭 Generators](https://jpikl.github.io/rew/filters/generators.html)
44-
- [⌨️ Input](https://jpikl.github.io/rew/input.html)
45-
- [💬 Output](https://jpikl.github.io/rew/output.html)
46-
- [🔬 Comparison with similar tools](https://jpikl.github.io/rew/comparison.html)
47-
- [🗃 Examples](https://jpikl.github.io/rew/examples.html)
48-
- [📈 Changelog](CHANGELOG.md)
34+
- [📦 Installation](https://jpikl.github.io/rew/install)
35+
- [🚀 Usage](https://jpikl.github.io/rew/usage)
36+
- [✏️ Pattern](https://jpikl.github.io/rew/pattern)
37+
- [🛤 Path filters](https://jpikl.github.io/rew/filters/path)
38+
- [🆎 Substring filters](https://jpikl.github.io/rew/filters/substr)
39+
- [📊 Field filters](https://jpikl.github.io/rew/filters/field)
40+
- [🔍 Replace filters](https://jpikl.github.io/rew/filters/replace)
41+
- [⭐️ Regex filters](https://jpikl.github.io/rew/filters/regex)
42+
- [🎨 Format filters](https://jpikl.github.io/rew/filters/format)
43+
- [🏭 Generators](https://jpikl.github.io/rew/filters/generate)
44+
- [⌨️ Input](https://jpikl.github.io/rew/input)
45+
- [💬 Output](https://jpikl.github.io/rew/output)
46+
- [🔬 Comparison](https://jpikl.github.io/rew/comparison)
47+
- [🗃 Examples](https://jpikl.github.io/rew/examples)
48+
- [📈 Changelog](https://jpikl.github.io/rew/changelog)
4949

5050
## License
5151

52-
Rew is licensed under the [MIT license](LICENSE.md).
52+
`rew` is licensed under the [MIT license](LICENSE.md).

‎docs/README.md

-19
This file was deleted.

‎docs/about.md

-23
This file was deleted.

‎docs/comparison.md ‎docs/compare.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# 🔬 Comparison with similar tools
1+
# 🔬 Comparison - rew vs others
22

33
## rew vs rename/prename
44

55
- Unlike `rename`, `rew` can read input paths directly from standard input.
66
Use of `xargs` to pass output of `find` or [`fd`][fd] is not needed.
77
- Unlike `rename`, `rew` is only a text-processing tool and it is unable to rename files.
8-
You have to use accompanying `mvb`/`cpb` utilities or you can generate executable shell code.
8+
You have to use accompanying `mvb` / `cpb` utilities or you can generate executable shell code.
99

1010
```bash
1111
find -name '*.jpeg' | xargs rename .jpeg .jpg # Rename *.jpeg files to *.jpg

‎docs/docpress.json

-6
This file was deleted.

‎docs/extra.css

-21
This file was deleted.

‎docs/filters/field.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
| Filter | Description |
44
| ------- | --------------------------------------------------------------- |
5-
| `&N:S` | Split value using separator `S`, output `N`-th field.<br>Field indices `N` start from 1.<br>Use `-N` for backward indexing.<br>Any other character than `:` can be also used as a delimiter.<br>Use of `/` as a delimiter has special meaning (see below). |
5+
| `&N:S` | Split value using separator `S`, output `N`-th field.<br><small>Field indices `N` start from 1.<br>Use `-N` for backward indexing.<br>Any other character than `:` can be also used as a delimiter.<br>Use of `/` as a delimiter has special meaning (see below).</small> |
66
| `&N/S` | Split value using regular expression `S`, output `N`-th field. |
77
| `&N` | Split value using default separator, output `N`-th field. |
88

‎docs/filters/format.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
| `I` | Remove non-ASCII characters. |
1010
| `*N` | Repeat `N` times. |
1111
| `<<M` | Left pad with mask `M`. |
12-
| `<N:M` | Left pad with `N` times repeated mask `M`.<br>Any other character than `:` can be also used as a delimiter. |
12+
| `<N:M` | Left pad with `N` times repeated mask `M`.<br><small>Any other character than `:` can be also used as a delimiter.</small> |
1313
| `>>M` | Right pad with mask `M`. |
14-
| `>N:M` | Right pad with `N` times repeated mask `M`.<br>Any other character than `:` can be also used as a delimiter. |
14+
| `>N:M` | Right pad with `N` times repeated mask `M`.<br><small>Any other character than `:` can be also used as a delimiter.</small> |
1515

1616
Examples:
1717

‎docs/filters/generators.md ‎docs/filters/generate.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ However, it is still possible (although meaningless) to pipe input into a genera
55

66
| Filter | Description |
77
| ------ | -------------------------------------- |
8-
| `*N:V` | Repeat `N` times `V`.<br>Any other character than `:` can be also used as a delimiter. |
8+
| `*N:V` | Repeat `N` times `V`.<br><small>Any other character than `:` can be also used as a delimiter.</small> |
99
| `c` | Local counter |
1010
| `C` | Global counter |
1111
| `uA-B` | Random 64-bit number (`A` ≤ `u` ≤ `B`) |

‎docs/filters/index.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# 🕶 Filters
2+
3+
Filters are categorized into the following groups.
4+
5+
- 🛤 [Path filters](path)
6+
- 🆎 [Substring filters](substr)
7+
- 📊 [Field filters](field)
8+
- 🔍 [Replace filters](replace)
9+
- ⭐️ [Regex filters](regex)
10+
- 🎨 [Format filters](format)
11+
- 🏭 [Generators](generate)

‎docs/filters/regex.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
| Filter | Description |
44
| --------------------- | --------------------------------------------- |
55
| `=E` | Match of a regular expression `E`. |
6-
| `s:X:Y` | Replace first match of a regular expression `X` with `Y`.<br>`Y` can reference capture groups from `X` using `$0`, `$1`, `$2`, ...<br>Any other character than `:` can be also used as a delimiter. |
7-
| `s:X` | Remove first match of a regular expression `X`.<br>Equivalent to `s:X:`. |
6+
| `s:X:Y` | Replace first match of a regular expression `X` with `Y`.<br><small>`Y` can reference capture groups from `X` using `$0`, `$1`, `$2`, ...<br>Any other character than `:` can be also used as a delimiter.</small> |
7+
| `s:X` | Remove first match of a regular expression `X`.<br><small>Equivalent to `s:X:`.</small> |
88
| `S:X:Y`<br>`S:X` | Same as `s` but replaces/removes all matches. |
9-
| `@:X1:Y1:...:Xn:Yn:D` | Regular expression switch.<br>Output `Yi` for first `Xi` that matches input.<br>Output `D` when there is no match.<br>`Yi` can reference capture groups from `Xi` using `$0`, `$1`, `$2`, ...<br>Any other character than `:` can be also used as a delimiter.
9+
| `@:X1:Y1:...:Xn:Yn:D` | Regular expression switch.<br><small>Output `Yi` for first `Xi` that matches input.<br>Output `D` when there is no match.<br>`Yi` can reference capture groups from `Xi` using `$0`, `$1`, `$2`, ...<br>Any other character than `:` can be also used as a delimiter.</small>
1010
| `$0`, `$1`, `$2`, ... | Capture group of a global regular expression. |
1111

1212
Examples:

‎docs/filters/replace.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
| Filter | Description |
44
| ---------------- | ------------------------------------------------------- |
5-
| `r:X:Y` | Replace first occurrence of `X` with `Y`.<br>Any other character than `:` can be also used as a delimiter. |
6-
| `r:X` | Remove first occurrence of `X`.<br>Equivalent to `r:X:` |
5+
| `r:X:Y` | Replace first occurrence of `X` with `Y`.<br><small>Any other character than `:` can be also used as a delimiter.</small> |
6+
| `r:X` | Remove first occurrence of `X`.<br><small>Equivalent to `r:X:`.</small> |
77
| `R:X:Y`<br>`R:X` | Same as `r` but replaces/removes all occurrences. |
88
| `?D` | Replace empty value with `D`. |
99

‎docs/filters/substr.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
| Filter | Description |
44
| ------- | ------------------------------------------------- |
5-
| `#A-B` | Substring from index `A` to `B`.<br>Indices `A`, `B` start from 1 and are both inclusive.<br>Use `-A` for backward indexing. |
5+
| `#A-B` | Substring from index `A` to `B`.<br><small>Indices `A`, `B` start from 1 and are both inclusive.<br>Use `-A` for backward indexing.</small> |
66
| `#A+L` | Substring from index `A` of length `L`. |
77
| `#A-` | Substring from index `A` to end. |
8-
| `#A` | Character at index `A`.<br>Equivalent to `#A-A`. |
8+
| `#A` | Character at index `A`.<br><small>Equivalent to `#A-A`.</small> |
99

1010
Examples:
1111

0 commit comments

Comments
 (0)