Merge pull request #1345 from ckeditor/t/1214

Internal: Switched development environment to Yarn. Closes #1214.

.travis.yml

@@ -3,34 +3,34 @@ dist: trusty
 addons:
   apt:
     sources:
-      - google-chrome
+    - google-chrome
     packages:
-      - google-chrome-stable
+    - google-chrome-stable
 language: node_js
+cache:
+  yarn: true
 node_js:
-  - "8"
+- "8"
 cache:
-  - node_modules
+- node_modules
 before_install:
-  - export DISPLAY=:99.0
-  - sh -e /etc/init.d/xvfb start
-  - npm config set package-lock false
-  - npm i -g npm@^5.7.1
+- export DISPLAY=:99.0
+- sh -e /etc/init.d/xvfb start
+- npm i -g yarn
 install:
-  - npm install
-  - npm install mgit2 lerna
-  - mgit bootstrap --resolver-url-template="https://github.com/\${ path }.git"
-  - lerna bootstrap
+- yarn add mgit2 --ignore-workspace-root-check
+- mgit bootstrap --resolver-url-template="https://github.com/\${ path }.git"
+- yarn
 script:
-  - npm t -- --reporter=dots
-  - npm run docs:api -- --validate-only
-  - 'if [ $TRAVIS_TEST_RESULT -eq 0 ]; then
-  	  travis_wait npm run docs:build-and-publish-nightly;
-    fi'
+- yarn run test --reporter=dots
+- yarn run docs:api --validate-only
+- 'if [ $TRAVIS_TEST_RESULT -eq 0 ]; then
+    travis_wait yarn run docs:build-and-publish-nightly;
+  fi'
 notifications:
   slack:
     rooms:
-      - secure: NKUpSnmkmlRRua0URoQJjEqNfIHx6tuqJhVCbQ6vU5rdUdw6A43OfG7Qym3MRQlXymFuIF0MUsOrS6t0GeXE9hSpC+5ynF02E5wdTD1/R7Tjq0XEdx0mXJTYjuOQA16fvwMxm5p3Ub5uWpSH+gBtyG86UPCbVSxDvvmxHqResAw=
+    - secure: NKUpSnmkmlRRua0URoQJjEqNfIHx6tuqJhVCbQ6vU5rdUdw6A43OfG7Qym3MRQlXymFuIF0MUsOrS6t0GeXE9hSpC+5ynF02E5wdTD1/R7Tjq0XEdx0mXJTYjuOQA16fvwMxm5p3Ub5uWpSH+gBtyG86UPCbVSxDvvmxHqResAw=
     on_success: change
     on_failure: always
     on_pull_requests: false

docs/builds/guides/development/custom-builds.md

@@ -147,7 +147,7 @@ After you changed the webpack entry file or updated some dependencies, it is tim
 To do that, execute the following command:
 
 ```bash
-npm run build
+yarn run build
 ```
 
 You can validate whether your new build works by opening the `sample/index.html` file in a browser (via HTTP, not as a local file). Make sure to **clear the cache**.

docs/builds/guides/integration/advanced-setup.md

@@ -560,7 +560,7 @@ index c57e371..04fc9fe 100644
 Once you changed the `src/ckeditor.js` and `webpack.config.js` files it is time to rebuild the build:
 
 ```bash
-npm run build
+yarn run build
 ```
 
 Finally, when webpack finishes compiling your super build, you can change the `samples/index.html` file to test both editors:

docs/builds/guides/integration/installing-plugins.md

@@ -123,7 +123,7 @@ ClassicEditor.defaultConfig = {
 Finally, bundle the build:
 
 ```bash
-npm run build
+yarn run build
 ```
 
 If everything worked, the editor build (which is available in the `build/` directory) should be updated.

docs/framework/guides/contributing/development-environment.md

@@ -8,7 +8,7 @@ order: 10
 The CKEditor 5 codebase is divided into multiple [npm](http://npmjs.com/) packages, each developed in a separate Git repository. The main package is [`ckeditor5`](https://github.com/ckeditor/ckeditor5) which installs all project dependencies and various development-related resources such as:
 
 * the testing environment setup,
-* configuration for [mgit](https://www.npmjs.com/package/mgit2) (a multi-repo management tool) and [Lerna.js](https://github.com/lerna/lerna) (a multi-package management tool),
+* configuration for [mgit](https://www.npmjs.com/package/mgit2) (a multi-repo management tool) and [Yarn](https://yarnpkg.com/) (a dependency management tool),
 * translation management tools,
 * documentation generator,
 * and release tools.
@@ -20,20 +20,20 @@ You can find all the official packages listed in [CKEditor 5 development reposit
 In order to start developing CKEditor 5 you will require:
 
 * [Node.js](https://nodejs.org/en/) 6.9.0+
-* npm 4+ (**note:** some npm 5+ versions were known to cause [problems](https://github.com/npm/npm/issues/16991), especially with deduplicating packages; upgrade npm when in doubt)
+* [Yarn](https://yarnpkg.com/) 1.2.0+
 * [Git](https://git-scm.com/)
 
 ## Setting up the CKEditor development environment
 
 First, you need to install a couple of tools which you will be using later:
 
 * [mgit](https://www.npmjs.com/package/mgit2) – A multi-repo management tool,
-* [Lerna.js](https://github.com/lerna/lerna)@2 – A multi-package management tool. Note: Lerna@3 is [not supported yet](https://github.com/ckeditor/ckeditor5/issues/1214).
+* [Yarn](https://yarnpkg.com/) – A dependency management tool.
 
 It is best to install them globally in your system for an easier use later on:
 
 ```bash
-npm install -g lerna@2 mgit2
+npm install -g yarn mgit2
 ```
 
 Note: You may need to use `sudo` on Linux and macOS.
@@ -50,16 +50,14 @@ And install all CKEditor 5 packages from the [npm registry](http://npmjs.com/).
 **Note:** If you plan to use the developement version of CKEditor 5 packages (see the [next section](#switching-to-development-version-of-packages)), you can skip this step to save time.
 
 ```bash
-npm install
+yarn install
 ```
 
-This may take a [while](https://github.com/npm/npm/issues/10380)...
-
 ### Switching to development version of packages
 
 The steps above should install all the packages from npm, which means that you will have the latest releases of all of them. They are available in `node_modules/@ckeditor/` (we are using [scoped packages](https://docs.npmjs.com/misc/scope), hence the unusual directory).
 
-In order to work with development versions of all the official packages, it is recommended to use mgit and Lerna. The former will clone all package repositories and the latter will be able to symlink them, so they create a correct directory structure, understandable by Node.js-compliant tools (like webpack or Browserify).
+In order to work with development versions of all the official packages, it is recommended to use mgit. The former will clone all package repositories and the latter will be able to symlink them, so they create a correct directory structure, understandable by Node.js-compliant tools (like webpack or Browserify).
 
 First, clone all the repositories:
 
@@ -82,10 +80,10 @@ packages/
 Finally, link them:
 
 ```bash
-lerna bootstrap
+yarn install
 ```
 
-Running Lerna may take a while because it installs all package dependencies. It will also warn you about circular dependencies between packages which you can ignore.
+Running Yarn may take a while because it installs all package dependencies.
 
 Now, all CKEditor packages (except the [development tools](https://github.com/ckeditor/ckeditor5-dev)) should be cross-symlinked:
 
@@ -102,7 +100,7 @@ lrwxr-xr-x    1 p  staff    25 31 Jan 10:37 ckeditor5-engine -> ../../../ckedito
 If everything worked correctly, you should be able to run some tests:
 
 ```bash
-npm run test -- --files=core
+yarn run test --files=core
 ```
 
 ### Fetching changes
@@ -117,48 +115,32 @@ git pull
 mgit update
 ```
 
-From time to time, if the list of dependencies in any of the packages changed, you will need to call Lerna again to symlink them:
-
-```bash
-lerna bootstrap
-```
-
-You can also speed it up if you know which package has changed:
+From time to time, if the list of dependencies in any of the packages changed, you will need to call Yarn again to symlink them:
 
 ```bash
-lerna bootstrap --scope=@ckeditor/ckeditor5-core
+yarn install
 ```
 
 ### Using mgit for custom packages
 
 If you are developing custom packages or forked any of the official packages and want mgit to work with it, change the dependencies configuration in [`mgit.json`](https://github.com/ckeditor/ckeditor5/blob/master/mgit.json). Note that mgit is able to clone the package from any Git URL. Refer to [its documentation](https://github.com/cksource/mgit2) for more details.
 
-### Troubleshooting problems with Lerna
-
-Lerna does pretty complicated things on an already complicated npm ecosystem. If you happen to run into some issues when calling `lerna bootstrap`, here are some tips:
-
-* Look for `npm-debug.log` files in the main package and subpackages. They may point to an obvious issue like a typo in some `package.json`.
-* Sometimes repeating `lerna bootstrap` may help.
-* If nothing else works, do `lerna clean && lerna bootstrap`.
-
-### Final word about mgit and Lerna
+### Final word about mgit
 
 Besides the already mentioned features, mgit allows you to [execute shell commands](https://github.com/cksource/mgit2#exec) on all packages (e.g. check their status). It has been developed by the [CKSource team](https://cksource.com/) and we are relying on it heavily, hence you can expect more features and improvements to come. However, it is not a CKEditor-specific tool and should be suitable for any multi-repository project (though it best fits JavaScript projects).
 
-Lerna is a tool used by many well-known projects such as [Babel.js](https://github.com/babel/babel). It has an amazing community and, relying on it ourselves, we hope that it will become a standard for managing multi-package projects.
-
 ## Running tests
 
 In order to run tests you need to use the `test` and `manual` tasks.
 
 ```bash
-npm test -- --watch --coverage --source-map --files=engine
+yarn run test --watch --coverage --source-map --files=engine
 ```
 
 or, shorter:
 
 ```bash
-npm test -- -wcs --files=engine
+yarn run test -- -wcs --files=engine
 ```
 
 This command will run the [`ckeditor5-engine`](https://github.com/ckeditor/ckeditor5-engine) package's tests.
@@ -168,7 +150,7 @@ This command will run the [`ckeditor5-engine`](https://github.com/ckeditor/ckedi
 To create a server for manual tests use the `manual` task:
 
 ```bash
-npm run manual
+yarn run manual
 ```
 
 It accepts the `--source-map` (`-s`) option. Note that it watches for changes in the JavaScript files only (see the [bug](https://github.com/ckeditor/ckeditor5-dev/issues/52)).
@@ -180,7 +162,7 @@ You can read more about the {@link framework/guides/contributing/testing-environ
 To build the documentation you need to run the `docs` task:
 
 ```bash
-npm run docs
+yarn run docs
 ```
 
 The documentation will be available in `build/docs/`.
@@ -197,7 +179,7 @@ This task accepts the following arguments:
 Note: These arguments must be passed after additional `--`:
 
 ```
-npm run docs -- --skip-api
+yarn run docs --skip-api
 ```
 
 ## Bisecting through a multi-repository

docs/framework/guides/contributing/testing-environment.md

@@ -15,7 +15,7 @@ Each CKEditor package has its own tests suite (see for example the [engine's tes
 
 ## Running automated tests
 
-In order to run the automated tests use the `npm test [-- <args>...]` command.
+In order to run the automated tests use the `yarn run test [<args>...]` command.
 
 It accepts the following arguments (must be passed after the `--` option):
 
@@ -31,24 +31,24 @@ It accepts the following arguments (must be passed after the `--` option):
 Run all tests with the code coverage check of the [`ckeditor5-core`](https://github.com/ckeditor/ckeditor5-core) package:
 
 ```
-npm test -- -c --files=core
+yarn run test -c --files=core
 ```
 
 Run and watch the [engine's `view` namespace tests](https://github.com/ckeditor/ckeditor5-engine/tree/master/tests/view) and all the tests in [`ckeditor5-typing`](https://github.com/ckeditor/ckeditor5-typing):
 
 ```
-npm test -- -cw --files=engine/view,typing
+yarn run test -cw --files=engine/view,typing
 ```
 
 Run the `bold*.js` tests in the [`ckeditor5-basic-styles`](https://github.com/ckeditor/ckeditor5-basic-styles) package:
 
 ```
-npm test -- -cw --files=basic-styles/bold*.js
+yarn run test -cw --files=basic-styles/bold*.js
 ```
 
 ## Running manual tests
 
-In order to start the manual tests server use the `npm run manual` task.
+In order to start the manual tests server use the `yarn run manual` task.
 
 The task accepts the `--source-map` (alias `-s`) option.
 

docs/framework/guides/quick-start.md

@@ -161,7 +161,7 @@ You can now run webpack to build the application. To do that, call the `webpack`
 	And use it via:
 
 	```bash
-	npm run build
+	yarn run build
 	```
 
 	npm adds `./node_modules/.bin/` to the `PATH` automatically, so in this case you do not need to install `webpack-cli` globally.

package.json

@@ -66,16 +66,15 @@
     "@ckeditor/ckeditor5-real-time-collaboration": "^12.0.1",
     "@ckeditor/ckeditor5-comments": "^1.0.1",
     "@ckeditor/ckeditor5-dev-docs": "^10.0.3",
-    "@ckeditor/ckeditor5-dev-env": "^13.0.1",
-    "@ckeditor/ckeditor5-dev-tests": "^13.1.2",
-    "@ckeditor/ckeditor5-dev-utils": "^11.0.0",
-    "@ckeditor/ckeditor5-dev-webpack-plugin": "^7.0.0",
+    "@ckeditor/ckeditor5-dev-env": "^13.0.2",
+    "@ckeditor/ckeditor5-dev-tests": "^14.0.0",
+    "@ckeditor/ckeditor5-dev-utils": "^11.0.1",
+    "@ckeditor/ckeditor5-dev-webpack-plugin": "^7.0.1",
     "css-loader": "^1.0.0",
     "eslint": "^5.5.0",
     "eslint-config-ckeditor5": "^1.0.9",
     "glob": "^7.1.2",
     "husky": "^0.14.3",
-    "lerna": "^2.2.0",
     "lint-staged": "^7.0.0",
     "mgit2": "^0.8.0",
     "mini-css-extract-plugin": "^0.4.0",
@@ -105,8 +104,10 @@
     "precommit": "lint-staged",
     "test": "node --max_old_space_size=4096 node_modules/@ckeditor/ckeditor5-dev-tests/bin/test.js",
     "manual": "node --max_old_space_size=4096 node_modules/@ckeditor/ckeditor5-dev-tests/bin/test-manual.js",
-    "reset": "rm -rf ./packages ./node_modules && mgit bootstrap && lerna bootstrap",
-    "reinstall": "lerna clean --yes && lerna bootstrap",
+    "bootstrap": "mgit bootstrap && yarn install",
+    "clean": "rm -rf node_modules && mgit exec 'rm -rf node_modules'",
+    "reset": "rm -rf ./packages ./node_modules && yarn run bootstrap",
+    "reinstall": "yarn run clean && yarn run bootstrap",
     "docs": "node ./scripts/docs/build-docs.js",
     "docs:api": "node ./scripts/docs/build-api-docs.js",
     "docs:build-and-publish": "node ./scripts/docs/build-and-publish.js",
@@ -130,5 +131,8 @@
     "build/**",
     "coverage/**",
     "packages/**"
+  ],
+  "workspaces": [
+    "packages/*"
   ]
 }

scripts/docs/build-and-publish-nightly.js

@@ -40,7 +40,7 @@ exec( `git clone ${ mainRepoUrl }.git` );
 
 // Build the documentation.
 console.log( 'Building documentation...' );
-exec( 'npm run docs -- --production' );
+exec( 'yarn run docs --production' );
 
 console.log( 'Copying files...' );
 

scripts/docs/build-and-publish.js

@@ -29,7 +29,7 @@ console.log( 'Updating your ckeditor5.github.io clone...' );
 exec( 'cd ../ckeditor5.github.io && git pull && cd -' );
 
 console.log( 'Building documentation...' );
-exec( 'npm run docs -- --production' );
+exec( 'yarn run docs --production' );
 
 console.log( 'Copying files...' );
 

scripts/release/bump-versions.js

@@ -18,10 +18,10 @@
 // You can test the whole process using `dry-run` mode. It won't change anything in the project
 // and any repository.
 //
-// This task must be called before: `npm run release:publish`.
+// This task must be called before: `yarn run release:publish`.
 //
 // Use:
-// npm run release:bump-version -- --dry-run
+// yarn run release:bump-version --dry-run
 
 require( '@ckeditor/ckeditor5-dev-env' )
 	.bumpVersions( {

scripts/release/changelog.js

@@ -10,7 +10,7 @@
 'use strict';
 
 // In order to use the same version for all packages (including builds and ckeditor5 itself), you can call:
-// npm run changelog [newVersion]
+// yarn run changelog [newVersion]
 
 const devEnv = require( '@ckeditor/ckeditor5-dev-env' );
 const commonOptions = {

scripts/release/publish.js

@@ -16,10 +16,10 @@
 //
 // Note: This task based on versions published on NPM and GitHub. If something went wrong, you can call this script one more time.
 //
-// This task should be executed after: `npm run release:bump-version`.
+// This task should be executed after: `yarn run release:bump-version`.
 //
 // Use:
-// npm run release:publish -- --dry-run
+// yarn run release:publish --dry-run
 
 /* eslint-disable max-len */