https://github.com/hernancerm/scripts.public
My general-purpose scripts.
https://github.com/hernancerm/scripts.public
Last synced: 10 months ago
JSON representation
My general-purpose scripts.
- Host: GitHub
- URL: https://github.com/hernancerm/scripts.public
- Owner: hernancerm
- License: other
- Created: 2021-12-12T03:29:28.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-21T22:05:18.000Z (over 1 year ago)
- Last Synced: 2025-03-14T20:52:58.222Z (over 1 year ago)
- Language: Shell
- Homepage:
- Size: 57.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# scripts.public
General-purpose scripts.
## Development standards
### Filenames
```text
spub-{category}-{description}
```
e.g. `spub-os-find-word`
### Documentation
Scripts must have these comments at the top of the file, only preceded by a shebang, if any.
```text
# Description:
# -----------
# (Explain the purpose of the script, e.g.:
# Given a single file, find all it's lines which contain a given word.)
#
# Parameters:
# ----------
# (Explain the script's intended usage of each parameter, e.g.:
# $1: Filename.
# $2: Word to find in the provided file.)
```
Scripts may have these comments directly after the mandatory documentation comments.
```text
# Examples:
# --------
# (Provide one or more examlpes, e.g.:
# Find the word `hello` in the file `foo.txt`:
# ```
# $ spub-os-find-word hello './foo.txt'
# Line 23: And he said: "hello, stranger".
# ```).
#
# Internal notes:
# --------------
# (Provide information about implementation details, e.g.:
# All pattern searches are done using grep, for convenience.
```