浏览代码

Merge branch 'master' into t/ckeditor5/1151

Aleksander Nowodzinski 6 年之前
父节点
当前提交
13129c3b29

文件差异内容过多而无法显示
+ 1 - 3
packages/ckeditor5-utils/.travis.yml


+ 5 - 0
packages/ckeditor5-utils/CHANGELOG.md

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+## [12.1.1](https://github.com/ckeditor/ckeditor5-utils/compare/v12.1.0...v12.1.1) (2019-06-05)
+
+Internal changes only (updated dependencies, documentation, etc.).
+
+
 ## [12.1.0](https://github.com/ckeditor/ckeditor5-utils/compare/v12.0.0...v12.1.0) (2019-04-10)
 
 ### Features

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

@@ -4,7 +4,6 @@ CKEditor 5 utilities
 [![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-utils.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-utils)
 [![Build Status](https://travis-ci.org/ckeditor/ckeditor5-utils.svg?branch=master)](https://travis-ci.org/ckeditor/ckeditor5-utils)
-[![BrowserStack Status](https://automate.browserstack.com/automate/badge.svg?badge_key=d3hvenZqQVZERFQ5d09FWXdyT0ozVXhLaVltRFRjTTUyZGpvQWNmWVhUUT0tLUZqNlJ1YWRUd0RvdEVOaEptM1B2Q0E9PQ==--c9d3dee40b9b4471ff3fb516d9ecf8d09292c7e0)](https://automate.browserstack.com/public-build/d3hvenZqQVZERFQ5d09FWXdyT0ozVXhLaVltRFRjTTUyZGpvQWNmWVhUUT0tLUZqNlJ1YWRUd0RvdEVOaEptM1B2Q0E9PQ==--c9d3dee40b9b4471ff3fb516d9ecf8d09292c7e0)
 [![Coverage Status](https://coveralls.io/repos/github/ckeditor/ckeditor5-utils/badge.svg?branch=master)](https://coveralls.io/github/ckeditor/ckeditor5-utils?branch=master)
 <br>
 [![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-utils/status.svg)](https://david-dm.org/ckeditor/ckeditor5-utils)
@@ -18,4 +17,4 @@ See the [`@ckeditor/ckeditor5-utils` package](https://ckeditor.com/docs/ckeditor
 
 ## License
 
-Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html). For full details about the license, please check the `LICENSE.md` file.
+Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html). For full details about the license, please check the `LICENSE.md` file or [https://ckeditor.com/legal/ckeditor-oss-license](https://ckeditor.com/legal/ckeditor-oss-license).

+ 6 - 6
packages/ckeditor5-utils/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-utils",
-  "version": "12.1.0",
+  "version": "12.1.1",
   "description": "Miscellaneous utils used by CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -9,14 +9,14 @@
     "ckeditor5-lib"
   ],
   "dependencies": {
-    "ckeditor5": "^12.1.0",
+    "ckeditor5": "^12.2.0",
     "lodash-es": "^4.17.10"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-build-classic": "^12.1.0",
-    "@ckeditor/ckeditor5-editor-classic": "^12.1.0",
-    "@ckeditor/ckeditor5-core": "^12.1.0",
-    "@ckeditor/ckeditor5-engine": "^13.1.0",
+    "@ckeditor/ckeditor5-build-classic": "^12.2.0",
+    "@ckeditor/ckeditor5-editor-classic": "^12.1.1",
+    "@ckeditor/ckeditor5-core": "^12.1.1",
+    "@ckeditor/ckeditor5-engine": "^13.1.1",
     "eslint": "^5.5.0",
     "eslint-config-ckeditor5": "^1.0.11",
     "husky": "^1.3.1",

+ 4 - 4
packages/ckeditor5-utils/src/env.js

@@ -21,7 +21,7 @@ const env = {
 	 * Indicates that the application is running on Macintosh.
 	 *
 	 * @static
-	 * @member {Boolean} module:utils/env~env#isMac
+	 * @type {Boolean}
 	 */
 	isMac: isMac( userAgent ),
 
@@ -29,7 +29,7 @@ const env = {
 	 * Indicates that the application is running in Microsoft Edge.
 	 *
 	 * @static
-	 * @member {Boolean} module:utils/env~env#isEdge
+	 * @type {Boolean}
 	 */
 	isEdge: isEdge( userAgent ),
 
@@ -37,7 +37,7 @@ const env = {
 	 * Indicates that the application is running in Firefox (Gecko).
 	 *
 	 * @static
-	 * @member {Boolean} module:utils/env~env#isEdge
+	 * @type {Boolean}
 	 */
 	isGecko: isGecko( userAgent ),
 
@@ -45,7 +45,7 @@ const env = {
 	 * Indicates that the application is running in Safari.
 	 *
 	 * @static
-	 * @member {Boolean} module:utils/env~env#isSafari
+	 * @type {Boolean}
 	 */
 	isSafari: isSafari( userAgent )
 };

+ 29 - 29
packages/ckeditor5-utils/src/version.js

@@ -21,7 +21,7 @@ if ( windowOrGlobal.CKEDITOR_VERSION ) {
 	 * errors.
 	 *
 	 * There are many situations in which some modules can be loaded twice. In the worst case scenario,
-	 * you may need to check your project for each of those issues and fix them all.
+	 * you may need to check your project for each of these issues and fix them all.
 	 *
 	 * # Trying to add a plugin to an existing build
 	 *
@@ -32,17 +32,17 @@ if ( windowOrGlobal.CKEDITOR_VERSION ) {
 	 *
 	 * Then your project loads some CKEditor 5 packages twice. How does it happen?
 	 *
-	 * The build package contains a file which is already compiled with webpack,
-	 * meaning that it contains all the necessary code from e.g. `@ckeditor/ckeditor5-engine` and `@ckeditor/ckeditor5-utils`.
+	 * The build package contains a file which is already compiled with webpack. This means
+	 * that it contains all the necessary code from e.g. `@ckeditor/ckeditor5-engine` and `@ckeditor/ckeditor5-utils`.
 	 *
-	 * However, the `Highlight` plugin imports some of the modules from those packages too. If you ask webpack to
-	 * build such a project, you will end up with those modules being included (and run) twice – first, because they are
-	 * included inside the build package, and second because they are required by the `Highlight` plugin.
+	 * However, the `Highlight` plugin imports some of the modules from these packages, too. If you ask webpack to
+	 * build such a project, you will end up with the modules being included (and run) twice &mdash; first, because they are
+	 * included inside the build package, and second, because they are required by the `Highlight` plugin.
 	 *
 	 * Therefore, **you must never add plugins to an existing build** unless your plugin has no dependencies.
 	 *
 	 * Adding plugins to a build is done by taking the source version of this build (so, before it was built with webpack)
-	 * and adding plugins there. In this situation, webpack will know that it only needs to load each plugins once.
+	 * and adding plugins there. In this situation, webpack will know that it only needs to load each plugin once.
 	 *
 	 * Read more in the {@glink builds/guides/integration/installing-plugins "Installing plugins"} guide.
 	 *
@@ -50,9 +50,9 @@ if ( windowOrGlobal.CKEDITOR_VERSION ) {
 	 *
 	 * This scenario is very similar to the previous one, but has a different origin.
 	 *
-	 * Let's assume, that you wanted to use CKEditor 5 from source, as explained in the
+	 * Let's assume that you wanted to use CKEditor 5 from source, as explained in the
 	 * {@glink builds/guides/integration/advanced-setup#scenario-2-building-from-source "Building from source"} section
-	 * or in the {@glink framework/guides/quick-start "Quick start"} guide of the CKEditor 5 Framework.
+	 * or in the {@glink framework/guides/quick-start "Quick start"} guide of CKEditor 5 Framework.
 	 *
 	 * The correct way to do so is to import an editor and plugins and run them together like this:
 	 *
@@ -74,7 +74,7 @@ if ( windowOrGlobal.CKEDITOR_VERSION ) {
 	 *				console.error( error.stack );
 	 *			} );
 	 *
-	 * However, you might have mistakenly import a build instead of a source `ClassicEditor`. In which case
+	 * However, you might have mistakenly imported a build instead of the source `ClassicEditor`. In this case
 	 * your imports will look like this:
 	 *
 	 *		import ClassicEditor from '@ckeditor/ckeditor5-build-classic';
@@ -85,12 +85,12 @@ if ( windowOrGlobal.CKEDITOR_VERSION ) {
 	 *
 	 * This creates the same situation as in the previous section because you use a build together with source plugins.
 	 *
-	 * Remember: `@ckeditor/ckeditor5-build-*` packages contain editor builds and `@ckeditor/ckeditor5-editor-*` source editors.
+	 * Remember: `@ckeditor/ckeditor5-build-*` packages contain editor builds and `@ckeditor/ckeditor5-editor-*` contain source editors.
 	 *
-	 * # Loading two+ builds on one page
+	 * # Loading two or more builds on one page
 	 *
-	 * If you use CKEditor 5 builds, you might have loaded two (or more) `ckeditor.js` files in one web page
-	 * – check your web page for duplicated `<script>` elements or make sure your page builder/bundler includes CKEditor only once.
+	 * If you use CKEditor 5 builds, you might have loaded two (or more) `ckeditor.js` files on one web page.
+	 * Check your web page for duplicated `<script>` elements or make sure your page builder/bundler includes CKEditor only once.
 	 *
 	 * If you want to use two different types of editors at once, see the
 	 * {@glink builds/guides/integration/advanced-setup#scenario-3-using-two-different-editors "Using two different editors"}
@@ -98,9 +98,9 @@ if ( windowOrGlobal.CKEDITOR_VERSION ) {
 	 *
 	 * # Using outdated packages
 	 *
-	 * Building CKEditor 5 from source require using multiple npm packages. Those packages have their dependencies
-	 * to other packages. If you use the latest version of let's say `@ckeditor/ckeditor5-editor-classic` with
-	 * and outdated version of `@ckeditor/ckeditor5-image`, npm or yarn will need to install two different versions of
+	 * Building CKEditor 5 from source requires using multiple npm packages. These packages have their dependencies
+	 * to other packages. If you use the latest version of, for example, `@ckeditor/ckeditor5-editor-classic` with
+	 * an outdated version of `@ckeditor/ckeditor5-image`, npm or yarn will need to install two different versions of
 	 * `@ckeditor/ckeditor5-core` because `@ckeditor/ckeditor5-editor-classic` and `@ckeditor/ckeditor5-image` may require
 	 * different versions of the core package.
 	 *
@@ -109,30 +109,30 @@ if ( windowOrGlobal.CKEDITOR_VERSION ) {
 	 *
 	 * # Conflicting version of dependencies
 	 *
-	 * This is a special case of the previous scenario. If you use CKEditor 5 with some 3rd party plugins,
+	 * This is a special case of the previous scenario. If you use CKEditor 5 with some third-party plugins,
 	 * it may happen that even if you use the latest versions of the official packages and the latest version of
-	 * those 3rd party packages, there will be a conflict between some of their dependencies.
+	 * these third-party packages, there will be a conflict between some of their dependencies.
 	 *
 	 * Such a problem can be resolved by either downgrading CKEditor 5 packages (which we do not recommend) or
-	 * asking the author of the 3rd party package to upgrade its depdendencies (or forking his project and doing this yourself).
+	 * asking the author of the third-party package to upgrade its depdendencies (or forking their project and doing this yourself).
 	 *
 	 * # Packages were duplicated in `node_modules`
 	 *
 	 * In some situations, especially when calling `npm install` multiple times, it may happen
-	 * than npm will not correctly "deduplicate" packages.
+	 * that npm will not correctly "deduplicate" packages.
 	 *
-	 * Normally, npm deduplicates all packages so e.g. `@ckeditor/ckeditor5-core` is installed only once in `node_modules/`.
-	 * However, it was known to fail to do so from time to time.
+	 * Normally, npm deduplicates all packages so, for example, `@ckeditor/ckeditor5-core` is installed only once in `node_modules/`.
+	 * However, it is known to fail to do so from time to time.
 	 *
-	 * We recommend checking if any of the below steps helps:
+	 * We recommend checking if any of the steps listed below help:
 	 *
-	 * * `rm -rf node_modules && npm install` to make sure you have a clean `node_modules/` – this step
-	 * is known to help in majority of cases,
-	 * * if you use `yarn.lock` or `package-lock.json`, remove it before `npm install`,
-	 * * check whether all CKEditor 5 packages are up to date and reinstall them
+	 * * `rm -rf node_modules && npm install` to make sure you have a clean `node_modules/` directory. This step
+	 * is known to help in most cases.
+	 * * If you use `yarn.lock` or `package-lock.json`, remove it before `npm install`.
+	 * * Check whether all CKEditor 5 packages are up to date and reinstall them
 	 * if you changed anything (`rm -rf node_modules && npm install`).
 	 *
-	 * If all packages are correct and compatible with each other the above steps are known to help. If not, you may
+	 * If all packages are correct and compatible with each other, the steps above are known to help. If not, you may
 	 * try to check with `npm ls` how many times packages like `@ckeditor/ckeditor5-core`, `@ckeditor/ckeditor5-engine` and
 	 *`@ckeditor/ckeditor5-utils` are installed. If more than once, verify which package causes that.
 	 *