Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"name": "atlas-sdk-go-tools",
"version": "0.1.0",
"private": true,
"description": "Root package to expose the transformer CLI for npx usage",
"bin": {
"atlas-openapi-transformer": "tools/transformer/src/cli.js"
},
"dependencies": {
"simple-node-logger": "^21.8.12",
"yaml": "2.8.1",
"yargs": "^17.7.2"
},
"engines": {
"node": ">= 16",
"npm": ">= 8"
}
}


15 changes: 15 additions & 0 deletions tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,21 @@ Typically a SDK is generated by:
- `releaser` - release automation scripts and documentation
- `transformer` - OpenAPI transformation engine and it's documentation

### Transformer CLI usage

The transformer is also available as a CLI for local use:

```bash
# Full transform (in-place)
node ./transformer/bin/atlas-openapi-transformer.js transform -i ../openapi/atlas-api-transformed.yaml

# Flatten-only, reading from stdin and writing to stdout
cat ../openapi/atlas-api.yaml | node ./transformer/bin/atlas-openapi-transformer.js flatten --stdin --stdout > ../openapi/atlas-api-flattened.yaml

# Adjust log level
node ./transformer/bin/atlas-openapi-transformer.js transform -i ../openapi/atlas-api-transformed.yaml --log-level info
```

## SDK Generation Workflow

```mermaid
Expand Down
60 changes: 16 additions & 44 deletions tools/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 7 additions & 2 deletions tools/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@
"version": "0.1.0",
"private": "true",
"main": "transformer/src/index.js",
"bin": {
"atlas-openapi-transformer": "./transformer/src/cli.js"
},
"dependencies": {
"simple-node-logger": "^21.8.12",
"yaml": "2.8.1"
"yaml": "2.8.1",
"yargs": "^17.7.2"
},
"devDependencies": {
"@openapitools/openapi-generator-cli": "2.24.0",
Expand All @@ -15,7 +19,8 @@
"prettier": "3.6.2"
},
"scripts": {
"sdk:transform": "node ./transformer/src/transform",
"sdk:transform": "node ./transformer/src/cli.js transform",
"sdk:flatten": "node ./transformer/src/cli.js flatten",
"format": "prettier --write .",
"format:check": "prettier --check .",
"test": "jest **/__tests__/**.test.js",
Expand Down
2 changes: 1 addition & 1 deletion tools/scripts/transform.sh
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ echo "# Running transformation from $transformed_file OpenAPI from $OPENAPI_FILE
cp "$OPENAPI_FOLDER/$OPENAPI_FILE_NAME" "$openapiFileLocation"

npm install
npm run sdk:transform -- "$openapiFileLocation"
npx atlas-openapi-transformer transform --input "$openapiFileLocation"
Loading
Loading