Skip to content

Commit

Permalink
- Breaking change: Switch from deprecated @babel/polyfill to
Browse files Browse the repository at this point in the history
    `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
  • Loading branch information
brettz9 committed May 7, 2019
1 parent 0f4b739 commit fc0c53f
Show file tree
Hide file tree
Showing 20 changed files with 1,019 additions and 7,334 deletions.
18 changes: 12 additions & 6 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -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`,
Expand All @@ -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

Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
16 changes: 7 additions & 9 deletions docs/ReleaseInstructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,21 @@
## 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
`PlainObject` or `GenericArray` to indicate the simple base type was
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
<!--
Expand All @@ -30,7 +28,7 @@
1. Add new release info to `Recent news` section in README
1. Commit these changes
<!-- with `git commit -m "Updating Makefile and CHANGES for release X.Y.Z"`-->.
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.

Expand Down
2 changes: 1 addition & 1 deletion docs/versions/4.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
17 changes: 17 additions & 0 deletions docs/versions/5.0.0.md
Original file line number Diff line number Diff line change
@@ -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
13 changes: 11 additions & 2 deletions editor/extensions/imagelib/index-es.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,19 @@
<head>
<meta charset="utf-8" />
<title>-</title>
<link rel="icon" type="image/png" href="../../images/logo.png"/>
<link rel="icon" type="image/png" href="../../images/logo.png" />

<!-- Lacking browser support -->
<script nomodule="" src="redirect-on-no-module-support.js"></script>
<script type="module" src="redirect-on-lacking-support.js"></script>

<!-- As yet no ES6 -->
<script src="../../jquery.min.js"></script>
<script src="../../external/@babel/polyfill/polyfill.min.js"></script>

<!-- ES6+ polyfills (Babel) -->
<script src="../../external/core-js-bundle/minified.js"></script>
<script src="../../external/regenerator-runtime/runtime.js"></script>

<script type="module" src="index.js"></script>
</head>
<body>
Expand Down
13 changes: 11 additions & 2 deletions editor/extensions/imagelib/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,19 @@
<head>
<meta charset="utf-8" />
<title>-</title>
<link rel="icon" type="image/png" href="../../images/logo.png"/>
<link rel="icon" type="image/png" href="../../images/logo.png" />

<!-- Lacking browser support -->

<script type="module" src="redirect-on-lacking-support.js"></script>

<!-- As yet no ES6 -->
<script src="../../jquery.min.js"></script>
<script src="../../external/@babel/polyfill/polyfill.min.js"></script>

<!-- ES6+ polyfills (Babel) -->
<script src="../../external/core-js-bundle/minified.js"></script>
<script src="../../external/regenerator-runtime/runtime.js"></script>

<script defer="defer" src="../../../dist/extensions/imagelib/index.js"></script>
</head>
<body>
Expand Down
15 changes: 12 additions & 3 deletions editor/extensions/imagelib/openclipart-es.html
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
<!DOCTYPE html>
<html lang="en" dir="ltr">
<head>
<meta charset="utf-8">
<meta charset="utf-8" />
<title>-</title>
<link rel="icon" type="image/png" href="../../images/logo.png"/>
<link rel="icon" type="image/png" href="../../images/logo.png" />

<!-- Lacking browser support -->
<script nomodule="" src="redirect-on-no-module-support.js"></script>
<script type="module" src="redirect-on-lacking-support.js"></script>

<!-- Browser polyfills -->
<script src="../../external/dom-polyfill/dom-polyfill.js"></script>
<script src="../../external/@babel/polyfill/polyfill.min.js"></script>

<!-- ES6+ polyfills (Babel) -->
<script src="../../external/core-js-bundle/minified.js"></script>
<script src="../../external/regenerator-runtime/runtime.js"></script>

<script type="module" src="openclipart.js"></script>
</head>
<body>
Expand Down
15 changes: 12 additions & 3 deletions editor/extensions/imagelib/openclipart.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,21 @@
<!-- AUTO-GENERATED FROM imagelib/openclipart-es.html; DO NOT EDIT; use build-html.js to build -->
<html lang="en" dir="ltr">
<head>
<meta charset="utf-8">
<meta charset="utf-8" />
<title>-</title>
<link rel="icon" type="image/png" href="../../images/logo.png"/>
<link rel="icon" type="image/png" href="../../images/logo.png" />

<!-- Lacking browser support -->

<script type="module" src="redirect-on-lacking-support.js"></script>

<!-- Browser polyfills -->
<script src="../../../dist/dom-polyfill.js"></script>
<script src="../../external/@babel/polyfill/polyfill.min.js"></script>

<!-- ES6+ polyfills (Babel) -->
<script src="../../external/core-js-bundle/minified.js"></script>
<script src="../../external/regenerator-runtime/runtime.js"></script>

<script defer="defer" src="../../../dist/extensions/imagelib/openclipart.js"></script>
</head>
<body>
Expand Down
Loading

0 comments on commit fc0c53f

Please sign in to comment.