From 6f8d45cda9f4ae3e388e7be02877ef5529daf33a Mon Sep 17 00:00:00 2001 From: Brett Zamir Date: Wed, 25 Dec 2019 16:06:44 +0800 Subject: [PATCH] - Docs: Remove outdated info on jsdoc linting (now just part of eslint config) - npm: Rename open script to open-tests, and add `open` script for opening instance of svgedit - npm: Ensure starting server for open scripts --- CHANGES.md | 4 ++++ docs/Linting.md | 12 ------------ package.json | 7 ++++--- 3 files changed, 8 insertions(+), 15 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index abbb6968..1298dc4f 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -19,6 +19,10 @@ setup browser-bug folder and ui issues folder - Testing: Create test utilities for selecting English and visiting and approving storage +- Docs: Remove outdated info on jsdoc linting (now just part of eslint config) +- npm: Rename open script to open-tests, and add `open` script for opening + instance of svgedit +- npm: Ensure starting server for open scripts - npm: Fix scripts for Windows development (needed for building docs and instrumenting) - npm: Update scripts to reflect removal of `all_tests.html`; diff --git a/docs/Linting.md b/docs/Linting.md index ad1ce81f..79fec346 100644 --- a/docs/Linting.md +++ b/docs/Linting.md @@ -7,18 +7,6 @@ npm run eslint This will query both JavaScript files and will query JavaScript within Markdown files. It will also check for some JSDoc issues. -## JSDoc - -To check for JSDoc issues, besides the eslint script, one may run the -following to find any overly generic types in use (types should be as -specific as possible): - -``` -npm run types-doc -``` - -See also [ReleaseInstructions](./ReleaseInstructions.md). - ## Atom usage If using the Atom package `linter-eslint`, one may add `source.gfm` to the diff --git a/package.json b/package.json index b261e130..783795d4 100644 --- a/package.json +++ b/package.json @@ -15,7 +15,8 @@ "scripts": { "prepublishOnly": "npm run test-prep", "build-by-config": "rollup -c rollup-config.config.js", - "open-es-allext": "open-cli http://localhost:8000/editor/svg-editor-es.html?extensions=ext-arrows.js,ext-closepath.js,ext-foreignobject.js,ext-helloworld.js,ext-mathjax.js,ext-php_savefile.js,ext-server_moinsave.js,ext-server_opensave.js,ext-webappfind.js,ext-xdomain-messaging.js", + "open-es-allext": "open-cli http://localhost:8000/editor/svg-editor-es.html?extensions=ext-arrows.js,ext-closepath.js,ext-foreignobject.js,ext-helloworld.js,ext-mathjax.js,ext-php_savefile.js,ext-server_moinsave.js,ext-server_opensave.js,ext-webappfind.js,ext-xdomain-messaging.js && npm start", + "open": "open-cli http://localhost:8000/editor/svg-editor-es.html && npm start", "build-docs-remove": "rimraf docs/jsdoc/*", "build-docs-create": "jsdoc --pedantic -c docs/jsdoc-config.js editor", "build-docs": "run-s -c build-docs-remove build-docs-create", @@ -31,7 +32,7 @@ "start": "echo \"Open file, e.g., to http://localhost:8000/editor/svg-editor-es.html\" && static -p 8000", "cypress:open": "cypress open", "cypress:run": "cypress run && npm run coverage-badge", - "open-report": "open-cli http://localhost:8000/coverage/", + "open-report": "open-cli http://localhost:8000/coverage/ && npm start", "start-open-report": "run-p start open-report", "instrument:replace-html": "frs-replace \"../svgedit-config-es.js\" \"svgedit-config-es.js\" -i instrumented/svg-editor-es.html -o instrumented/svg-editor-es.html", "instrument:replace-js": "frs-replace \"editor/svg-editor.js\" \"svg-editor.js\" -i svgedit-config-es.js -o instrumented/svgedit-config-es.js", @@ -40,7 +41,7 @@ "instrument": "rimraf instrumented && npx nyc instrument editor instrumented && npm run copy-instrumented", "coverage-badge": "coveradge badges/coverage-badge", "open-cov": "npm-run-all instrument --parallel --race start cypress:open", - "open": "run-p start cypress:open", + "open-tests": "run-p start cypress:open", "report": "npx nyc report", "report-summary": "npx nyc report --reporter=text-summary", "test-cov-prereport": "npm-run-all instrument --parallel --race start cypress:run",