@ckeditor/ckeditor5-autoformat - npm Package Compare versions

Comparing version 0.6.0 to 1.0.0-alpha.1

CHANGELOG.md

 Changelog
 =========
 
+## [1.0.0-alpha.1](https://github.com/ckeditor/ckeditor5-autoformat/compare/v0.6.0...v1.0.0-alpha.1) (2017-10-03)
+
+### Features
+
+* Added support for backticks which apply `<code>` to the wrapped fragment of text. Closes [#35](https://github.com/ckeditor/ckeditor5-autoformat/issues/35). ([3e93bf6](https://github.com/ckeditor/ckeditor5-autoformat/commit/3e93bf6))
+
+
 ## [0.6.0](https://github.com/ckeditor/ckeditor5-autoformat/compare/v0.5.1...v0.6.0) (2017-09-03)
@@ -5,0 +12,0 @@

package.json

 {
   "name": "@ckeditor/ckeditor5-autoformat",
-  "version": "0.6.0",
-  "description": "Replaces predefined characters with corresponding structures.",
-  "keywords": [],
+  "version": "1.0.0-alpha.1",
+  "description": "Autoformatting feature for CKEditor 5.",
+  "keywords": [
+    "ckeditor5",
+    "ckeditor5-feature"
+  ],
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "^0.9.0",
-    "@ckeditor/ckeditor5-engine": "^0.11.0"
+    "@ckeditor/ckeditor5-core": "^1.0.0-alpha.1",
+    "@ckeditor/ckeditor5-engine": "^1.0.0-alpha.1"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^0.9.0",
-    "@ckeditor/ckeditor5-dev-lint": "^3.1.0",
-    "@ckeditor/ckeditor5-block-quote": "^0.2.0",
-    "@ckeditor/ckeditor5-editor-classic": "^0.8.0",
-    "@ckeditor/ckeditor5-enter": "^0.10.0",
-    "@ckeditor/ckeditor5-heading": "^0.10.0",
-    "@ckeditor/ckeditor5-list": "^0.7.0",
-    "@ckeditor/ckeditor5-paragraph": "^0.9.0",
-    "@ckeditor/ckeditor5-typing": "^0.10.0",
-    "@ckeditor/ckeditor5-undo": "^0.9.0",
-    "eslint-config-ckeditor5": "^1.0.5",
+    "@ckeditor/ckeditor5-basic-styles": "^1.0.0-alpha.1",
+    "@ckeditor/ckeditor5-dev-lint": "^3.1.4",
+    "@ckeditor/ckeditor5-block-quote": "^1.0.0-alpha.1",
+    "@ckeditor/ckeditor5-editor-classic": "^1.0.0-alpha.1",
+    "@ckeditor/ckeditor5-enter": "^1.0.0-alpha.1",
+    "@ckeditor/ckeditor5-heading": "^1.0.0-alpha.1",
+    "@ckeditor/ckeditor5-list": "^1.0.0-alpha.1",
+    "@ckeditor/ckeditor5-paragraph": "^1.0.0-alpha.1",
+    "@ckeditor/ckeditor5-typing": "^1.0.0-alpha.1",
+    "@ckeditor/ckeditor5-undo": "^1.0.0-alpha.1",
+    "eslint-config-ckeditor5": "^1.0.6",
     "gulp": "^3.9.1",
@@ -36,3 +39,8 @@ "guppy-pre-commit": "^0.4.0"
     "url": "https://github.com/ckeditor/ckeditor5-autoformat.git"
-  }
+  },
+  "files": [
+    "lang",
+    "src",
+    "theme"
+  ]
 }

README.md

@@ -11,6 +11,10 @@ CKEditor 5 autoformat feature
 
-Replaces predefined characters with corresponding structures. More information about the project can be found at the following URL: <https://github.com/ckeditor/ckeditor5-autoformat>.
+This package implements the autoformatting feature for CKEditor 5. It allows styling text by typing sequences like `**bold this**`.
 
+## Documentation
+
+See the [`@ckeditor/ckeditor5-autoformat` package](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/autoformat.html) page in [CKEditor 5 documentation](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/).
+
 ## License
 
 Licensed under the GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the `LICENSE.md` file.

src/autoformat.js

@@ -62,10 +62,11 @@ /**
 	/**
-	 * Adds autoformatting related to the {@link module:basic-styles/bold~Bold} and
-	 * {@link module:basic-styles/italic~Italic}.
+	 * Adds autoformatting related to the {@link module:basic-styles/bold~Bold},
+	 * {@link module:basic-styles/italic~Italic} and {@link module:basic-styles/code~Code}.
 	 *
 	 * When typed:
-	 * - `**foobar**` – `**` characters are removed and `foobar` is set to bold.
-	 * - `__foobar__` – `__` characters are removed and `foobar` is set to bold.
-	 * - `*foobar*` – `*` characters are removed and `foobar` is set to italic.
-	 * - `_foobar_` – `_` characters are removed and `foobar` is set to italic.
+	 * - `**foobar**` – `**` characters are removed and `foobar` is set to bold,
+	 * - `__foobar__` – `__` characters are removed and `foobar` is set to bold,
+	 * - `*foobar*` – `*` characters are removed and `foobar` is set to italic,
+	 * - `_foobar_` – `_` characters are removed and `foobar` is set to italic,
+	 * - ``` `foobar` – ``` ` ``` characters are removed and `foobar` is set to code.
 	 *
@@ -93,2 +94,8 @@ * @private
 		}
+
+		if ( commands.get( 'code' ) ) {
+			/* eslint-disable no-new */
+			new InlineAutoformatEngine( this.editor, /(`)([^`]+)(`)$/g, 'code' );
+			/* eslint-enable no-new */
+		}
 	}
@@ -95,0 +102,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

20

increased by25%

Worsened metrics

Total package byte prevSize

22562

decreased by-54.22%

Number of package files

7

decreased by-68.18%

Lines of code

409

decreased by-57.88%

Dependency changes

• + Added@ckeditor/ckeditor5-core@1.0.0-beta.4(transitive)

• + Added@ckeditor/ckeditor5-engine@1.0.0-beta.4(transitive)

• + Added@ckeditor/ckeditor5-utils@1.0.0-beta.4(transitive)

• - Removed@ckeditor/ckeditor5-core@0.9.0(transitive)

• - Removed@ckeditor/ckeditor5-engine@0.11.0(transitive)

• - Removed@ckeditor/ckeditor5-utils@0.10.0(transitive)

• Updated@ckeditor/ckeditor5-core@^1.0.0-alpha.1

• Updated@ckeditor/ckeditor5-engine@^1.0.0-alpha.1