Browse Source

README update. eslint changes not included in last commit.

Alex Eckermann 7 years ago
parent
commit
eda27f5b32

+ 2 - 1
packages/ckeditor5-enter/README.md

@@ -10,7 +10,8 @@ CKEditor 5 Enter feature
 [![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-enter/status.svg)](https://david-dm.org/ckeditor/ckeditor5-enter)
 [![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-enter/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-enter?type=dev)
 
-This package implements the <kbd>Enter</kbd> key support for CKEditor 5.
+This package implements the <kbd>Enter</kbd> key support -- and optionally <kbd>Shift+Enter</kbd> soft breaks -- for CKEditor 5.
+
 
 ## Documentation
 

+ 2 - 5
packages/ckeditor5-enter/src/softbreakcommand.js

@@ -4,8 +4,6 @@
 
 import Command from '@ckeditor/ckeditor5-core/src/command';
 
-import Range from '@ckeditor/ckeditor5-engine/src/model/range';
-
 /**
  * Soft break command.
  *
@@ -78,8 +76,8 @@ function softBreakAction( model, writer, selection, schema ) {
 }
 
 function insertBreak( writer, selection, position ) {
-	let newBreak = writer.createElement( 'br' );
-	
+	const newBreak = writer.createElement( 'br' );
+
 	if ( position.isAtEnd ) {
 		// If the position is at the end of the element then insert the break at the end
 		writer.insert( newBreak, position, 'after' );
@@ -92,5 +90,4 @@ function insertBreak( writer, selection, position ) {
 		writer.insert( newBreak, position, 'end' );
 		writer.setSelection( newBreak, 'after' );
 	}
-	
 }

+ 1 - 14
packages/ckeditor5-enter/src/softbreakediting.js

@@ -4,18 +4,7 @@
 
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 
-// import {
-// 	viewFigureToModel,
-// 	modelToViewAttributeConverter,
-// 	srcsetAttributeConverter
-// } from './converters';
-
 import { downcastElementToElement } from '@ckeditor/ckeditor5-engine/src/conversion/downcast-converters';
-import { upcastElementToElement } from '@ckeditor/ckeditor5-engine/src/conversion/upcast-converters';
-
-import ViewPosition from '@ckeditor/ckeditor5-engine/src/view/position';
-
-// import SoftBreakCommand from './softbreakcommand';
 
 /**
  * The soft-break enter plugin.
@@ -31,7 +20,6 @@ export default class SoftBreakEditing extends Plugin {
 	init() {
 		const editor = this.editor;
 		const schema = editor.model.schema;
-		const t = editor.t;
 		const conversion = editor.conversion;
 
 		// Configure schema.
@@ -41,13 +29,12 @@ export default class SoftBreakEditing extends Plugin {
 			allowWhere: '$text'
 		} );
 
-		conversion.elementToElement( { model: 'br', view: 'br' } )
+		conversion.elementToElement( { model: 'br', view: 'br' } );
 
 		conversion.for( 'downcast' )
 			.add( downcastElementToElement( {
 				model: 'br',
 				view: ( modelElement, viewWriter ) => viewWriter.createEmptyElement( 'br' )
 			} ) );
-
 	}
 }

+ 6 - 6
packages/ckeditor5-enter/src/softbreakobserver.js

@@ -4,7 +4,7 @@
  */
 
 /**
- * @module enter/enterobserver
+ * @module enter/softbreakobserver
  */
 
 import Observer from '@ckeditor/ckeditor5-engine/src/view/observer/observer';
@@ -12,7 +12,7 @@ import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventd
 import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
 
 /**
- * Enter observer introduces the {@link module:engine/view/document~Document#event:enter} event.
+ * SoftBreak observer introduces the {@link module:engine/view/document~Document#event:softbreak} event.
  *
  * @extends module:engine/view/observer~Observer
  */
@@ -46,11 +46,11 @@ export default class SoftBreakObserver extends Observer {
 }
 
 /**
- * Event fired when the user presses the <kbd>Enter</kbd> key.
+ * Event fired when the user presses the <kbd>Shift+Enter</kbd> key.
  *
- * Note: This event is fired by the {@link module:enter/enterobserver~EnterObserver observer}
- * (usually registered by the {@link module:enter/enter~Enter Enter feature}).
+ * Note: This event is fired by the {@link module:enter/softbreakobserver~SoftBreakObserver observer}
+ * (usually registered by the {@link module:enter/softbreak~SoftBreak SoftBreak feature}).
  *
- * @event module:engine/view/document~Document#event:enter
+ * @event module:engine/view/document~Document#event:softbreak
  * @param {module:engine/view/observer/domeventdata~DomEventData} data
  */

+ 1 - 1
packages/ckeditor5-enter/tests/softbreakcommand.js

@@ -105,7 +105,7 @@ describe( 'SoftBreakCommand', () => {
 			test(
 				'inserts at the beginning of block',
 				'<p>x</p><p>[]foo</p><p>y</p>',
-				'<p>x</p><p><br></br>[]foo</p><p>y</p>',
+				'<p>x</p><p><br></br>[]foo</p><p>y</p>'
 			);
 
 			// test(

+ 1 - 1
packages/ckeditor5-enter/tests/softbreakobserver.js

@@ -53,7 +53,7 @@ describe( 'SoftBreakObserver', () => {
 
 			expect( spy.calledOnce ).to.be.false;
 		} );
-		
+
 		it( 'is not fired on keydown when keyCode does not match shift+enter', () => {
 			const spy = sinon.spy();