Skip to content

Commit fc0c53f

Browse files
brettz9brettz9
committed
- Breaking change: Switch from deprecated @babel/polyfill to
 `core-js-bundle` and `regenerator-runtime` replacements - Fix: Fully redirect extension entrances for lacking browser support - Docs: Simplify comments in HTML files re: script purposes - Docs: Update release instructions - npm: Update devDeps (jsdoc, security audit) - npm: Bump to 5.0.0
1 parent 0f4b739 commit fc0c53f

20 files changed

+1019
-7334
lines changed

‎CHANGES.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
# SVG-Edit CHANGES
22

3-
## ?
3+
## 5.0.0
44

5+
- Breaking change: Switch from deprecated `@babel/polyfill` to
6+
`core-js-bundle` and `regenerator-runtime` replacements
7+
- Build: Require Node 8.5
58
- Fix: Ensure PHP files are present in `dist/extensions` alongside
69
JavaScript extension files using them
7-
- Fix: Bug in obtaining `extPath` in ext-server_opensave.js
10+
- Fix: Bug in obtaining `extPath` in `ext-server_opensave.js`
11+
- Fix: Fully redirect extension entrances for lacking browser support
812
- Enhancement: Add config `avoidClientSide` to avoid using
913
client-side support by default (and always require server)
1014
- Enhancement: Return a Promise for Editor's `setCustomHandlers`,
@@ -14,13 +18,15 @@
1418
Closure syntax; reenable `jsdoc/valid-jsdoc` as fixed; notes
1519
re: valid-jsdoc replacement; use same namepath
1620
- Linting: Update per ash-nazg/plugin-node update
21+
- Docs: Simplify comments in HTML files re: script purposes
22+
- Docs: Update release instructions
1723
- Docs (Refactoring): Formally specify `Promise` resolve type;
1824
add `typedef` for dialog result object; add an
1925
`ArbitraryCallbackResult` type; prefer `void`
20-
- Build: Require Node 8.5
21-
- npm: Rename `build-doc` to `build-docs`; add `open-docs` script
22-
- npm: Update devDeps (and our @babel/polyfill copy)
23-
- npm: Remove unused devDeps
26+
- npm: Rename (`build-doc` to `build-docs`, `types-doc` to
27+
`types-docs`); add `open-docs` script
28+
- npm: Update devDeps
29+
- npm: Remove unused devDeps; update insecure devDeps
2430

2531
## 4.3.0
2632

‎README.md

+1
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ incorporating SVGEdit.
118118

119119
## Recent news
120120

121+
- 2019-05-07 Published 5.0.0 Change from `@babel/polyfill`
121122
- 2019-04-03 Published 4.3.0 Fix for double click on gradient
122123
picker droplets affecting some browsers and dragging control
123124
point of arc. Other misc. fixes. Some accessibility and i18n.

‎docs/ReleaseInstructions.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,21 @@
33
## Prepare
44

55
1. `npm run browser-test` - Ensure build steps occur and tests are passing
6-
1. `npm test` - This should also be run, though currently accessibility tests
7-
are failing
8-
1. `npm run build-doc` - Ensure JSDoc can build and is available for site
6+
1. `npm start` and in another console window, `npm test` - This should
7+
also be run, though currently accessibility tests are failing.
8+
1. `npm run build-docs` - Ensure JSDoc can build and is available for site
99
build (though not added to `master`, will be copied over in `gh-pages`
1010
steps and used in `npm publish` step).
11-
1. `npm run types-doc` - For JSDoc, we ensure that a minimum of generic types
11+
1. `npm run types-docs` - For JSDoc, we ensure that a minimum of generic types
1212
have been added (e.g., "number" should instead be "Float" or "Array",
1313
and "object", "function", or "array" should be replaced by more specific
1414
`@interface`s, `@typdef`s, or `@callback`. Deriving types can use
1515
`PlainObject` or `GenericArray` to indicate the simple base type was
1616
intentional. `*` should also be checked. The script reports all failing
1717
matches within `editor`. There should be none (there is currently one
1818
due to our needing to move the file to its own module).
19-
1. `npm pack` to preview which files will be included once published and
20-
taking into account `.npmignore`. Take care to remove the `.tgz` tarball
21-
file that it creates so it is not itself included during the
22-
publishing step.
19+
1. `npm pack --dry-run` to preview which files will be included once
20+
published and taking into account `.npmignore`.
2321

2422
## Update the main project
2523
<!--
@@ -30,7 +28,7 @@
3028
1. Add new release info to `Recent news` section in README
3129
1. Commit these changes
3230
<!-- with `git commit -m "Updating Makefile and CHANGES for release X.Y.Z"`-->.
33-
1. Tag the version, prefixed by "v", e.g., `v4.0.1`.
31+
1. Tag the version, prefixed by "v", e.g., `v5.0.1`.
3432

3533
The above steps can be done on a fork and committed via a pull request.
3634

‎docs/versions/4.0.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Some API changes also involve switching to class methods over instance
88
methods, though these were private/internally used APIs.
99

1010
Please see the CHANGES file (or the Git history or Github tracker) for
11-
fixes and enhancements.
11+
more fixes and enhancements.
1212

1313
## Breaking changes
1414

‎docs/versions/5.0.0.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Version 5.0.0
2+
3+
This release should require minimal updating.
4+
5+
Contains a few fixes for PHP-related extensions.
6+
7+
Please see the CHANGES file (or the Git history or Github tracker) for
8+
more fixes and enhancements.
9+
10+
## Breaking changes
11+
12+
- The HTML files have switched from the now deprecated `@babel/polyfill`
13+
to `core-js-bundle` and `regenerator-runtime` replacements. If you
14+
have not modified the HTML and are updating via npm, this change
15+
should have no effect. (`@babel/polyfill` is still required through
16+
some of the dependencies, but this is expected to eventually change.)
17+
- If you are running build files, you will now need at least Node 8.5

‎editor/extensions/imagelib/index-es.html

+11-2
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,19 @@
33
<head>
44
<meta charset="utf-8" />
55
<title>-</title>
6-
<link rel="icon" type="image/png" href="../../images/logo.png"/>
6+
<link rel="icon" type="image/png" href="../../images/logo.png" />
7+
8+
<!-- Lacking browser support -->
79
<script nomodule="" src="redirect-on-no-module-support.js"></script>
10+
<script type="module" src="redirect-on-lacking-support.js"></script>
11+
12+
<!-- As yet no ES6 -->
813
<script src="../../jquery.min.js"></script>
9-
<script src="../../external/@babel/polyfill/polyfill.min.js"></script>
14+
15+
<!-- ES6+ polyfills (Babel) -->
16+
<script src="../../external/core-js-bundle/minified.js"></script>
17+
<script src="../../external/regenerator-runtime/runtime.js"></script>
18+
1019
<script type="module" src="index.js"></script>
1120
</head>
1221
<body>

‎editor/extensions/imagelib/index.html

+11-2
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,19 @@
44
<head>
55
<meta charset="utf-8" />
66
<title>-</title>
7-
<link rel="icon" type="image/png" href="../../images/logo.png"/>
7+
<link rel="icon" type="image/png" href="../../images/logo.png" />
8+
9+
<!-- Lacking browser support -->
810

11+
<script type="module" src="redirect-on-lacking-support.js"></script>
12+
13+
<!-- As yet no ES6 -->
914
<script src="../../jquery.min.js"></script>
10-
<script src="../../external/@babel/polyfill/polyfill.min.js"></script>
15+
16+
<!-- ES6+ polyfills (Babel) -->
17+
<script src="../../external/core-js-bundle/minified.js"></script>
18+
<script src="../../external/regenerator-runtime/runtime.js"></script>
19+
1120
<script defer="defer" src="../../../dist/extensions/imagelib/index.js"></script>
1221
</head>
1322
<body>

‎editor/extensions/imagelib/openclipart-es.html

+12-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
11
<!DOCTYPE html>
22
<html lang="en" dir="ltr">
33
<head>
4-
<meta charset="utf-8">
4+
<meta charset="utf-8" />
55
<title>-</title>
6-
<link rel="icon" type="image/png" href="../../images/logo.png"/>
6+
<link rel="icon" type="image/png" href="../../images/logo.png" />
7+
8+
<!-- Lacking browser support -->
79
<script nomodule="" src="redirect-on-no-module-support.js"></script>
10+
<script type="module" src="redirect-on-lacking-support.js"></script>
11+
12+
<!-- Browser polyfills -->
813
<script src="../../external/dom-polyfill/dom-polyfill.js"></script>
9-
<script src="../../external/@babel/polyfill/polyfill.min.js"></script>
14+
15+
<!-- ES6+ polyfills (Babel) -->
16+
<script src="../../external/core-js-bundle/minified.js"></script>
17+
<script src="../../external/regenerator-runtime/runtime.js"></script>
18+
1019
<script type="module" src="openclipart.js"></script>
1120
</head>
1221
<body>

‎editor/extensions/imagelib/openclipart.html

+12-3
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,21 @@
22
<!-- AUTO-GENERATED FROM imagelib/openclipart-es.html; DO NOT EDIT; use build-html.js to build -->
33
<html lang="en" dir="ltr">
44
<head>
5-
<meta charset="utf-8">
5+
<meta charset="utf-8" />
66
<title>-</title>
7-
<link rel="icon" type="image/png" href="../../images/logo.png"/>
7+
<link rel="icon" type="image/png" href="../../images/logo.png" />
8+
9+
<!-- Lacking browser support -->
810

11+
<script type="module" src="redirect-on-lacking-support.js"></script>
12+
13+
<!-- Browser polyfills -->
914
<script src="../../../dist/dom-polyfill.js"></script>
10-
<script src="../../external/@babel/polyfill/polyfill.min.js"></script>
15+
16+
<!-- ES6+ polyfills (Babel) -->
17+
<script src="../../external/core-js-bundle/minified.js"></script>
18+
<script src="../../external/regenerator-runtime/runtime.js"></script>
19+
1120
<script defer="defer" src="../../../dist/extensions/imagelib/openclipart.js"></script>
1221
</head>
1322
<body>

0 commit comments

Comments
 (0)