From 81ff39443660768d65347f919865a8666dfbe5b3 Mon Sep 17 00:00:00 2001 From: Peter Savchenko Date: Tue, 18 Dec 2018 23:10:47 +0300 Subject: [PATCH 1/5] Changelog added --- README.md | 36 +++++++++++++++++++++++++----------- docs/changelog.md | 39 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 64 insertions(+), 11 deletions(-) create mode 100644 docs/changelog.md diff --git a/README.md b/README.md index 82356cede..a79fe3ef9 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,31 @@ We are glad to introduce the next version of CodeX Editor. Totally new core, str Welcome to testing stage. Please, join a [public Telegram-chat](//t.me/codex_editor) where you always find a support. -### 2.1-beta changelog - -- `New` *Tools API* — support pasted content via drag-n-drop or from the Buffer. See [documentation](https://github.com/codex-team/codex.editor/blob/master/docs/tools.md#paste-handling) and [example](https://github.com/codex-editor/simple-image/blob/master/src/index.js#L177) at the Simple Image Tool. -- `New` *Tools API* — new `sanitize` getter for Tools for automatic HTML sanitizing of returned data. See [documentation](https://github.com/codex-team/codex.editor/blob/master/docs/tools.md#sanitize) and [example](https://github.com/codex-editor/paragraph/blob/master/src/index.js#L121) at the Paragraph Tool -- `New` Added `onChange`-callback, fired after any modifications at the Editor. See [documentation](https://github.com/codex-team/codex.editor/blob/master/docs/installation.md#features). -- `New` New Inline Tool example — [Marker](https://github.com/codex-editor/marker) -- `New` New Inline Tool example — [Code](https://github.com/codex-editor/code) -- `New` New [CodeX Editor PHP](http://github.com/codex-team/codex.editor.backend) — example of server-side implementation with HTML purifying and data validation. -- `Improvements` - Improvements of Toolbar's position calculation. -- `Improvements` — Improved zero-configuration initialization. -- and many little improvements. +### 2.2—2.7 changelog + +- `New` *Sanitize API* — [Sanitize Config](https://github.com/codex-team/codex.editor/blob/master/docs/tools.md#automatic-sanitize) of `Block Tools` now automatically extends by tags of `Inline Tools` that is enabled by current Tool by `inlineToolbar` option. You don't need more to specify `a, b, mark, code` manually. This feature will be added to fields that supports inline markup. +- `New` *Block Selection* — Ability to select Block by `CMD+A`, and the whole Editor by secondary `CMD+A`. After that, you can copy (`CMD+C`), remove(`Backspace`)or clear (`Enter`) selected Blocks. +- `New` *[Styles API](https://github.com/codex-team/codex.editor/blob/master/types/api/styles.d.ts)* — Added `button` class for stylization of any buttons provided by Tools with one unified style. +- `New` *[Notifier API](https://github.com/codex-team/codex.editor/blob/master/docs/api.md#notifierapi)* — methods for showing user notifications: on success, errors, warnings, etc. +- `New` *Block Tool* — [Table](http://github.com/codex-editor/table) constructor 💪 +- `New` If one of Tools is unavailable on Editor initialization with saved data, its Blocks will be rendered with *Dummy Block*, describing that user can not edit content of this Block. Dummy Blocks can be moved, removed and saved as normal Blocks. So saved data won't be lost if one of Tools will failed +- `New` [Public TS-types](https://github.com/codex-team/codex.editor/tree/master/types) are presented. +- `Changes` *Tools API* — options `irreplaceable` and `contentless` was removed. +- `Changes` *Tools API* — [Paste API](https://github.com/codex-team/codex.editor/blob/master/docs/tools.md#paste-handling): tags, patterns and mime-types now should be specified by Tool's `pasteConfig` static property. Custom Paste Event should be handled by `onPaste(event)` that should not be static from now. +- `Changes` *Tools API* — options `displayInToolbox ` and `toolboxIcon` was removed. Use [`toolbox`](https://github.com/codex-team/codex.editor/blob/master/docs/tools.md#internal-tool-settings) instead, that should return object with `icon` and `title` field, or `false` if Tool should not be placed at the Toolbox. Also, there are a way to override `toolbox {icon, title}` settings provided by Tool with you own settings at the Initial Config. +- `Improvements` — All Projects code now on TypeScript +- `Improvements` — NPM package size decreased from 1300kb to 422kb +- `Improvements` — Bundle size decreased from 438kb to 252kb +- `Improvements` — `Inline Toolbar`: when you add a Link to the selected fragment, Editor will highlight this fragment event when Caret will be placed into the URL-input. +- `Improvements` — Block Settings won't be showed near empty Blocks of `initialType`. You should click on them instead. +- `Improvements` — `onChange`-callback now will fired event on children attributes changing. +- `Improvements` — Logging improved: now all Editor's logs will be preceded by beautiful label with current Editor version. +- `Improvements` — Internal `isEmpty` checking was improved for Blocks with many children nodes (200 and more) +- `Improvements` — Paste improvements: tags that can be substituted by Tool now will matched even on deep-level of pasted DOM three. +- `Improvements` — There is no more «unavailable» sound on copying Block by `CMD+C` on macOS +- `Improvements` — Dozens of bugfixes and small improvements + +See a whole [Changelog](/docs/changelog.md) ## Documentation diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 000000000..45875acc7 --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,39 @@ +# Changelog + +### 2.2—2.7 changelog + +- `New` *Sanitize API* — [Sanitize Config](https://github.com/codex-team/codex.editor/blob/master/docs/tools.md#automatic-sanitize) of `Block Tools` now automatically extends by tags of `Inline Tools` that is enabled by current Tool by `inlineToolbar` option. You don't need more to specify `a, b, mark, code` manually. This feature will be added to fields that supports inline markup. +- `New` *Block Selection* — Ability to select Block by `CMD+A`, and the whole Editor by secondary `CMD+A`. After that, you can copy (`CMD+C`), remove(`Backspace`)or clear (`Enter`) selected Blocks. +- `New` *[Styles API](https://github.com/codex-team/codex.editor/blob/master/types/api/styles.d.ts)* — Added `button` class for stylization of any buttons provided by Tools with one unified style. +- `New` *[Notifier API](https://github.com/codex-team/codex.editor/blob/master/docs/api.md#notifierapi)* — methods for showing user notifications: on success, errors, warnings, etc. +- `New` *Block Tool* — [Table](http://github.com/codex-editor/table) constructor 💪 +- `New` If one of Tools is unavailable on Editor initialization with saved data, its Blocks will be rendered with *Dummy Block*, describing that user can not edit content of this Block. Dummy Blocks can be moved, removed and saved as normal Blocks. So saved data won't be lost if one of Tools will failed +- `New` [Public TS-types](https://github.com/codex-team/codex.editor/tree/master/types) are presented. +- `Changes` *Tools API* — options `irreplaceable` and `contentless` was removed. +- `Changes` *Tools API* — [Paste API](https://github.com/codex-team/codex.editor/blob/master/docs/tools.md#paste-handling): tags, patterns and mime-types now should be specified by Tool's `pasteConfig` static property. Custom Paste Event should be handled by `onPaste(event)` that should not be static from now. +- `Changes` *Tools API* — options `displayInToolbox ` and `toolboxIcon` was removed. Use [`toolbox`](https://github.com/codex-team/codex.editor/blob/master/docs/tools.md#internal-tool-settings) instead, that should return object with `icon` and `title` field, or `false` if Tool should not be placed at the Toolbox. Also, there are a way to override `toolbox {icon, title}` settings provided by Tool with you own settings at the Initial Config. +- `Improvements` — All Projects code now on TypeScript +- `Improvements` — NPM package size decreased from 1300kb to 422kb +- `Improvements` — Bundle size decreased from 438kb to 252kb +- `Improvements` — `Inline Toolbar`: when you add a Link to the selected fragment, Editor will highlight this fragment event when Caret will be placed into the URL-input. +- `Improvements` — Block Settings won't be showed near empty Blocks of `initialType`. You should click on them instead. +- `Improvements` — `onChange`-callback now will fired event on children attributes changing. +- `Improvements` — Logging improved: now all Editor's logs will be preceded by beautiful label with current Editor version. +- `Improvements` — Internal `isEmpty` checking was improved for Blocks with many children nodes (200 and more) +- `Improvements` — Paste improvements: tags that can be substituted by Tool now will matched even on deep-level of pasted DOM three. +- `Improvements` — There is no more «unavailable» sound on copying Block by `CMD+C` on macOS +- `Improvements` — Dozens of bugfixes and small improvements + +See a whole [Changelog](/docs/) + +### 2.1-beta changelog + +- `New` *Tools API* — support pasted content via drag-n-drop or from the Buffer. See [documentation](https://github.com/codex-team/codex.editor/blob/master/docs/tools.md#paste-handling) and [example](https://github.com/codex-editor/simple-image/blob/master/src/index.js#L177) at the Simple Image Tool. +- `New` *Tools API* — new `sanitize` getter for Tools for automatic HTML sanitizing of returned data. See [documentation](https://github.com/codex-team/codex.editor/blob/master/docs/tools.md#sanitize) and [example](https://github.com/codex-editor/paragraph/blob/master/src/index.js#L121) at the Paragraph Tool +- `New` Added `onChange`-callback, fired after any modifications at the Editor. See [documentation](https://github.com/codex-team/codex.editor/blob/master/docs/installation.md#features). +- `New` New Inline Tool example — [Marker](https://github.com/codex-editor/marker) +- `New` New Inline Tool example — [Code](https://github.com/codex-editor/code) +- `New` New [CodeX Editor PHP](http://github.com/codex-team/codex.editor.backend) — example of server-side implementation with HTML purifying and data validation. +- `Improvements` - Improvements of Toolbar's position calculation. +- `Improvements` — Improved zero-configuration initialization. +- and many little improvements. From 7106ca4e0a0b4a1866523a063915e4886b3b2b28 Mon Sep 17 00:00:00 2001 From: Peter Savchenko Date: Tue, 18 Dec 2018 23:13:15 +0300 Subject: [PATCH 2/5] note about html janitor --- README.md | 1 + docs/changelog.md | 1 + 2 files changed, 2 insertions(+) diff --git a/README.md b/README.md index a79fe3ef9..3719356f8 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ Welcome to testing stage. Please, join a [public Telegram-chat](//t.me/codex_edi - `Improvements` — `Inline Toolbar`: when you add a Link to the selected fragment, Editor will highlight this fragment event when Caret will be placed into the URL-input. - `Improvements` — Block Settings won't be showed near empty Blocks of `initialType`. You should click on them instead. - `Improvements` — `onChange`-callback now will fired event on children attributes changing. +- `Improvements` — HTMLJantior package was updated due to found vulnerability - `Improvements` — Logging improved: now all Editor's logs will be preceded by beautiful label with current Editor version. - `Improvements` — Internal `isEmpty` checking was improved for Blocks with many children nodes (200 and more) - `Improvements` — Paste improvements: tags that can be substituted by Tool now will matched even on deep-level of pasted DOM three. diff --git a/docs/changelog.md b/docs/changelog.md index 45875acc7..977d48b25 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -18,6 +18,7 @@ - `Improvements` — `Inline Toolbar`: when you add a Link to the selected fragment, Editor will highlight this fragment event when Caret will be placed into the URL-input. - `Improvements` — Block Settings won't be showed near empty Blocks of `initialType`. You should click on them instead. - `Improvements` — `onChange`-callback now will fired event on children attributes changing. +- `Improvements` — HTMLJantior package was updated due to found vulnerability - `Improvements` — Logging improved: now all Editor's logs will be preceded by beautiful label with current Editor version. - `Improvements` — Internal `isEmpty` checking was improved for Blocks with many children nodes (200 and more) - `Improvements` — Paste improvements: tags that can be substituted by Tool now will matched even on deep-level of pasted DOM three. From 57aa8251a450db731e2e31cfdfd8b7bc9d0e2459 Mon Sep 17 00:00:00 2001 From: Peter Savchenko Date: Wed, 19 Dec 2018 14:45:05 +0300 Subject: [PATCH 3/5] update changelog --- README.md | 10 +++++----- docs/changelog.md | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3719356f8..a770fc1b3 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,11 @@ Welcome to testing stage. Please, join a [public Telegram-chat](//t.me/codex_edi ### 2.2—2.7 changelog - `New` *Sanitize API* — [Sanitize Config](https://github.com/codex-team/codex.editor/blob/master/docs/tools.md#automatic-sanitize) of `Block Tools` now automatically extends by tags of `Inline Tools` that is enabled by current Tool by `inlineToolbar` option. You don't need more to specify `a, b, mark, code` manually. This feature will be added to fields that supports inline markup. -- `New` *Block Selection* — Ability to select Block by `CMD+A`, and the whole Editor by secondary `CMD+A`. After that, you can copy (`CMD+C`), remove(`Backspace`)or clear (`Enter`) selected Blocks. +- `New` *Block Selection* — Ability to select Block by `CMD+A`, and the whole Editor by double `CMD+A`. After that, you can copy (`CMD+C`), remove (`Backspace`) or clear (`Enter`) selected Blocks. - `New` *[Styles API](https://github.com/codex-team/codex.editor/blob/master/types/api/styles.d.ts)* — Added `button` class for stylization of any buttons provided by Tools with one unified style. - `New` *[Notifier API](https://github.com/codex-team/codex.editor/blob/master/docs/api.md#notifierapi)* — methods for showing user notifications: on success, errors, warnings, etc. - `New` *Block Tool* — [Table](http://github.com/codex-editor/table) constructor 💪 -- `New` If one of Tools is unavailable on Editor initialization with saved data, its Blocks will be rendered with *Dummy Block*, describing that user can not edit content of this Block. Dummy Blocks can be moved, removed and saved as normal Blocks. So saved data won't be lost if one of Tools will failed +- `New` If one of the Tools is unavailable on Editor initialization, its Blocks will be rendered with *Dummy Block*, describing that user can not edit content of this Block. Dummy Blocks can be moved, removed and saved as normal Blocks. So saved data won't be lost if one of the Tools is failed - `New` [Public TS-types](https://github.com/codex-team/codex.editor/tree/master/types) are presented. - `Changes` *Tools API* — options `irreplaceable` and `contentless` was removed. - `Changes` *Tools API* — [Paste API](https://github.com/codex-team/codex.editor/blob/master/docs/tools.md#paste-handling): tags, patterns and mime-types now should be specified by Tool's `pasteConfig` static property. Custom Paste Event should be handled by `onPaste(event)` that should not be static from now. @@ -23,9 +23,9 @@ Welcome to testing stage. Please, join a [public Telegram-chat](//t.me/codex_edi - `Improvements` — All Projects code now on TypeScript - `Improvements` — NPM package size decreased from 1300kb to 422kb - `Improvements` — Bundle size decreased from 438kb to 252kb -- `Improvements` — `Inline Toolbar`: when you add a Link to the selected fragment, Editor will highlight this fragment event when Caret will be placed into the URL-input. -- `Improvements` — Block Settings won't be showed near empty Blocks of `initialType`. You should click on them instead. -- `Improvements` — `onChange`-callback now will fired event on children attributes changing. +- `Improvements` — `Inline Toolbar`: when you add a Link to the selected fragment, Editor will highlight this fragment even when Caret will be placed into the URL-input. +- `Improvements` — Block Settings won't be shown near empty Blocks of `initialType` by default. You should click on them instead. +- `Improvements` — `onChange`-callback now will be fired even with children attributes changing. - `Improvements` — HTMLJantior package was updated due to found vulnerability - `Improvements` — Logging improved: now all Editor's logs will be preceded by beautiful label with current Editor version. - `Improvements` — Internal `isEmpty` checking was improved for Blocks with many children nodes (200 and more) diff --git a/docs/changelog.md b/docs/changelog.md index 977d48b25..49ef5daea 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -3,11 +3,11 @@ ### 2.2—2.7 changelog - `New` *Sanitize API* — [Sanitize Config](https://github.com/codex-team/codex.editor/blob/master/docs/tools.md#automatic-sanitize) of `Block Tools` now automatically extends by tags of `Inline Tools` that is enabled by current Tool by `inlineToolbar` option. You don't need more to specify `a, b, mark, code` manually. This feature will be added to fields that supports inline markup. -- `New` *Block Selection* — Ability to select Block by `CMD+A`, and the whole Editor by secondary `CMD+A`. After that, you can copy (`CMD+C`), remove(`Backspace`)or clear (`Enter`) selected Blocks. +- `New` *Block Selection* — Ability to select Block by `CMD+A`, and the whole Editor by double `CMD+A`. After that, you can copy (`CMD+C`), remove (`Backspace`) or clear (`Enter`) selected Blocks. - `New` *[Styles API](https://github.com/codex-team/codex.editor/blob/master/types/api/styles.d.ts)* — Added `button` class for stylization of any buttons provided by Tools with one unified style. - `New` *[Notifier API](https://github.com/codex-team/codex.editor/blob/master/docs/api.md#notifierapi)* — methods for showing user notifications: on success, errors, warnings, etc. - `New` *Block Tool* — [Table](http://github.com/codex-editor/table) constructor 💪 -- `New` If one of Tools is unavailable on Editor initialization with saved data, its Blocks will be rendered with *Dummy Block*, describing that user can not edit content of this Block. Dummy Blocks can be moved, removed and saved as normal Blocks. So saved data won't be lost if one of Tools will failed +- `New` If one of the Tools is unavailable on Editor initialization, its Blocks will be rendered with *Dummy Block*, describing that user can not edit content of this Block. Dummy Blocks can be moved, removed and saved as normal Blocks. So saved data won't be lost if one of the Tools is failed - `New` [Public TS-types](https://github.com/codex-team/codex.editor/tree/master/types) are presented. - `Changes` *Tools API* — options `irreplaceable` and `contentless` was removed. - `Changes` *Tools API* — [Paste API](https://github.com/codex-team/codex.editor/blob/master/docs/tools.md#paste-handling): tags, patterns and mime-types now should be specified by Tool's `pasteConfig` static property. Custom Paste Event should be handled by `onPaste(event)` that should not be static from now. @@ -15,9 +15,9 @@ - `Improvements` — All Projects code now on TypeScript - `Improvements` — NPM package size decreased from 1300kb to 422kb - `Improvements` — Bundle size decreased from 438kb to 252kb -- `Improvements` — `Inline Toolbar`: when you add a Link to the selected fragment, Editor will highlight this fragment event when Caret will be placed into the URL-input. -- `Improvements` — Block Settings won't be showed near empty Blocks of `initialType`. You should click on them instead. -- `Improvements` — `onChange`-callback now will fired event on children attributes changing. +- `Improvements` — `Inline Toolbar`: when you add a Link to the selected fragment, Editor will highlight this fragment even when Caret will be placed into the URL-input. +- `Improvements` — Block Settings won't be shown near empty Blocks of `initialType` by default. You should click on them instead. +- `Improvements` — `onChange`-callback now will be fired even with children attributes changing. - `Improvements` — HTMLJantior package was updated due to found vulnerability - `Improvements` — Logging improved: now all Editor's logs will be preceded by beautiful label with current Editor version. - `Improvements` — Internal `isEmpty` checking was improved for Blocks with many children nodes (200 and more) From 0f64440806059a8fdd2218084c2fc3fd3d5ed83c Mon Sep 17 00:00:00 2001 From: Peter Savchenko Date: Wed, 19 Dec 2018 14:45:32 +0300 Subject: [PATCH 4/5] update patch --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index efc3164c2..65448dd6a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "codex.editor", - "version": "2.7.12", + "version": "2.7.13", "description": "CodeX Editor. Native JS, based on API and Open Source", "main": "dist/codex-editor.js", "types": "./types/index.d.ts", From 40ec335da374d283509bdf2389354c930806a686 Mon Sep 17 00:00:00 2001 From: Peter Savchenko Date: Wed, 19 Dec 2018 14:51:12 +0300 Subject: [PATCH 5/5] even --- README.md | 4 ++-- docs/{changelog.md => CHANGELOG.md} | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) rename docs/{changelog.md => CHANGELOG.md} (99%) diff --git a/README.md b/README.md index a770fc1b3..d31f57bd1 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Welcome to testing stage. Please, join a [public Telegram-chat](//t.me/codex_edi - `Improvements` — All Projects code now on TypeScript - `Improvements` — NPM package size decreased from 1300kb to 422kb - `Improvements` — Bundle size decreased from 438kb to 252kb -- `Improvements` — `Inline Toolbar`: when you add a Link to the selected fragment, Editor will highlight this fragment even when Caret will be placed into the URL-input. +- `Improvements` — `Inline Toolbar`: when you add a Link to the selected fragment, Editor will highlight this fragment even when Caret is placed into the URL-input. - `Improvements` — Block Settings won't be shown near empty Blocks of `initialType` by default. You should click on them instead. - `Improvements` — `onChange`-callback now will be fired even with children attributes changing. - `Improvements` — HTMLJantior package was updated due to found vulnerability @@ -33,7 +33,7 @@ Welcome to testing stage. Please, join a [public Telegram-chat](//t.me/codex_edi - `Improvements` — There is no more «unavailable» sound on copying Block by `CMD+C` on macOS - `Improvements` — Dozens of bugfixes and small improvements -See a whole [Changelog](/docs/changelog.md) +See a whole [Changelog](/docs/CHANGELOG.md) ## Documentation diff --git a/docs/changelog.md b/docs/CHANGELOG.md similarity index 99% rename from docs/changelog.md rename to docs/CHANGELOG.md index 49ef5daea..cb75ca464 100644 --- a/docs/changelog.md +++ b/docs/CHANGELOG.md @@ -15,7 +15,7 @@ - `Improvements` — All Projects code now on TypeScript - `Improvements` — NPM package size decreased from 1300kb to 422kb - `Improvements` — Bundle size decreased from 438kb to 252kb -- `Improvements` — `Inline Toolbar`: when you add a Link to the selected fragment, Editor will highlight this fragment even when Caret will be placed into the URL-input. +- `Improvements` — `Inline Toolbar`: when you add a Link to the selected fragment, Editor will highlight this fragment even when Caret is placed into the URL-input. - `Improvements` — Block Settings won't be shown near empty Blocks of `initialType` by default. You should click on them instead. - `Improvements` — `onChange`-callback now will be fired even with children attributes changing. - `Improvements` — HTMLJantior package was updated due to found vulnerability