UNPKG

@himenon/argo-rollouts-typescript-openapi

Version:

Implementation of TypeScript generated from argo-rollouts OpenAPI

92 lines 4.24 kB
{ "name": "@himenon/argo-rollouts-typescript-openapi", "version": "1.1.3", "description": "Implementation of TypeScript generated from argo-rollouts OpenAPI", "keywords": [ "argo-rollouts", "k8s", "OpenAPI", "Swagger", "argocd" ], "homepage": "https://github.com/Himenon/argo-rollouts-typescript-openapi#readme", "bugs": { "url": "https://github.com/Himenon/argo-rollouts-typescript-openapi/issues" }, "repository": { "type": "git", "url": "git@github.com:Himenon/argo-rollouts-typescript-openapi.git" }, "license": "MIT", "author": { "name": "Himenon", "email": "k.himeno314@gmail.com", "url": "https://github.com/Himenon" }, "sideEffects": false, "main": "$cjs/index.js", "module": "$esm/index.js", "types": "$types/index.d.ts", "simple-git-hooks": { "pre-commit": "npx lint-staged" }, "devDependencies": { "@commitlint/cli": "16.2.3", "@commitlint/config-conventional": "16.2.1", "@himenon/openapi-typescript-code-generator": "^0.17.0", "@types/jest": "27.4.1", "@types/node": "17.0.23", "@types/node-fetch": "2.6.1", "@types/rimraf": "3.0.2", "@typescript-eslint/eslint-plugin": "5.17.0", "@typescript-eslint/parser": "5.17.0", "cherry-pick": "^0.5.0", "conventional-changelog-angular-all": "1.7.0", "cpy": "^8.1.2", "dependency-cruiser": "11.4.1", "eslint": "8.12.0", "eslint-config-prettier": "8.5.0", "eslint-plugin-import": "2.25.4", "execa": "5.1.1", "generate-changelog": "1.8.0", "jest": "27.5.1", "jest-cli": "27.5.1", "lerna": "4.0.0", "lint-staged": "12.3.7", "node-fetch": "^2.6.7", "npm-run-all": "4.1.5", "prettier": "2.6.1", "rimraf": "3.0.2", "simple-git-hooks": "^2.7.0", "sort-package-json": "1.55.0", "swagger2openapi": "^7.0.8", "ts-jest": "27.1.4", "ts-node": "10.7.0", "typescript": "4.6.3" }, "engines": { "pnpm": ">=6" }, "publishConfig": { "access": "public" }, "scripts": { "build": "pnpm ts ./scripts/build.ts", "build:all": "run-s fetch:schemas generate:code", "clean": "pnpm ts ./scripts/clean.ts", "fetch:schemas": "pnpm ts ./scripts/fetchSchema.ts", "format:code": "run-s prettier:format eslint:format", "lerna:version:up": "lerna version --yes", "generate:code": "pnpm ts ./scripts/generateCode.ts", "release:github:registry": "pnpm publish --registry https://npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}", "release:npm:registry": "pnpm publish", "test": "run-s depcruise:validate eslint:validate prettier:validate", "prettier:format": "prettier \"**/*.{js,jsx,ts,tsx,json,yml,yaml,md,html}\" --write ./src", "prettier:validate": "prettier --check \"**/*.{js,jsx,ts,tsx,json,yml,yaml,md,html}\"", "eslint:format": "eslint \"**/*.{ts,tsx}\" --fix", "eslint:validate": "eslint \"**/*.{ts,tsx}\"", "depcruise:validate": "depcruise --validate .dependency-cruiser.js src", "ts": "ts-node -P tsconfig.build.json" }, "readme": "# @himenon/argo-rollouts-typescript-openapi\n\n```bash\nnpm i @himenon/argo-rollouts-typescript-openapi\npnpm i @himenon/argo-rollouts-typescript-openapi\nyarn add @himenon/argo-rollouts-typescript-openapi\n```\n\n## Usage\n\n```ts\nimport * as fs from \"fs\";\nimport * as yaml from \"js-yaml\"; // pnpm i -D js-yaml @types/js-yaml\nimport type { Schemas } from \"@himenon/argo-rollouts-typescript-openapi/v1.22.3\";\n```\n\n## Build\n\n```ts\npnpm run build\n```\n\n## Update Schemas\n\n```bash\n# Fetch and Build\npnpm run build:all\n\n# Fetch schemas\npnpm run fetch:schemas\n\n# Generate source code\npnpm run generate:code\n```\n\n## OpenAPI Source for argo-rollouts\n\n- <https://github.com/argoproj/argo-rollouts/blob/master/pkg/apiclient/rollout/rollout.swagger.json>\n\n## OpenAPI TypeScript Code Generator\n\n- [@himenon/openapi-typescript-code-generator](https://github.com/Himenon/openapi-typescript-code-generator)\n\nYou can also just use the type definition\n\n## Use Another Version\n\nEdit [config.ts](./scripts/config.ts)\n\n## LICENCE\n\n[@Himenon/argo-rollouts-typescript-openapi](https://github.com/Himenon/argo-rollouts-typescript-openapi)・MIT\n" }