UNPKG

typescript-docs-verifier

Version:

Verifies that typescript examples in markdown files actually compile.

117 lines (116 loc) 2.94 kB
{ "name": "typescript-docs-verifier", "description": "Verifies that typescript examples in markdown files actually compile.", "keywords": [ "block", "blocks", "build", "check", "code", "compilation", "compile", "doc", "docs", "documentation", "markdown", "md", "ts", "typescript", "verify" ], "version": "3.0.1", "main": "dist/index.js", "@types": "dist/index.d.ts", "bin": { "typescript-docs-verifier": "dist/bin/compile-typescript-docs.js" }, "license": "Apache-2.0", "author": "BBC", "repository": { "type": "git", "url": "git+https://github.com/bbc/typescript-docs-verifier.git" }, "bugs": { "url": "https://github.com/bbc/typescript-docs-verifier/issues" }, "homepage": "https://github.com/bbc/typescript-docs-verifier#readme", "engines": { "node": ">=20" }, "scripts": { "format": "prettier --write '**/*.ts' '**/*.json'", "pretest": "npm run-script build", "test": "npm-run-all -p -c format unittest lint", "posttest": "npm-run-all compile-docs", "unittest": "nyc mocha --timeout 20000 -r ts-node/register --recursive test/TestConfiguration.ts 'test/*Spec.ts' 'test/**/*Spec.ts'", "lint": "eslint '**/*.ts'", "build": "rm -rf dist && tsc", "compile-docs": "node ./dist/bin/compile-typescript-docs.js", "prepublishOnly": "npm-run-all -s build compile-docs" }, "devDependencies": { "@istanbuljs/nyc-config-typescript": "^1.0.2", "@types/chai": "^5.2.2", "@types/chai-as-promised": "^8.0.1", "@types/fs-extra": "^11.0.4", "@types/mocha": "^10.0.10", "@types/node": "^20.19.1", "@types/react": "^18.2.12", "@types/yargs": "^17.0.12", "@typescript-eslint/eslint-plugin": "^8.24.0", "@typescript-eslint/parser": "^8.24.0", "chai": "^5.2.0", "chai-as-promised": "^8.0.1", "eslint": "^8.57.1", "eslint-config-prettier": "^10.0.1", "eslint-plugin-functional": "^6.6.3", "eslint-plugin-node": "^11.1.0", "eslint-plugin-promise": "^7.2.1", "fs-extra": "^11.3.0", "mocha": "^11.1.0", "npm-run-all2": "^7.0.2", "nyc": "^17.1.0", "prettier": "^3.5.1", "react": "^18.2.0", "ts-node": "^10.9.2", "typescript": "^4.7.2", "verify-it": "^2.3.3" }, "dependencies": { "chalk": "^4.1.2", "ora": "^5.4.1", "yargs": "^17.5.1" }, "peerDependencies": { "typescript": ">=4.7.2" }, "files": [ "dist/index.js", "dist/index.d.ts", "dist/index.js.map", "dist/bin", "dist/src" ], "nyc": { "extends": "@istanbuljs/nyc-config-typescript", "check-coverage": true, "all": true, "include": [ "**/*.ts" ], "exclude": [ "bin", "dist", "test" ], "reporter": [ "html", "text", "text-summary" ], "report-dir": "test/coverage" }, "prettier": { "trailingComma": "es5" } }