UNPKG

@sanity/tsdoc

Version:

Generate API reference docs from TypeScript projects and store in a Sanity-friendly JSON format. Render a static frontend, or as React components.

218 lines (217 loc) 5.9 kB
{ "name": "@sanity/tsdoc", "version": "3.0.5", "description": "Generate API reference docs from TypeScript projects and store in a Sanity-friendly JSON format. Render a static frontend, or as React components.", "keywords": [ "sanity", "TSDoc", "TypeScript", "API", "API reference", "generate", "documentation" ], "homepage": "https://www.sanity.io/", "bugs": { "url": "https://github.com/sanity-io/tsdoc/issues" }, "repository": { "type": "git", "url": "git+https://github.com/sanity-io/tsdoc.git" }, "license": "MIT", "author": "Sanity.io <hello@sanity.io>", "sideEffects": false, "type": "commonjs", "exports": { ".": { "source": "./exports/index.ts", "import": "./dist/exports/index.mjs", "require": "./dist/exports/index.js", "default": "./dist/exports/index.js" }, "./react": { "source": "./exports/react.ts", "import": "./dist/exports/react.mjs", "require": "./dist/exports/react.js", "default": "./dist/exports/react.js" }, "./store": { "source": "./exports/store.ts", "import": "./dist/exports/store.mjs", "require": "./dist/exports/store.js", "default": "./dist/exports/store.js" }, "./studio": { "source": "./exports/studio.ts", "import": "./dist/exports/studio.mjs", "require": "./dist/exports/studio.js", "default": "./dist/exports/studio.js" }, "./package.json": "./package.json" }, "main": "./dist/exports/index.js", "module": "./dist/exports/index.mjs", "types": "./dist/exports/index.d.ts", "typesVersions": { "*": { "react": [ "./dist/exports/react.d.ts" ], "store": [ "./dist/exports/store.d.ts" ], "studio": [ "./dist/exports/studio.d.ts" ] } }, "bin": { "sanity-tsdoc": "./bin/sanity-tsdoc" }, "files": [ "bin", "dist", "exports", "src" ], "scripts": { "build": "pkg build --clean --check --strict", "dev": "run-p *:dev watch", "etl": "node -r dotenv-flow/config -r esbuild-register scripts/etl", "format": "prettier --cache --write .", "lint": "eslint --cache . --ext .cjs,.js,.ts,.tsx", "lint:fix": "pnpm format && pnpm lint --fix --quiet", "prepublishOnly": "pnpm build", "release": "semantic-release", "test": "vitest run", "tsdoc:dev": "node -r dotenv-flow/config -r esbuild-register scripts/dev", "type-check": "tsc --build", "watch": "pkg watch", "workshop:build": "workshop build --cwd workshop", "workshop:dev": "workshop dev --cwd workshop" }, "lint-staged": { "*": [ "prettier --write --cache --ignore-unknown" ] }, "prettier": { "bracketSpacing": false, "plugins": [ "prettier-plugin-packagejson" ], "printWidth": 100, "semi": false, "singleQuote": true }, "release": { "branches": [ "+([0-9])?(.{+([0-9]),x}).x", "main", { "name": "beta", "prerelease": true }, { "name": "alpha", "prerelease": true } ], "extends": "@sanity/semantic-release-preset" }, "dependencies": { "@microsoft/api-extractor": "7.52.9", "@microsoft/api-extractor-model": "7.30.7", "@microsoft/tsdoc": "0.15.1", "@microsoft/tsdoc-config": "0.17.1", "@portabletext/react": "^3.2.1", "@portabletext/toolkit": "^2.0.17", "@sanity/client": "^7.8.1", "@sanity/color": "^3.0.6", "@sanity/icons": "^3.7.4", "@sanity/pkg-utils": "^7.9.19", "@sanity/ui": "^3.0.5", "@types/cpx": "^1.5.5", "@vitejs/plugin-react": "^4.7.0", "cac": "^6.7.14", "chalk": "^4.1.2", "chokidar": "^4.0.3", "cors": "^2.8.5", "dotenv-flow": "^3.2.0", "esbuild": "^0.25.8", "esbuild-register": "^3.6.0", "express": "^4.21.2", "globby": "^11.1.0", "groq-js": "^1.17.3", "history": "^5.3.0", "jsonc-parser": "^3.3.1", "mkdirp": "^1.0.4", "pkg-up": "^3.1.0", "react-refractor": "^4.0.0", "refractor": "^5.0.0", "slugify": "^1.6.6", "tmp": "^0.2.3", "vite": "^6.3.5" }, "devDependencies": { "@sanity/semantic-release-preset": "^5.0.0", "@sanity/ui-workshop": "^3.1.2", "@types/cors": "^2.8.19", "@types/express": "^5.0.3", "@types/mkdirp": "^1.0.2", "@types/node": "^20.17.10", "@types/react": "^19.1.8", "@types/react-dom": "^19.1.6", "@types/tmp": "^0.2.6", "@types/uuid": "^10.0.0", "@types/yargs": "^17.0.33", "@typescript-eslint/eslint-plugin": "^8.38.0", "@typescript-eslint/parser": "^8.38.0", "babel-plugin-react-compiler": "rc", "cpx": "^1.5.0", "eslint": "^9.32.0", "eslint-config-prettier": "^10.1.8", "eslint-plugin-jsx-a11y": "^6.10.2", "eslint-plugin-prettier": "^5.5.3", "eslint-plugin-react": "^7.37.5", "eslint-plugin-react-compiler": "rc", "eslint-plugin-react-hooks": "^5.2.0", "eslint-plugin-simple-import-sort": "12.1.1", "lint-staged": "^13.2.2", "npm-run-all2": "^5.0.0", "prettier": "^3.6.2", "prettier-plugin-packagejson": "^2.5.19", "react": "^19.1.1", "react-dom": "^19.1.1", "rimraf": "^4.4.1", "sanity": "^4.1.1", "semantic-release": "^24.2.7", "styled-components": "^6.1.19", "typescript": "5.9.2", "uuid": "^11.1.0", "vitest": "^3.2.4" }, "peerDependencies": { "react": "^19", "react-dom": "^19", "sanity": "^4.0.0", "styled-components": "^6.1", "typescript": "5.8.x || 5.9.x" }, "packageManager": "pnpm@10.13.1", "engines": { "node": ">=20.19" }, "publishConfig": { "access": "public" }, "pnpm": { "overrides": { "@types/react": "$@types/react", "@types/react-dom": "$@types/react-dom", "react": "$react", "react-dom": "$react-dom" } } }