UNPKG

rdme

Version:

ReadMe's official CLI and GitHub Action.

192 lines (191 loc) 5.06 kB
{ "name": "rdme", "version": "10.4.0", "description": "ReadMe's official CLI and GitHub Action.", "license": "MIT", "author": "ReadMe <support@readme.io> (https://readme.com)", "engines": { "node": ">=20.10.0" }, "bin": { "rdme": "bin/run.js" }, "files": [ "/bin/run*", "/dist", "/oclif.manifest.json" ], "keywords": [ "api", "apidoc", "apis", "documentation", "microservice", "oai", "oas", "openapi", "openapi document", "openapi initiative", "openapi spec", "openapi specification", "postman", "readme", "swagger" ], "exports": { ".": "./dist/index.js", "./types": "./dist/types.js", "./utils": "./dist/utils.js" }, "repository": { "type": "git", "url": "git+https://github.com/readmeio/rdme.git" }, "bugs": { "url": "https://github.com/readmeio/rdme/issues" }, "type": "module", "dependencies": { "@actions/core": "^1.6.0", "@oclif/core": "^4.0.29", "@oclif/plugin-autocomplete": "^3.2.6", "@oclif/plugin-help": "^6.2.15", "@oclif/plugin-plugins": "^5.4.36", "@oclif/plugin-warn-if-update-available": "^3.1.19", "ajv": "^8.17.1", "ajv-formats": "^3.0.1", "chalk": "^5.3.0", "ci-info": "^4.0.0", "configstore": "^7.0.0", "debug": "^4.3.3", "gray-matter": "^4.0.1", "ignore": "^7.0.0", "js-yaml": "^4.1.0", "json-schema-to-ts": "^3.1.1", "mime-types": "^3.0.1", "oas": "^27.1.0", "oas-normalize": "^14.1.0", "ora": "^8.1.1", "prompts": "^2.4.2", "semver": "^7.5.3", "simple-git": "^3.19.1", "slugify": "^1.6.6", "string-argv": "^0.3.2", "table": "^6.8.1", "tmp-promise": "^3.0.3", "toposort": "^2.0.2", "undici": "^5.28.4", "unzipper": "^0.12.3", "validator": "^13.7.0" }, "devDependencies": { "@commitlint/cli": "^19.0.3", "@commitlint/config-conventional": "^19.0.3", "@oclif/test": "^4.1.0", "@readme/better-ajv-errors": "^2.3.2", "@readme/eslint-config": "^14.7.2", "@readme/oas-examples": "^6.0.0", "@rollup/plugin-commonjs": "^28.0.0", "@rollup/plugin-json": "^6.0.0", "@rollup/plugin-node-resolve": "^16.0.0", "@rollup/plugin-replace": "^6.0.1", "@types/configstore": "^6.0.0", "@types/debug": "^4.1.7", "@types/js-yaml": "^4.0.5", "@types/mime-types": "^3.0.0", "@types/prompts": "^2.4.2", "@types/semver": "^7.3.12", "@types/toposort": "^2.0.7", "@types/unzipper": "^0.10.11", "@types/validator": "^13.7.6", "@vitest/coverage-v8": "^3.0.0", "@vitest/expect": "^3.0.0", "alex": "^11.0.0", "eslint": "^8.47.0", "husky": "^9.0.10", "knip": "^5.0.2", "nock": "^14.0.0", "oclif": "^4.15.12", "openapi-types": "^12.1.3", "prettier": "^3.0.2", "rollup": "^4.3.0", "rollup-plugin-esbuild": "^6.2.0", "tsx": "^4.19.2", "type-fest": "^4.3.1", "typescript": "^5.8.2", "vitest": "^3.0.0" }, "scripts": { "build": "tsc", "build:docs": "oclif readme --multi --output-dir documentation/commands --no-aliases", "build:gha": "npm run build && rollup --config", "lint": "alex . && alex . --mdx && knip && npm run lint:ts && npm run prettier && npm run schemas:check", "lint:ts": "eslint . --ext .js,.ts", "prebuild": "rm -rf dist/", "prepack": "npm run build", "prepare": "husky", "pretest": "npm run build", "prettier": "prettier --check .", "schemas:check": "./bin/json-schema-store.js", "schemas:write": "./bin/json-schema-store.js --update", "test": "vitest run --coverage", "version": "npm run build:gha && oclif manifest && npm run build:docs" }, "commitlint": { "extends": [ "@commitlint/config-conventional" ], "rules": { "body-max-line-length": [ 0, "always", "Infinity" ], "footer-max-line-length": [ 0, "always", "Infinity" ], "scope-case": [ 2, "never", "upper-case" ] } }, "oclif": { "bin": "rdme", "dirname": "rdme", "commands": { "strategy": "explicit", "target": "./dist/index.js", "identifier": "COMMANDS" }, "topicSeparator": " ", "helpClass": "./dist/lib/help", "hooks": { "prerun": { "target": "./dist/index.js", "identifier": "prerun" }, "createGHA": { "target": "./dist/index.js", "identifier": "createGHA" } }, "plugins": [ "@oclif/plugin-autocomplete", "@oclif/plugin-help", "@oclif/plugin-plugins", "@oclif/plugin-warn-if-update-available" ], "pluginPrefix": "rdme-plugin", "scope": "readme", "topics": { "openapi": { "description": "Manage your API definition (e.g., syncing, validation, analysis, conversion, etc.). Supports OpenAPI, Swagger, and Postman collections, in either JSON or YAML formats." } } }, "prettier": "@readme/eslint-config/prettier" }