@playcanvas/editor-api
Advanced tools
Comparing version 1.0.28 to 1.0.29
@@ -1,2 +0,2 @@ | ||
Copyright (c) 2011-2021 PlayCanvas Ltd. | ||
Copyright (c) 2011-2024 PlayCanvas Ltd. | ||
@@ -3,0 +3,0 @@ Permission is hereby granted, free of charge, to any person obtaining a copy |
{ | ||
"name": "@playcanvas/editor-api", | ||
"version": "1.0.28", | ||
"version": "1.0.29", | ||
"author": "PlayCanvas <support@playcanvas.com>", | ||
@@ -31,21 +31,21 @@ "homepage": "https://github.com/playcanvas/editor-api#readme", | ||
"devDependencies": { | ||
"@babel/core": "^7.19.6", | ||
"@babel/eslint-parser": "^7.19.1", | ||
"@babel/preset-env": "^7.19.4", | ||
"@playcanvas/eslint-config": "^1.3.0", | ||
"@playcanvas/observer": "^1.3.2", | ||
"@rollup/plugin-babel": "^6.0.2", | ||
"chai": "^4.3.6", | ||
"eslint": "^8.26.0", | ||
"karma": "^6.4.1", | ||
"karma-chrome-launcher": "^3.1.0", | ||
"@babel/core": "^7.23.7", | ||
"@babel/eslint-parser": "^7.23.3", | ||
"@babel/preset-env": "^7.23.8", | ||
"@playcanvas/eslint-config": "^1.7.1", | ||
"@playcanvas/observer": "1.3.2", | ||
"@rollup/plugin-babel": "^6.0.4", | ||
"chai": "^4.4.1", | ||
"eslint": "^8.56.0", | ||
"karma": "^6.4.2", | ||
"karma-chrome-launcher": "^3.2.0", | ||
"karma-mocha": "2.0.1", | ||
"karma-spec-reporter": "^0.0.34", | ||
"mocha": "^10.1.0", | ||
"rollup": "^3.2.3", | ||
"rollup-plugin-dts": "^5.0.0", | ||
"sinon": "^14.0.1", | ||
"typedoc": "^0.23.17", | ||
"typedoc-plugin-markdown": "^3.13.6", | ||
"typescript": "^4.8.4" | ||
"karma-spec-reporter": "^0.0.36", | ||
"mocha": "^10.2.0", | ||
"rollup": "^4.9.5", | ||
"rollup-plugin-dts": "^6.1.0", | ||
"sinon": "^17.0.1", | ||
"typedoc": "^0.25.12", | ||
"typedoc-plugin-mdn-links": "^3.1.18", | ||
"typescript": "^5.3.3" | ||
}, | ||
@@ -56,6 +56,6 @@ "scripts": { | ||
"build": "rollup -c", | ||
"build:docs": "typedoc --options typedoc.json", | ||
"build:types": "tsc index.js --outDir types --allowJs --declaration --emitDeclarationOnly && rollup -c --environment target:types", | ||
"docs": "typedoc", | ||
"lint": "eslint --ext .js src" | ||
} | ||
} |
# Overview | ||
This is the PlayCanvas Editor API. You can find API documentation [here](docs/modules.md). | ||
This is the PlayCanvas Editor API. You can find API documentation [here](https://api.playcanvas.com/modules/Editor.html). | ||
# Installing | ||
Run: | ||
``` | ||
```sh | ||
npm install | ||
@@ -14,3 +16,4 @@ ``` | ||
Run: | ||
``` | ||
```sh | ||
npm run build | ||
@@ -24,19 +27,12 @@ ``` | ||
To build the documentation run: | ||
```sh | ||
npm run docs | ||
``` | ||
npm run build:docs | ||
``` | ||
The resulting .md file will be under docs/modules.md. | ||
NOTE: Build the docs after you commit any API changes, otherwise the code links in the docs might point to the wrong lines. | ||
NOTE: The following documents are created externally. When you build the docs, revert those documents (or update them externally): | ||
* `EntityProperties.md` | ||
* `AssetProperties.md` | ||
* `SceneSettingsProperties.md` | ||
# Tests | ||
To run tests run: | ||
``` | ||
```sh | ||
npm test | ||
@@ -46,4 +42,5 @@ ``` | ||
To step through the tests using Chrome run: | ||
``` | ||
```sh | ||
npm run test:debug | ||
``` |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
371918
5
10513
44