Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onlang-org/onst
Helper repository for on-lang. Provides sample schema and example objects.
https://github.com/onlang-org/onst
commander github inquirer json octokit onl onlang schema
Last synced: 2 months ago
JSON representation
Helper repository for on-lang. Provides sample schema and example objects.
- Host: GitHub
- URL: https://github.com/onlang-org/onst
- Owner: onlang-org
- License: mit
- Created: 2024-02-29T21:40:26.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-03-12T23:02:30.000Z (8 months ago)
- Last Synced: 2024-03-13T23:05:57.100Z (8 months ago)
- Topics: commander, github, inquirer, json, octokit, onl, onlang, schema
- Language: JavaScript
- Homepage: http://onlang.js.org/
- Size: 80.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[npm]: https://www.npmjs.com/package/@onlang-org/onst
[github]: https://github.com/onlang-org/onst
[readme]: https://github.com/onlang-org/onst/blob/main/README.md
# @onlang-org/onst (onst)
> fetch JSON schema from [onst GitHub repository](https://github.com/onlang-org/onst) or [SchemaStore](https://www.schemastore.org). THe package exposes helper functions and also can be installed globally to be used via its interactive CLI built using [inquirer](https://www.npmjs.com/package/inquirer)
[](https://github.com/onlang-org/onst/actions/workflows/github-code-scanning/codeql)
[](https://www.npmjs.com/package/@onlang-org/onst)
[](https://www.npmjs.com/package/@onlang-org/onst)
[](https://github.com/onlang-org/onst/blob/master/LICENSE.md)
[](https://github.com/onlang-org/onst/network)
The package uses [onst-schemastore](https://www.npmjs.com/package/@onlang-org/onst-schemastore) to simplify fetching and categorising SchemaStore catalog into topics and download in bulk. (eg. download all schemata for AWS in one go). Read more about it [here](https://github.com/onlang-org/onst-schemastore). It leverages the GitHub [Octokit](https://github.com/octokit/octokit.js) API for working with schema files hosted on [onst github repository](https://github.com/onlang-org/onst).
onst provides a convenient CLI interface designed using [inquirer](https://www.npmjs.com/package/inquirer). You can fetch schema files, show the schema list, and generate example ONL (ONLang) files from the schema.
> **_This project lives with [on-lang](https://github.com/onlang-org/onlang)_**
## Table of Contents
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Current Available Schemas](#current-available-schemas)
- [Architecture](#architecture)
- [Extending onst](#extending-onst)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [License](#license)
## Prerequisites
Before using the package, ensure you have the following set up:
- Node.js 14+ or higher [https://nodejs.org/en/]
- [npm](https://www.npmjs.com/)
## Installation
Install the package using npm:
```bash
npm install -g @onlang-org/onst
```
## Usage
**Show Help**
```
onst help
```
This command shows help information about the available commands and their usage.
**Show Version**
```
onst version
```
This command displays the version of the ONLang CLI.
**Fetch Schema Files**
```
onst fetch [-s]
-s, --schemastore: Use Schemastore.org (default is false).
```
This command fetches schema files from the onst GitHub repository for ONLang.
**Show Schema List**
```
onst show [-s]
-s, --schemastore: Use Schemastore.org (default is false).
```
This command shows the list of schemata available in the onst GitHub repository for ONLang.
**Generate Example ONL**
```
onst example [-s] [-w] [-r] [-e] [-f ] [-d ]
-s, --schemastore: Use Schemastore.org (default is false).
-w, --write: write the generated ONL files.
-r, --random: Use fake values for optional properties.
-e, --example: Use example values for required properties.
-f, --file : Specify the file name for the generated ONL file.
-d, --destination : Specify the destination path where the generated ONL will be saved.
```
This command generates ONL files from the schema.
### Examples
```
onst example -w -r -f example.onl -d ./output
```
This example generates an ONL file, uses random values for optional properties, writes the file with the name example.onl, and stores it in the ./output directory.
## Current Available Schemas
- Qualtrics
- [Survey](/schema/qualtrics.survey.d.json)
- [Dataset](/schema/qualtrics.dataset.d.json)
- [Contact](/schema/qualtrics.contact.d.json)
## Architecture
**GitHub Interaction**: Utilizes the GitHub API through the Octokit library for fetching repository content.
**User Interaction**: Employs the Inquirer library for interactive command-line prompts.
**File Operations**: Utilizes Node.js File System (fs) for reading, saving, and searching files.
**Configuration**: Relies on environment variables for GitHub credentials and repository details.
**Example Generation**: Generates example ONL files based on the schema and uses [json-schema-faker](https://github.com/json-schema-faker/json-schema-faker) and then transpiles it into ONL using [json-to-pretty-yaml](https://www.npmjs.com/package/json-to-pretty-yaml)
## Extending onst
onst by default gets the schema list from the onst GitHub repository. To fetch schema files from a different repository, usethe env variables `GITHUB_OWNER`, `GITHUB_PATH` and `GITHUB_REPO`.
- GITHUB_OWNER: The username of the repository to fetch schema files from.
- GITHUB_REPO: The name of the repository to fetch schema files from.
- GITHUB_PATH: The path within the repository to fetch schema files from.
### Examples
- [JSON](/examples/json)
- [ONL](/examples/onl)
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute.
## Code of Conduct
See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details on the code of conduct.
## License
See [LICENSE.md](LICENSE.md) for details on the license.