2b2778b4f9
We write our API docs in markdown embedded in tsdocs comments. vscode's hover preview of these docs renders them as expected, but api-extract treats whitespace as insignificant and strips out most newlines, which breaks markdown lists. See https://github.com/microsoft/tsdoc/issues/178 for details. This PR patches tsdoc's emitter so that it preserves newlines. That way, we can write markdown lists and have them picked up as expected by the docs site markdown parser. I don't expect this to introduce other issues with previously ignored line breaks and markdown is only sensitive to linebreaks in certain scenarios (like lists) anyway. (Extracted from bindings docs - #3812) Before: <img width="740" alt="Screenshot 2024-05-22 at 15 00 43" src="https://github.com/tldraw/tldraw/assets/1489520/846f88b1-9480-48a6-9795-6a9f27ca242a"> After: <img width="708" alt="Screenshot 2024-05-22 at 14 51 28" src="https://github.com/tldraw/tldraw/assets/1489520/80c54b8e-4f74-45e7-9cba-0287175e9f97"> ### Change Type - [x] `docs` — Changes to the documentation, examples, or templates. - [x] `bugfix` — Bug fix
126 lines
4.1 KiB
JSON
126 lines
4.1 KiB
JSON
{
|
|
"name": "@tldraw/monorepo",
|
|
"description": "A tiny little drawing app (monorepo).",
|
|
"version": "0.0.0",
|
|
"private": true,
|
|
"author": {
|
|
"name": "tldraw Inc.",
|
|
"email": "hello@tldraw.com"
|
|
},
|
|
"homepage": "https://tldraw.dev",
|
|
"repository": {
|
|
"type": "git",
|
|
"url": "https://github.com/tldraw/tldraw"
|
|
},
|
|
"bugs": {
|
|
"url": "https://github.com/tldraw/tldraw/issues"
|
|
},
|
|
"keywords": [
|
|
"tldraw",
|
|
"drawing",
|
|
"app",
|
|
"development",
|
|
"whiteboard",
|
|
"canvas",
|
|
"infinite"
|
|
],
|
|
"workspaces": [
|
|
"docs",
|
|
"apps/*",
|
|
"packages/*",
|
|
"apps/vscode/*",
|
|
"e2e",
|
|
"config",
|
|
"scripts"
|
|
],
|
|
"scripts": {
|
|
"clean": "scripts/clean.sh",
|
|
"postinstall": "husky install && yarn refresh-assets",
|
|
"refresh-assets": "lazy refresh-assets",
|
|
"dev": "LAZYREPO_PRETTY_OUTPUT=0 lazy run dev --filter='apps/examples' --filter='packages/tldraw'",
|
|
"dev-vscode": "code ./apps/vscode/extension && lazy run dev --filter='apps/vscode/{extension,editor}'",
|
|
"dev-app": "LAZYREPO_PRETTY_OUTPUT=0 lazy run dev --filter='apps/{dotcom,dotcom-asset-upload,dotcom-worker}' --filter='packages/tldraw'",
|
|
"dev-docs": "LAZYREPO_PRETTY_OUTPUT=0 lazy run dev --filter='apps/docs'",
|
|
"dev-huppy": "LAZYREPO_PRETTY_OUTPUT=0 lazy run dev --filter 'apps/huppy'",
|
|
"build": "lazy build",
|
|
"build-app": "lazy run build --filter 'apps/dotcom'",
|
|
"build-docs": "lazy run build --filter 'apps/docs'",
|
|
"build-types": "lazy inherit",
|
|
"build-api": "lazy build-api",
|
|
"build-package": "lazy build-package",
|
|
"preview-app": "VITE_PREVIEW=1 yarn dev-app",
|
|
"lint": "lazy lint",
|
|
"format": "prettier --write --cache '**/*.{yml,yaml,json,md,mdx,html,css,js,jsx,ts,tsx,cjs,mjs}'",
|
|
"typecheck": "yarn refresh-assets && tsx scripts/typecheck.ts",
|
|
"check-scripts": "tsx scripts/check-scripts.ts",
|
|
"check-tsconfigs": "tsx scripts/check-tsconfigs.ts",
|
|
"update-pr-template": "tsx scripts/update-pr-template.ts",
|
|
"api-check": "lazy api-check",
|
|
"test-ci": "lazy test-ci",
|
|
"test": "lazy test",
|
|
"test-coverage": "lazy test-coverage && node scripts/offer-coverage.mjs",
|
|
"e2e": "lazy e2e --filter='apps/examples'"
|
|
},
|
|
"engines": {
|
|
"npm": ">=7.0.0"
|
|
},
|
|
"packageManager": "yarn@4.0.2",
|
|
"lint-staged": {
|
|
"*.{js,jsx,ts,tsx,json}": [
|
|
"prettier --write --cache"
|
|
]
|
|
},
|
|
"devDependencies": {
|
|
"@microsoft/api-extractor": "^7.43.1",
|
|
"@next/eslint-plugin-next": "^13.3.0",
|
|
"@swc/core": "^1.3.55",
|
|
"@swc/jest": "^0.2.34",
|
|
"@types/glob": "^8.1.0",
|
|
"@types/jest": "^29.5.12",
|
|
"@types/node": "~20.11",
|
|
"@types/react": "^18.2.47",
|
|
"@types/react-dom": "^18.2.18",
|
|
"@typescript-eslint/eslint-plugin": "^5.57.0",
|
|
"@typescript-eslint/parser": "^5.57.0",
|
|
"auto": "^11.1.1",
|
|
"eslint": "^8.37.0",
|
|
"eslint-config-prettier": "^8.8.0",
|
|
"eslint-plugin-deprecation": "^2.0.0",
|
|
"eslint-plugin-import": "^2.27.5",
|
|
"eslint-plugin-local": "^1.0.0",
|
|
"eslint-plugin-no-only-tests": "^3.1.0",
|
|
"eslint-plugin-react": "^7.32.2",
|
|
"eslint-plugin-react-hooks": "^4.6.0",
|
|
"fs-extra": "^11.1.0",
|
|
"husky": "^8.0.0",
|
|
"jest": "30.0.0-alpha.2",
|
|
"json5": "^2.2.3",
|
|
"lazyrepo": "0.0.0-alpha.27",
|
|
"license-report": "^6.5.0",
|
|
"lint-staged": ">=10",
|
|
"prettier": "^3.0.3",
|
|
"prettier-plugin-organize-imports": "^3.2.3",
|
|
"rimraf": "^4.4.0",
|
|
"tsx": "^4.0.0",
|
|
"typescript": "^5.3.3",
|
|
"vercel": "^28.16.15"
|
|
},
|
|
"// resolutions.canvas": [
|
|
"our examples app depenends on pdf.js which pulls in canvas as an optional dependency.",
|
|
"it slows down installs quite a bit though, so we replace it with an empty package."
|
|
],
|
|
"resolutions": {
|
|
"@microsoft/api-extractor@^7.35.4": "patch:@microsoft/api-extractor@npm%3A7.35.4#./.yarn/patches/@microsoft-api-extractor-npm-7.35.4-5f4f0357b4.patch",
|
|
"vectra@^0.4.4": "patch:vectra@npm%3A0.4.4#./.yarn/patches/vectra-npm-0.4.4-6aac3f6c29.patch",
|
|
"domino@^2.1.6": "patch:domino@npm%3A2.1.6#./.yarn/patches/domino-npm-2.1.6-b0dc3de857.patch",
|
|
"canvas": "npm:empty-npm-package@1.0.0",
|
|
"@microsoft/tsdoc@npm:0.14.2": "patch:@microsoft/tsdoc@npm%3A0.14.2#~/.yarn/patches/@microsoft-tsdoc-npm-0.14.2-9988282153.patch"
|
|
},
|
|
"dependencies": {
|
|
"@sentry/cli": "^2.25.0",
|
|
"@yarnpkg/types": "^4.0.0",
|
|
"cross-env": "^7.0.3",
|
|
"purgecss": "^5.0.0",
|
|
"svgo": "^3.0.2"
|
|
}
|
|
}
|