Skip to content

Commit

Permalink
Cleanup + update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Mathieu Gamache committed Jun 4, 2024
1 parent ed79a38 commit 68a58da
Show file tree
Hide file tree
Showing 6 changed files with 74 additions and 13 deletions.
11 changes: 3 additions & 8 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
name: Publish

# on:
# push:
# branches: ["main"]
# tags: ["*.*.*"]
# paths-ignore: ["*.md"]

on:
pull_request:
branches: [main]
push:
branches: ["main"]
tags: ["*.*.*"]
paths-ignore: ["*.md"]

env:
Expand Down
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,27 @@
# wl-openapi-typescript

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE)
[![CI](https://github.com/gsoft-inc/wl-openapi-typescript/actions/workflows/ci.yml/badge.svg)](https://github.com/gsoft-inc/wl-openapi-typescript/actions/workflows/ci.yml)

- pnpm dlx @workleap/create-schemas
- pnpm create create-schemas???
- dev dependencies
Tools to generate TypeScript schemas from OpenAPI.

## Packages

| Package | Version |
|-------------------------| ---------------------------------------------------------------------------------------------------------------------------------------------|
| [@workleap/create-schemas](https://www.npmjs.org/package/@workleap/create-schemas)| [![NPM Version](http://img.shields.io/npm/v/@workleap/create-schemas.svg?style=flat)](https://www.npmjs.org/package/@workleap/create-schemas) |


## Usages

Add a script in package.json to call `@workleap/create-schemas`

```json
"scripts": {
"generate-schemas": "pnpm dlx @workleap/create-schemas arg1 arg2",
}
```

## 🤝 Contributing

View the [contributor's documentation](./CONTRIBUTING.md).
28 changes: 28 additions & 0 deletions debug/package-lock.json

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

17 changes: 17 additions & 0 deletions debug/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"name": "debug",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"run-with-download": "pnpm dlx @workleap/create-schemas arg1 arg2",
"run-from-dev-dep1": "pnpm @workleap/create-schemas arg1 arg2",
"run-from-dev-dep2": "create-schemas arg1 arg2"
},
"devDependencies": {
"@workleap/create-schemas": "0.0.1-preview.0"
},
"keywords": [],
"author": "",
"license": "ISC"
}
2 changes: 1 addition & 1 deletion packages/create-schemas/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@workleap/create-schemas",
"author": "Workleap",
"version": "0.0.1-preview.0",
"version": "0.0.1-preview.1",
"description": "CLI to generate Typescript schemas from an OpenAPI document",
"license": "Apache-2.0",
"repository": {
Expand Down
2 changes: 1 addition & 1 deletion packages/create-schemas/src/bin.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
console.log("Hello World!!!!!");
console.log("Hello World!");

// Access command-line arguments
const args = process.argv.slice(2);
Expand Down

0 comments on commit 68a58da

Please sign in to comment.