43e429fa93
A template for `jsdoc` that generat the HTML5 public classref.
The script can be run via `npm run docs` to print to stdout.
You can dry run via `npm run docs -- --d dry-run` or write to file via
`npm run docs -- -d /path/to/file.rst`
Also update Makefile in `doc/` and add dry run test to CI.
(cherry picked from commit 472482013e)
28 lines
1.3 KiB
JSON
28 lines
1.3 KiB
JSON
{
|
|
"name": "godot",
|
|
"private": true,
|
|
"version": "1.0.0",
|
|
"description": "Linting setup for Godot's HTML5 platform code",
|
|
"scripts": {
|
|
"test": "echo \"Error: no test specified\" && exit 1",
|
|
"docs": "jsdoc --template js/jsdoc2rst/ js/engine/engine.js js/engine/config.js --destination ''",
|
|
"lint": "npm run lint:engine && npm run lint:libs && npm run lint:modules && npm run lint:tools",
|
|
"lint:engine": "eslint \"js/engine/*.js\" --no-eslintrc -c .eslintrc.engine.js",
|
|
"lint:libs": "eslint \"js/libs/*.js\" --no-eslintrc -c .eslintrc.libs.js",
|
|
"lint:modules": "eslint \"../../modules/**/*.js\" --no-eslintrc -c .eslintrc.libs.js",
|
|
"lint:tools": "eslint \"js/jsdoc2rst/**/*.js\" --no-eslintrc -c .eslintrc.engine.js",
|
|
"format": "npm run format:engine && npm run format:libs && npm run format:modules && npm run format:tools",
|
|
"format:engine": "npm run lint:engine -- --fix",
|
|
"format:libs": "npm run lint:libs -- --fix",
|
|
"format:modules": "npm run lint:modules -- --fix",
|
|
"format:tools": "npm run lint:tools -- --fix"
|
|
},
|
|
"author": "Godot Engine contributors",
|
|
"license": "MIT",
|
|
"devDependencies": {
|
|
"eslint": "^7.9.0",
|
|
"eslint-config-airbnb-base": "^14.2.0",
|
|
"eslint-plugin-import": "^2.22.0",
|
|
"jsdoc": "^3.6.6"
|
|
}
|
|
}
|