@scalvert/readme-api-generator
Version:
Generates API documentation in your README
95 lines (94 loc) • 2.44 kB
JSON
{
"name": "@scalvert/readme-api-generator",
"version": "0.2.5",
"description": "Generates API documentation in your README",
"repository": {
"type": "git",
"url": "https://github.com/scalvert/readme-api-generator.git"
},
"license": "MIT",
"type": "module",
"exports": {
".": {
"require": "./dist/index.cjs",
"import": "./dist/index.js",
"types": "./dist/index.d.ts"
}
},
"main": "./dist/index.cjs",
"module": "./dist/index.js",
"types": "./dist/index.d.ts",
"bin": {
"readme-api-generator": "./bin/readme-api-generator.js"
},
"files": [
"dist",
"bin",
"jsdoc2md.json"
],
"scripts": {
"build": "tsup src/index.ts --format cjs,esm --dts --clean",
"docs:generate": "node ./bin/readme-api-generator.js index.js -m CUSTOM",
"lint": "eslint .",
"prepare": "npm run build",
"prepublishOnly": "npm run build",
"test": "npm run lint && vitest run",
"test:watch": "vitest",
"watch": "npm run build -- --watch src"
},
"dependencies": {
"@babel/cli": "^7.17.6",
"@babel/core": "^7.17.9",
"@babel/plugin-proposal-class-properties": "^7.16.7",
"@babel/plugin-proposal-object-rest-spread": "^7.17.3",
"@babel/preset-env": "^7.16.11",
"@babel/preset-typescript": "^7.16.7",
"jsdoc-babel": "^0.5.0",
"jsdoc-to-markdown": "^9.1.3",
"meow": "^10.1.2",
"typescript": "^4.6.2"
},
"devDependencies": {
"@scalvert/bin-tester": "^2.0.0",
"@types/jsdoc-to-markdown": "^7.0.3",
"@types/node": "^24.13.1",
"@typescript-eslint/eslint-plugin": "^5.15.0",
"@typescript-eslint/parser": "^5.15.0",
"eslint": "^7.32.0",
"eslint-config-prettier": "^8.3.0",
"eslint-plugin-node": "^11.1.0",
"eslint-plugin-prettier": "^4.0.0",
"prettier": "^2.4.0",
"release-it": "^15.11.0",
"release-it-lerna-changelog": "^5.0.0",
"tsup": "^8.5.1",
"vite": "^8.0.16",
"vitest": "^4.1.8"
},
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org"
},
"engines": {
"node": ">=14"
},
"release-it": {
"plugins": {
"release-it-lerna-changelog": {
"infile": "CHANGELOG.md",
"launchEditor": true
}
},
"git": {
"tagName": "v${version}"
},
"github": {
"release": true,
"tokenRef": "GITHUB_AUTH"
}
},
"volta": {
"node": "14.17.6",
"npm": "8.7.0"
}
}