Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carlocorradini/inline
Inline script sources
https://github.com/carlocorradini/inline
automation bash inline posix-sh script source
Last synced: 15 days ago
JSON representation
Inline script sources
- Host: GitHub
- URL: https://github.com/carlocorradini/inline
- Owner: carlocorradini
- License: mit
- Created: 2022-11-19T19:03:29.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T20:36:37.000Z (7 months ago)
- Last Synced: 2024-05-02T03:02:19.521Z (7 months ago)
- Topics: automation, bash, inline, posix-sh, script, source
- Language: Shell
- Homepage:
- Size: 536 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# [Inline](./inline.sh) script sources
[](https://github.com/carlocorradini/inline/actions/workflows/ci.yml)
[](https://github.com/semantic-release/semantic-release)
Inline script sources (`source` or `.`).
It is convenient to be able to divide long scripts into many files to make them easier to work with while maintaining the ability to distribute them as a single script.
Inspired by [@joehillen](https://github.com/joehillen) [GitHub Gist](https://gist.github.com/joehillen/30f08738c1c3c0ca3e4c754ad33ad2ff)
## Features
- `POSIX` compliant
- Sourcing with quotes, spaces and more
- Sourcing from `$PATH`
- Sourcing from [ShellCheck](https://github.com/koalaman/shellcheck) source: `# shellcheck source=path/to/script.sh`
> **Warning**: Available only if `source` or `.` is invalid
```sh
# shellcheck source=path/to/script.sh
. "$DIR/path/to/script.sh"
```
- Sources in sources
- Recursion detection
- Shebang (`#!`) removal in sources
- Skip source: `# inline skip`
> **Note**: Works with [ShellCheck](https://github.com/koalaman/shellcheck) as well
```sh
# inline skip
# shellcheck source=path/to/script.sh
. path/to/script.sh
```
- Configurable \
See [Options](#options)
## Download
```sh
wget https://raw.githubusercontent.com/carlocorradini/inline/main/inline.sh
```
## Usage
> **Warning**: Script must have _execute_ permission: `chmod u+x ./inline.sh`
> **Note**: See [Options](#options) for more configuration
> **Note**: Type `--help` for more information
Pass the script to be aligned with `--in-file path/to/script.sh` \
It creates a script called `script.aligned.sh` \
The resulting script is automatically _aligned_: all sources (`source` or `.`) are directly included.
### Examples
1. Inline script `hello.sh` and save it as `world.sh`
```sh
./inline.sh --in-file hello.sh --out-file world.sh
```
1. Inline script `hello_world.sh` and overwrite it
```sh
./inline.sh --in-file hello_world.sh --overwrite
```
## Options
| **Name** | **Description** | **Default** | **Values** |
| --------------------- | -------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `--disable-color` | Disable color | `false` |
| `--help` | Show help message and exit |
| `--in-file ` | Input file | | Any valid file |
| `--log-level ` | Logger level | `info` | `fatal` Fatal level
`warn` Warning level
`info` Informational level
`debug` Debug level
`silent` Silent level |
| `--out-file ` | Output file | `[IN_FILE_NAME].inlined[IN_FILE_EXTENSION]` | Any valid file |
| `--overwrite` | Overwrite input file | `false` |
## Contributing
I would love to see your contribution :heart:
See [CONTRIBUTING](./CONTRIBUTING.md) guidelines.
## License
This project is licensed under the [MIT](https://opensource.org/licenses/MIT) License. \
See [LICENSE](./LICENSE) file for details.