Преглед изворни кода

Other: This package was renamed from `@ckeditor/ckeditor-presets` to `@ckeditor/ckeditor5-essentials`. The `Article` preset was removed. Caloses #1.

BREAKING CHANGE: This package was renamed to `@ckeditor/ckeditor5-essentials`.

BREAKING CHANGE: The `Article` presets was removed.
Piotrek Koszuliński пре 8 година
родитељ
комит
e4f69416f7

+ 7 - 7
packages/ckeditor5-essentials/CHANGELOG.md

@@ -1,28 +1,28 @@
 Changelog
 =========
 
-## [0.3.0](https://github.com/ckeditor/ckeditor5-presets/compare/v0.2.2...v0.3.0) (2017-09-03)
+## [0.3.0](https://github.com/ckeditor/ckeditor5-essentials/compare/v0.2.2...v0.3.0) (2017-09-03)
 
 ### Features
 
-* Added the autoformat feature to the article preset. ([cb65328](https://github.com/ckeditor/ckeditor5-presets/commit/cb65328))
+* Added the autoformat feature to the article preset. ([cb65328](https://github.com/ckeditor/ckeditor5-essentials/commit/cb65328))
 
 
-## [0.2.2](https://github.com/ckeditor/ckeditor5-presets/compare/v0.2.1...v0.2.2) (2017-05-07)
+## [0.2.2](https://github.com/ckeditor/ckeditor5-essentials/compare/v0.2.1...v0.2.2) (2017-05-07)
 
 Internal changes only (updated dependencies, documentation, etc.).
 
-## [0.2.1](https://github.com/ckeditor/ckeditor5-presets/compare/v0.2.0...v0.2.1) (2017-04-06)
+## [0.2.1](https://github.com/ckeditor/ckeditor5-essentials/compare/v0.2.0...v0.2.1) (2017-04-06)
 
 Internal changes only (updated dependencies, documentation, etc.).
 
-## [0.2.0](https://github.com/ckeditor/ckeditor5-presets/compare/v0.1.1...v0.2.0) (2017-04-05)
+## [0.2.0](https://github.com/ckeditor/ckeditor5-essentials/compare/v0.1.1...v0.2.0) (2017-04-05)
 
 ### Features
 
-* Added block quote feature to the article preset. Closes [#4](https://github.com/ckeditor/ckeditor5-presets/issues/4). ([30d7bd5](https://github.com/ckeditor/ckeditor5-presets/commit/30d7bd5))
+* Added block quote feature to the article preset. Closes [#4](https://github.com/ckeditor/ckeditor5-essentials/issues/4). ([30d7bd5](https://github.com/ckeditor/ckeditor5-essentials/commit/30d7bd5))
 
 
-## [0.1.1](https://github.com/ckeditor/ckeditor5-presets/compare/v0.1.0...v0.1.1) (2017-03-06)
+## [0.1.1](https://github.com/ckeditor/ckeditor5-essentials/compare/v0.1.0...v0.1.1) (2017-03-06)
 
 Initial release.

+ 1 - 1
packages/ckeditor5-essentials/LICENSE.md

@@ -1,7 +1,7 @@
 Software License Agreement
 ==========================
 
-**CKEditor 5 Plugin Presets** – https://github.com/ckeditor/ckeditor5-presets <br>
+**CKEditor 5 essentials plugin** – https://github.com/ckeditor/ckeditor5-essentials <br>
 Copyright (c) 2003-2017, [CKSource](http://cksource.com) Frederico Knabben. All rights reserved.
 
 Licensed under the terms of any of the following licenses at your choice:

+ 16 - 7
packages/ckeditor5-essentials/README.md

@@ -1,14 +1,23 @@
-CKEditor 5 plugin presets
+CKEditor 5 essentials plugin
 ========================================
 
 [![Join the chat at https://gitter.im/ckeditor/ckeditor5](https://badges.gitter.im/ckeditor/ckeditor5.svg)](https://gitter.im/ckeditor/ckeditor5?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-presets.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-presets)
-[![Build Status](https://travis-ci.org/ckeditor/ckeditor5-presets.svg?branch=master)](https://travis-ci.org/ckeditor/ckeditor5-presets)
-[![Test Coverage](https://codeclimate.com/github/ckeditor/ckeditor5-presets/badges/coverage.svg)](https://codeclimate.com/github/ckeditor/ckeditor5-presets/coverage)
-[![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-presets/status.svg)](https://david-dm.org/ckeditor/ckeditor5-presets)
-[![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-presets/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-presets?type=dev)
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-essentials.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-essentials)
+[![Build Status](https://travis-ci.org/ckeditor/ckeditor5-essentials.svg?branch=master)](https://travis-ci.org/ckeditor/ckeditor5-essentials)
+[![Test Coverage](https://codeclimate.com/github/ckeditor/ckeditor5-essentials/badges/coverage.svg)](https://codeclimate.com/github/ckeditor/ckeditor5-essentials/coverage)
+[![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-essentials/status.svg)](https://david-dm.org/ckeditor/ckeditor5-essentials)
+[![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-essentials/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-essentials?type=dev)
 
-The presets of plugins for CKEditor 5. More information about the project can be found at the following URL: <https://github.com/ckeditor/ckeditor5-presets>.
+Essential editing features for CKEditor 5.
+
+The [`Essentials`](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/module_essentials_essentials-Essentials.html) plugin includes all essential editing features:
+
+* [Clipboard](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/module_clipboard_clipboard-Clipboard.html)
+* [`Enter`](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/module_enter_enter-Enter.html)
+* [`Typing`](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/module_typing_typing-Typing.html)
+* [`Undo`](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/module_undo_undo-Undo.html)
+
+More information about the project can be found at the following URL: <https://github.com/ckeditor/ckeditor5-essentials>.
 
 ## License
 

+ 4 - 4
packages/ckeditor5-essentials/package.json

@@ -1,7 +1,7 @@
 {
-  "name": "@ckeditor/ckeditor5-presets",
+  "name": "@ckeditor/ckeditor5-essentials",
   "version": "0.3.0",
-  "description": "The presets of plugins for CKEditor 5.",
+  "description": "Essential editing features for CKEditor 5.",
   "keywords": [],
   "dependencies": {
     "@ckeditor/ckeditor5-autoformat": "^0.6.0",
@@ -33,9 +33,9 @@
   "author": "CKSource (http://cksource.com/)",
   "license": "(GPL-2.0 OR LGPL-2.1 OR MPL-1.1)",
   "homepage": "https://ckeditor5.github.io",
-  "bugs": "https://github.com/ckeditor/ckeditor5-presets/issues",
+  "bugs": "https://github.com/ckeditor/ckeditor5-essentials/issues",
   "repository": {
     "type": "git",
-    "url": "https://github.com/ckeditor/ckeditor5-presets.git"
+    "url": "https://github.com/ckeditor/ckeditor5-essentials.git"
   }
 }

+ 4 - 5
packages/ckeditor5-essentials/src/essentials.js

@@ -4,7 +4,7 @@
  */
 
 /**
- * @module presets/essentials
+ * @module essentials/essentials
  */
 
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
@@ -15,7 +15,7 @@ import Typing from '@ckeditor/ckeditor5-typing/src/typing';
 import Undo from '@ckeditor/ckeditor5-undo/src/undo';
 
 /**
- * Essential editing features preset. Represents a set of features that enables similar functionalities
+ * A plugin including all essential editing features. It represents a set of features that enables similar functionalities
  * to a `<textarea>` element.
  *
  * It includes:
@@ -25,9 +25,8 @@ import Undo from '@ckeditor/ckeditor5-undo/src/undo';
  * * {@link module:typing/typing~Typing},
  * * {@link module:undo/undo~Undo}.
  *
- * This preset does not define any block-level containers (such as {@link module:paragraph/paragraph~Paragraph}).
- * If your editor is supposed to handle block content, make sure to include it. You can also inlcude
- * the {@link module:presets/article~Article article preset}.
+ * This plugin set does not define any block-level containers (such as {@link module:paragraph/paragraph~Paragraph}).
+ * If your editor is supposed to handle block content, make sure to include it.
  *
  * @extends module:core/plugin~Plugin
  */

+ 3 - 3
packages/ckeditor5-essentials/tests/essentials.js

@@ -5,7 +5,7 @@
 
 /* global document */
 
-import EssentialsPreset from '../src/essentials';
+import Essentials from '../src/essentials';
 import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
 
 import Clipboard from '@ckeditor/ckeditor5-clipboard/src/clipboard';
@@ -20,7 +20,7 @@ describe( 'Essentials preset', () => {
 		editorElement = document.createElement( 'div' );
 		document.body.appendChild( editorElement );
 
-		return ClassicTestEditor.create( editorElement, { plugins: [ EssentialsPreset ] } )
+		return ClassicTestEditor.create( editorElement, { plugins: [ Essentials ] } )
 			.then( newEditor => {
 				editor = newEditor;
 			} );
@@ -33,7 +33,7 @@ describe( 'Essentials preset', () => {
 	} );
 
 	it( 'should be loaded', () => {
-		expect( editor.plugins.get( EssentialsPreset ) ).to.be.instanceOf( EssentialsPreset );
+		expect( editor.plugins.get( Essentials ) ).to.be.instanceOf( Essentials );
 	} );
 
 	it( 'should load all its dependencies', () => {

+ 2 - 2
packages/ckeditor5-essentials/tests/manual/essentials.js

@@ -7,13 +7,13 @@
 
 import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor';
 
-import EssentialsPreset from '../../src/essentials';
+import Essentials from '../../src/essentials';
 import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
 
 // Note: We need to load paragraph because we don't have inline editors yet.
 ClassicEditor
 	.create( document.querySelector( '#editor' ), {
-		plugins: [ EssentialsPreset, Paragraph ],
+		plugins: [ Essentials, Paragraph ],
 		toolbar: [ 'undo', 'redo' ]
 	} )
 	.then( editor => {