🔥 Change all shell scripts to perl

Add eval-bash
Update CI
Remove shfmt in github workflow
Add cache-dependency-path in github workflow
Fix templates/class.txt
Update README.md

Author: Freed-Wu

.github/workflows/main.yml

@@ -31,16 +31,9 @@ jobs:
         with:
           python-version: ${{ env.python-version }}
           cache: ${{ env.cache }}
-      - name: Install dependencies for macOS
-        if: runner.os == 'macOS'
-        run: |
-          brew update
-          brew install shellcheck shfmt
-      - name: Install dependencies for Linux
-        if: runner.os == 'Linux'
-        run: |
-          sudo apt update
-          sudo apt install shfmt
+          cache-dependency-path: |-
+            requirements.txt
+            requirements/dev.txt
       - name: Install dependencies
         run: |
           pip install -e '.[dev]'
@@ -68,6 +61,9 @@ jobs:
         with:
           python-version: ${{ env.python-version }}
           cache: ${{ env.cache }}
+          cache-dependency-path: |-
+            requirements.txt
+            requirements/dev.txt
       - name: Install dependencies
         run: |
           pip install build

.pre-commit-config.yaml

@@ -1,7 +1,8 @@
+#!/usr/bin/env -S pre-commit run -ac
 ---
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.4.0
     hooks:
       - id: check-added-large-files
       - id: fix-byte-order-marker
@@ -11,6 +12,7 @@ repos:
       - id: trailing-whitespace
       - id: mixed-line-ending
       - id: end-of-file-fixer
+        exclude: ^templates/class\.txt$
       - id: detect-private-key
       - id: check-symlinks
       - id: check-ast
@@ -31,21 +33,19 @@ repos:
         additional_dependencies:
           - tomli
   - repo: https://github.com/jorisroovers/gitlint
-    rev: v0.17.0
+    rev: v0.18.0
     hooks:
       - id: gitlint
         args:
           - --msg-filename
   - repo: https://github.com/editorconfig-checker/editorconfig-checker.python
-    rev: 2.6.1
+    rev: 2.6.2
     hooks:
       - id: editorconfig-checker
   - repo: https://github.com/jumanjihouse/pre-commit-hooks
     rev: 3.0.0
     hooks:
       - id: check-mailmap
-      - id: shellcheck
-      - id: shfmt
   - repo: https://github.com/adrienverge/yamllint
     rev: v1.28.0
     hooks:
@@ -57,28 +57,24 @@ repos:
         args:
           - --number
         additional_dependencies:
-          - mdformat-gfm
           - mdformat-myst
-          - mdformat-tables
           - mdformat-toc
-          - mdformat-footnote
-          - mdformat-frontmatter
           - mdformat-deflist
           - mdformat-beautysh
           - mdformat-black
           - mdformat-config
   - repo: https://github.com/DavidAnson/markdownlint-cli2
-    rev: v0.5.1
+    rev: v0.6.0
     hooks:
       - id: markdownlint-cli2
         additional_dependencies:
           - markdown-it-texmath@0.9.1
   - repo: https://github.com/psf/black
-    rev: 22.10.0
+    rev: 22.12.0
     hooks:
       - id: black
   - repo: https://github.com/PyCQA/isort
-    rev: 5.10.1
+    rev: 5.11.4
     hooks:
       - id: isort
   - repo: https://github.com/pycqa/pydocstyle
@@ -88,7 +84,7 @@ repos:
         additional_dependencies:
           - toml
   - repo: https://github.com/kumaraditya303/mirrors-pyright
-    rev: v1.1.278
+    rev: v1.1.286
     hooks:
       - id: pyright
   - repo: https://github.com/PyCQA/bandit
@@ -102,6 +98,4 @@ repos:
 
 ci:
   skip:
-    - shellcheck
-    - shfmt
     - pyright

README.md

@@ -89,11 +89,28 @@ Result:
 My OS is linux-gnu.
 ```
 
+**NOTE:** the current working directory depends on you. That is, if you run
+`cd docs && sphinx-build . _build/html && cd -`, CWD will be `docs`, which is
+the default setting of <https://readthedocs.org>. So if your code structure is
+like
+
+```console
+$ tree --level 1
+ .
+├──  docs
+├──  scripts
+├──  src
+└──  tests
+```
+
+And you want to run `scripts/*.sh`, you need `cd ..` firstly from `docs` to
+`.` else you have to run `../scripts/*.sh`.
+
 ### Advanced Usages
 
 All of the following examples are myst. The corresponding examples of rst are
-similar. Remember to add `scripts` to your `$PATH` in `docs/conf.py`.
-Click the hyperlink of title to see the actual example.
+similar. Click the hyperlinks of the titles and scripts to see the actual
+examples.
 
 #### [Generate API Document](https://github.com/Freed-Wu/translate-shell/tree/main/docs/api/translate_shell.md)
 
@@ -118,28 +135,21 @@ Now
 
 ````{eval-rst}
 ```{eval-sh}
-generate-api.md.sh '' -maxdepth 1
+cd ..
+scripts/generate-api.md.pl src/*/*.py
 ```
 ````
 `````
 
-Where `scripts/generate-api.md.sh` is a script which search all python file and
-replace them from `src/translate_shell/XXX.py` to
+Where
+[`scripts/generate-api.md.pl`](https://github.com/Freed-Wu/translate-shell/blob/main/scripts/generate-api.md.pl)
+replaces all `src/translate_shell/XXX.py` to
 
 ```rst
 .. automodule:: translate_shell.XXX
     :members:
 ```
 
-```bash
-#!/usr/bin/env bash
-# shellcheck disable=SC2086
-cd "$(dirname "$(dirname "$0")")" || exit 1
-find src/translate_shell/$1 $2 $3 -name '*.py' |
-perl -pe's=src/=.. automodule:: =g;
-s=\.py$=\n    :members:=g;s=/__init__==g;s=/=.=g'
-```
-
 #### [Generate TODO Document](https://github.com/Freed-Wu/translate-shell/tree/main/docs/misc/todo.md)
 
 Before:
@@ -156,26 +166,20 @@ Before:
 - ...
 ```
 
-Now:
+Now: (notice `eval-bash` because readthedocs uses dash as their default `$SHELL`)
 
 ````markdown
 # TODO
 
-```{eval-sh}
-generate-todo.md.sh
+```{eval-bash}
+cd ..
+scripts/generate-todo.md.pl src/**/*
 ```
 ````
 
-Where `scripts/generate-todo.md.sh` searches all `TODO`s in code then convert
-them to correct hyperlinks.
-
-```sh
-#!/usr/bin/env bash
-cd "$(dirname "$(dirname "$0")")" || exit 1
-grep -RIn TODO: src | perl -pe's/:/#L/;s/:\s*#?\s*TODO:\s*/  /;
-s=^=- https://github.com/Freed-Wu/tranlate-shell/tree/main/=g;
-s=(https://\S+)=<\1>=g;s=^(- \S+)=\1\n=g'
-```
+Where
+[`scripts/generate-todo.md.pl`](https://github.com/Freed-Wu/translate-shell/blob/main/scripts/generate-todo.md.pl)
+searches all `TODO`s in code then convert them to correct hyperlinks.
 
 #### [Generate Requirements Document](https://github.com/Freed-Wu/translate-shell/tree/main/docs/resources/requirements.md)
 
@@ -199,23 +203,14 @@ Now
 # Requirements
 
 ```{eval-sh}
-generate-requirements.md.sh
+cd ..
+generate-requirements.md.pl
 ```
 ````
 
-Where `scripts/generate-requirements.md.sh` searches all `requirements/*.txt`s:
-
-```bash
-#!/usr/bin/env bash
-cd "$(dirname "$(dirname "$0")")" || exit 1
-for file in requirements/*.txt ; do
-    filename="${file##*/}"
-    perl -pe's=^([^#\n]\S*)=- [\1](https://pypi.org/project/\1)=g;
-    s/^#\s*//g;s/^!.*/## '"${filename%%.txt}"'/g' < "$file"
-done
-```
-
-And `requirements/completion.txt` is:
+Where
+[`scripts/generate-requirements.md.pl`](https://github.com/Freed-Wu/translate-shell/blob/main/scripts/generate-requirements.md.pl)
+searches all `requirements/*.txt`s and `requirements/completion.txt` is:
 
 ```unixconfig
 #!/usr/bin/env -S pip install -r

docs/api/eval.md

@@ -2,6 +2,7 @@
 
 ````{eval-rst}
 ```{eval-sh}
-generate-api.md.sh
+cd ..
+generate-api.md.pl src/*/*/*.py
 ```
 ````

docs/resources/requirements.md

@@ -1,5 +1,6 @@
 # Requirements
 
 ```{eval-sh}
-generate-requirements.md.sh
+cd ..
+generate-requirements.md.pl requirements/*.txt
 ```

scripts/generate-api.md.pl

@@ -0,0 +1,10 @@
+#!/usr/bin/env -S perl -n
+$. = 1 unless $#ARGV == $oldargc;
+$oldargc = $#ARGV;
+next unless $. == 1;
+$_ = $ARGV;
+s=src/=.. automodule:: =;
+s=\.py$=\n    :members:\n=;
+s=/__init__==;
+s=/=.=g;
+print;

scripts/generate-api.md.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env -S perl -p
+$title = $ARGV;
+$title =~ s=.*?requirements/(.*?)\.txt=$1=;
+s`^([^#\n][^\s>=<^!^]*)`- [$1](https://pypi.org/project/$1)`;
+s/^#\s*//;
+s/^!.*/## $title/;

scripts/generate-requirements.md.pl

@@ -34,6 +34,22 @@ def eval_sh(input: str) -> str:
     return output
 
 
+def eval_bash(input: str) -> str:
+    """Eval bash.
+
+    :param input:
+    :type input: str
+    :rtype: str
+    """
+    try:
+        output = check_output(  # nosec B603 B607
+            ["bash", "-c", input], universal_newlines=True
+        )
+    except Exception:
+        output = ""
+    return output
+
+
 def eval_python(input: str) -> str:
     """Eval python.
 
@@ -52,7 +68,7 @@ def eval_python(input: str) -> str:
     return output
 
 
-EVAL_FUNCS = {"sh": eval_sh, "python": eval_python}
+EVAL_FUNCS = {"sh": eval_sh, "bash": eval_bash, "python": eval_python}
 
 
 def setup(app: Sphinx) -> dict[str, Any]: