Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tj-actions/json2file
Simplifies the process of serializing JSON data to a file.
https://github.com/tj-actions/json2file
actions github-actions json json2json json2text rust
Last synced: 21 days ago
JSON representation
Simplifies the process of serializing JSON data to a file.
- Host: GitHub
- URL: https://github.com/tj-actions/json2file
- Owner: tj-actions
- License: mit
- Created: 2022-11-20T19:33:52.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T12:49:42.000Z (7 months ago)
- Last Synced: 2024-04-14T01:46:21.596Z (7 months ago)
- Topics: actions, github-actions, json, json2json, json2text, rust
- Language: Rust
- Homepage:
- Size: 538 KB
- Stars: 4
- Watchers: 2
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://crates.io/crates/json2file)
[](https://app.codacy.com/gh/tj-actions/json2file/dashboard?utm_source=gh\&utm_medium=referral\&utm_content=\&utm_campaign=Badge_grade)
[](https://codecov.io/gh/tj-actions/json2file)
[](https://github.com/tj-actions/json2file/actions?query=workflow%3ACI)
[](https://github.com/tj-actions/json2file/actions/workflows/sync-release-version.yml)
[](https://github.com/search?o=desc\&q=tj-actions+json2file+language%3AYAML\&s=\&type=Code)
[](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
[](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
[](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
# json2file
Simplifies the process of serializing JSON data to a file.
## Usage
```yaml
...
- name: Set output
id: set-output
run: |
echo "color=green" >> $GITHUB_OUTPUT
- name: Generate file output from json
uses: tj-actions/json2file@v1
with:
directory: 'output'
outputs: ${{ toJSON(steps.set-output.outputs) }}
keys: 'color'
extension: 'txt'
...
```
The above example will create a file named `color.txt` in the `output` directory with the contents `green`.
```bash
$ cat ./output/color.txt
green
```
## Inputs
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|-------------------------------------------------------------------------------------|--------|----------|---------------------|---------------------------------------------------------------|
| [bin\_path](#input_bin_path) | string | false | | Path to the binary |
| [directory](#input_directory) | string | true | `".github/outputs"` | Directory to write to |
| [extension](#input_extension) | string | false | `"txt"` | File extension to use, possible
values: txt, json |
| [keys](#input_keys) | string | true | | List of Keys to read
from the `outputs` JSON string |
| [outputs](#input_outputs) | string | true | | JSON string |
| [skip\_missing\_keys](#input_skip_missing_keys) | string | false | `"false"` | Skip missing keys not found
in the `outputs` JSON string |
## Installation
To install `json2file`, open a terminal window (Command Prompt or PowerShell on Windows) and run the following command:
```shell
cargo install json2file
```
### Building from Source
If you prefer to build from the source, follow these steps:
```shell
git clone https://github.com/tj-actions/json2file
cd json2file
cargo build --release
```
## CLI Reference
Run `json2file --help` for more information.
```bash
$ json2file --help
Generate file output from JSON
Usage: json2file [OPTIONS] --keys --outputs --directory
Options:
-k, --keys Space delimited list of keys to extract from the JSON output
-o, --outputs The JSON output to use
-d, --directory The directory to output the files to
-s, --skip-missing-keys Skip missing keys
-e, --extension The extension to use for the files [default: txt] [possible values: txt, json, csv]
-v, --verbose
-h, --help Print help
-V, --version Print version
```
### Example
Run
```bash
json2file --keys="foo bar" --outputs="{\"foo\": \"value1\", \"bar\": \"value2\"}" --directory=/tmp --extension=txt
```
This creates two files with the following contents:
`foo.txt`
```txt
value1
```
`bar.txt`
```txt
value2
```
* Free software: [MIT license](LICENSE)
If you feel generous and want to show some extra appreciation:
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
[buymeacoffee]: https://www.buymeacoffee.com/jackton1
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
## Credits
This package was created with [Cookiecutter](https://github.com/cookiecutter/cookiecutter) using [cookiecutter-action](https://github.com/tj-actions/cookiecutter-action)
## Report Bugs
Report bugs at https://github.com/tj-actions/json2file/issues.
If you are reporting a bug, please include:
* Your operating system name and VERSION.
* Any details about your workflow that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.