diff --git a/CHANGES.md b/CHANGES.md index 7adfc407..f754e43d 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,10 +1,14 @@ # SVG-Edit CHANGES -## ? +## 5.0.0 +- Breaking change: Switch from deprecated `@babel/polyfill` to + `core-js-bundle` and `regenerator-runtime` replacements +- Build: Require Node 8.5 - Fix: Ensure PHP files are present in `dist/extensions` alongside JavaScript extension files using them -- Fix: Bug in obtaining `extPath` in ext-server_opensave.js +- Fix: Bug in obtaining `extPath` in `ext-server_opensave.js` +- Fix: Fully redirect extension entrances for lacking browser support - Enhancement: Add config `avoidClientSide` to avoid using client-side support by default (and always require server) - Enhancement: Return a Promise for Editor's `setCustomHandlers`, @@ -14,13 +18,15 @@ Closure syntax; reenable `jsdoc/valid-jsdoc` as fixed; notes re: valid-jsdoc replacement; use same namepath - Linting: Update per ash-nazg/plugin-node update +- Docs: Simplify comments in HTML files re: script purposes +- Docs: Update release instructions - Docs (Refactoring): Formally specify `Promise` resolve type; add `typedef` for dialog result object; add an `ArbitraryCallbackResult` type; prefer `void` -- Build: Require Node 8.5 -- npm: Rename `build-doc` to `build-docs`; add `open-docs` script -- npm: Update devDeps (and our @babel/polyfill copy) -- npm: Remove unused devDeps +- npm: Rename (`build-doc` to `build-docs`, `types-doc` to + `types-docs`); add `open-docs` script +- npm: Update devDeps +- npm: Remove unused devDeps; update insecure devDeps ## 4.3.0 diff --git a/README.md b/README.md index 30bea629..2e137b57 100644 --- a/README.md +++ b/README.md @@ -118,6 +118,7 @@ incorporating SVGEdit. ## Recent news +- 2019-05-07 Published 5.0.0 Change from `@babel/polyfill` - 2019-04-03 Published 4.3.0 Fix for double click on gradient picker droplets affecting some browsers and dragging control point of arc. Other misc. fixes. Some accessibility and i18n. diff --git a/docs/ReleaseInstructions.md b/docs/ReleaseInstructions.md index 0cfe6594..5c3ab352 100644 --- a/docs/ReleaseInstructions.md +++ b/docs/ReleaseInstructions.md @@ -3,12 +3,12 @@ ## Prepare 1. `npm run browser-test` - Ensure build steps occur and tests are passing -1. `npm test` - This should also be run, though currently accessibility tests - are failing -1. `npm run build-doc` - Ensure JSDoc can build and is available for site +1. `npm start` and in another console window, `npm test` - This should + also be run, though currently accessibility tests are failing. +1. `npm run build-docs` - Ensure JSDoc can build and is available for site build (though not added to `master`, will be copied over in `gh-pages` steps and used in `npm publish` step). -1. `npm run types-doc` - For JSDoc, we ensure that a minimum of generic types +1. `npm run types-docs` - For JSDoc, we ensure that a minimum of generic types have been added (e.g., "number" should instead be "Float" or "Array", and "object", "function", or "array" should be replaced by more specific `@interface`s, `@typdef`s, or `@callback`. Deriving types can use @@ -16,10 +16,8 @@ intentional. `*` should also be checked. The script reports all failing matches within `editor`. There should be none (there is currently one due to our needing to move the file to its own module). -1. `npm pack` to preview which files will be included once published and - taking into account `.npmignore`. Take care to remove the `.tgz` tarball - file that it creates so it is not itself included during the - publishing step. +1. `npm pack --dry-run` to preview which files will be included once + published and taking into account `.npmignore`. ## Update the main project . -1. Tag the version, prefixed by "v", e.g., `v4.0.1`. +1. Tag the version, prefixed by "v", e.g., `v5.0.1`. The above steps can be done on a fork and committed via a pull request. diff --git a/docs/versions/4.0.0.md b/docs/versions/4.0.0.md index 9b0281db..6f6c3cc7 100644 --- a/docs/versions/4.0.0.md +++ b/docs/versions/4.0.0.md @@ -8,7 +8,7 @@ Some API changes also involve switching to class methods over instance methods, though these were private/internally used APIs. Please see the CHANGES file (or the Git history or Github tracker) for -fixes and enhancements. +more fixes and enhancements. ## Breaking changes diff --git a/docs/versions/5.0.0.md b/docs/versions/5.0.0.md new file mode 100644 index 00000000..8e911fc6 --- /dev/null +++ b/docs/versions/5.0.0.md @@ -0,0 +1,17 @@ +# Version 5.0.0 + +This release should require minimal updating. + +Contains a few fixes for PHP-related extensions. + +Please see the CHANGES file (or the Git history or Github tracker) for +more fixes and enhancements. + +## Breaking changes + +- The HTML files have switched from the now deprecated `@babel/polyfill` + to `core-js-bundle` and `regenerator-runtime` replacements. If you + have not modified the HTML and are updating via npm, this change + should have no effect. (`@babel/polyfill` is still required through + some of the dependencies, but this is expected to eventually change.) +- If you are running build files, you will now need at least Node 8.5 diff --git a/editor/extensions/imagelib/index-es.html b/editor/extensions/imagelib/index-es.html index f9fe82e0..420fe50b 100644 --- a/editor/extensions/imagelib/index-es.html +++ b/editor/extensions/imagelib/index-es.html @@ -3,10 +3,19 @@