Replace npm with yarn (#113)

* package.json: private true

* delete package-lock.json

* cvat-core/package.json: fix path for cvat-data

* replace npm with yarn

* replace npm with yarn

* add yarn.lock files

* replace npm with yarn

* remark: replace npm with yarn

* fixes

* fixes

* alligment

* workflows: replace npm with yarn

* revert husky version

* replace npm with yarn on ci image

* add yarn for ci image

* enable debug mode for main workflow

* debug mode

* v0.0.0

* resolve dependencies issues

* update docs

* exit debug mode

* add yarn.lock to the ui image

* fix three version

* resolve conflicts

* [no ci] use yarn instead of npm

* fix src path

.github/workflows/eslint.yml

@@ -26,9 +26,8 @@ jobs:
           done
 
           if [[ ! -z $CHANGED_FILES ]]; then
-            npm ci
-            cd tests && npm ci && cd ..
-            npm install eslint-detailed-reporter --save-dev --legacy-peer-deps
+            yarn install --frozen-lockfile
+            yarn add eslint-detailed-reporter -D -W
             mkdir -p eslint_report
 
             echo "ESLint version: "$(npx eslint --version)

.github/workflows/full.yml

@@ -193,7 +193,7 @@ jobs:
             -c 'python manage.py test cvat/apps cvat-cli -v 2'
 
           docker-compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.ci.yml run cvat_ci /bin/bash \
-            -c 'cd cvat-data && npm ci --ignore-scripts && cd ../cvat-core && npm ci --ignore-scripts && npm run test'
+            -c 'yarn --frozen-lockfile --ignore-scripts && yarn workspace cvat-core run test'
 
       - name: Creating a log file from cvat containers
         if: failure()
@@ -300,7 +300,7 @@ jobs:
         run: |
           docker exec -i cvat /bin/bash -c "echo \"from django.contrib.auth.models import User; User.objects.create_superuser('${DJANGO_SU_NAME}', '${DJANGO_SU_EMAIL}', '${DJANGO_SU_PASSWORD}')\" | python3 ~/manage.py shell"
           cd ./tests
-          npm ci
+          yarn --frozen-lockfile
 
           shopt -s extglob
           if [[ ${{ matrix.specs }} == canvas3d_* ]]; then

.github/workflows/main.yml

@@ -155,7 +155,7 @@ jobs:
           -c 'python manage.py test cvat/apps cvat-cli -k tasks_id -k lambda -k share -v 2'
 
           docker-compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.ci.yml run cvat_ci /bin/bash \
-          -c 'cd cvat-data && npm ci --ignore-scripts && cd ../cvat-core && npm ci --ignore-scripts && npm run test'
+          -c 'yarn --frozen-lockfile --ignore-scripts && yarn workspace cvat-core run test'
 
       - name: Creating a log file from cvat containers
         if: failure()
@@ -257,7 +257,7 @@ jobs:
           docker exec -i cvat /bin/bash -c "echo \"from django.contrib.auth.models import User; User.objects.create_superuser('${DJANGO_SU_NAME}', '${DJANGO_SU_EMAIL}', '${DJANGO_SU_PASSWORD}')\" | python3 ~/manage.py shell"
 
           cd ./tests
-          npm ci
+          yarn --frozen-lockfile
 
           if [ ${{ matrix.specs }} == 'canvas3d_functionality' ]; then
             npx cypress run --headed --browser chrome --config-file pr_cypress_canvas3d.json

.github/workflows/remark.yml

@@ -11,7 +11,7 @@ jobs:
 
       - name: Run checks
         run: |
-          npm ci
+          yarn install --frozen-lockfile
           mkdir -p remark_report
 
           echo "Remark version: "`npx remark --version`

.github/workflows/schedule.yml

@@ -179,7 +179,7 @@ jobs:
           -c 'coverage run -a manage.py test cvat/apps cvat-cli && mv .coverage ${CONTAINER_COVERAGE_DATA_DIR}'
 
           docker-compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.ci.yml run cvat_ci /bin/bash \
-          -c 'cd cvat-data && npm ci --ignore-scripts && cd ../cvat-core && npm ci --ignore-scripts && npm run test && mv ./reports/coverage/lcov.info ${CONTAINER_COVERAGE_DATA_DIR} && chmod a+rwx ${CONTAINER_COVERAGE_DATA_DIR}/lcov.info'
+          -c 'yarn --frozen-lockfile --ignore-script && yarn workspace cvat-core run test'
 
           docker-compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.ci.yml down -v
 
@@ -232,8 +232,8 @@ jobs:
 
       - name: Instrumentation of the code then rebuilding the CVAT UI
         run: |
-          npm ci
-          npm run coverage
+          yarn --frozen-lockfile
+          yarn run coverage
           docker-compose -f docker-compose.yml -f docker-compose.dev.yml -f components/serverless/docker-compose.serverless.yml build cvat_ui
 
       - name: Run CVAT instance
@@ -286,7 +286,7 @@ jobs:
       - name: Run tests
         run: |
           cd ./tests
-          npm ci
+          yarn --frozen-lockfile
 
           TESTS_3D=('canvas3d_functionality' 'canvas3d_functionality_2')
           for testset in ${TESTS_3D[@]};
@@ -377,7 +377,7 @@ jobs:
           mkdir -p ./nyc_output_tmp
           mv ./out_*.json ./nyc_output_tmp
           mkdir -p ./.nyc_output
-          npm ci
+          yarn --frozen-lockfile
           npx nyc merge ./nyc_output_tmp ./.nyc_output/out.json
 
       - name: Sending results to Coveralls

.github/workflows/stylelint.yml

@@ -26,7 +26,7 @@ jobs:
           done
 
           if [[ ! -z $CHANGED_FILES ]]; then
-            npm ci
+            yarn install --frozen-lockfile
             mkdir -p stylelint_report
 
             echo "StyleLint version: "$(npx stylelint --version)

Dockerfile.ci

@@ -19,6 +19,7 @@ RUN apt-get update && \
         google-chrome-stable \
         nodejs \
         && \
+        npm install --global yarn && \
     rm -rf /var/lib/apt/lists/*;
 
 COPY cvat/requirements/ /tmp/cvat/requirements/
@@ -32,7 +33,8 @@ RUN gem install coveralls-lcov
 
 COPY cvat-core ${HOME}/cvat-core
 COPY cvat-data ${HOME}/cvat-data
-COPY package*.json ${HOME}/
+COPY package.json ${HOME}/
+COPY yarn.lock ${HOME}/
 COPY tests ${HOME}/tests
 
 COPY .coveragerc .

Dockerfile.ui

@@ -16,16 +16,17 @@ ENV TERM=xterm \
     LC_ALL='C.UTF-8'
 
 # Install dependencies
-COPY package*.json /tmp/
-COPY cvat-core/package*.json /tmp/cvat-core/
-COPY cvat-canvas/package*.json /tmp/cvat-canvas/
-COPY cvat-canvas3d/package*.json /tmp/cvat-canvas3d/
-COPY cvat-ui/package*.json /tmp/cvat-ui/
-COPY cvat-data/package*.json /tmp/cvat-data/
+COPY package.json /tmp/
+COPY yarn.lock /tmp/
+COPY cvat-core/package.json /tmp/cvat-core/
+COPY cvat-canvas/package.json /tmp/cvat-canvas/
+COPY cvat-canvas3d/package.json /tmp/cvat-canvas3d/
+COPY cvat-ui/package.json /tmp/cvat-ui/
+COPY cvat-data/package.json /tmp/cvat-data/
 
 # Install common dependencies
 WORKDIR /tmp/
-RUN npm ci --ignore-scripts
+RUN yarn install --ignore-scripts --frozen-lockfile
 
 # Build source code
 COPY cvat-data/ /tmp/cvat-data/
@@ -33,7 +34,7 @@ COPY cvat-core/ /tmp/cvat-core/
 COPY cvat-canvas3d/ /tmp/cvat-canvas3d/
 COPY cvat-canvas/ /tmp/cvat-canvas/
 COPY cvat-ui/ /tmp/cvat-ui/
-RUN npm run build:cvat-ui
+RUN yarn run build:cvat-ui
 
 FROM nginx:mainline-alpine
 # Replace default.conf configuration to remove unnecessary rules

cvat-canvas/README.md

@@ -9,17 +9,17 @@ It presents a canvas to viewing, drawing and editing of annotations.
 
 If you make changes in this package, please do following:
 
-- After not important changes (typos, backward compatible bug fixes, refactoring) do: `npm version patch`
-- After changing API (backward compatible new features) do: `npm version minor`
-- After changing API (changes that break backward compatibility) do: `npm version major`
+- After not important changes (typos, backward compatible bug fixes, refactoring) do: `yarn version --patch`
+- After changing API (backward compatible new features) do: `yarn version --minor`
+- After changing API (changes that break backward compatibility) do: `yarn version --major`
 
 ## Commands
 
 - Building of the module from sources in the `dist` directory:
 
 ```bash
-npm run build
-npm run build -- --mode=development     # without a minification
+yarn run build
+yarn run build --mode=development     # without a minification
 ```
 
 ## Using

cvat-canvas3d/README.md

@@ -9,17 +9,17 @@ It presents a canvas to viewing, drawing and editing of 3D annotations.
 
 If you make changes in this package, please do following:
 
-- After not important changes (typos, backward compatible bug fixes, refactoring) do: `npm version patch`
-- After changing API (backward compatible new features) do: `npm version minor`
-- After changing API (changes that break backward compatibility) do: `npm version major`
+- After not important changes (typos, backward compatible bug fixes, refactoring) do: `yarn version --patch`
+- After changing API (backward compatible new features) do: `yarn version --minor`
+- After changing API (changes that break backward compatibility) do: `yarn version --major`
 
 ## Commands
 
 - Building of the module from sources in the `dist` directory:
 
 ```bash
-npm run build
-npm run build -- --mode=development     # without a minification
+yarn run build
+yarn run build --mode=development     # without a minification
 ```
 
 ### API Methods

cvat-core/README.md

@@ -9,43 +9,43 @@ It contains the core logic of the Computer Vision Annotation Tool.
 
 If you make changes in this package, please do following:
 
-- After not important changes (typos, backward compatible bug fixes, refactoring) do: `npm version patch`
-- After changing API (backward compatible new features) do: `npm version minor`
-- After changing API (changes that break backward compatibility) do: `npm version major`
+- After not important changes (typos, backward compatible bug fixes, refactoring) do: `yarn version --patch`
+- After changing API (backward compatible new features) do: `yarn version --minor`
+- After changing API (changes that break backward compatibility) do: `yarn version --major`
 
 ### Commands
 
 - Dependencies installation
 
 ```bash
-npm ci
+yarn ci --frozen-lockfile
 ```
 
 - Building the module from sources in the `dist` directory:
 
 ```bash
-npm run build
-npm run build -- --mode=development     # without a minification
+yarn run build
+yarn run build --mode=development     # without a minification
 ```
 
 - Building the documentation in the `docs` directory:
 
 ```bash
-npm run-script docs
+yarn run docs
 ```
 
 - Running of tests:
 
 ```bash
-npm run-script test
+yarn run test
 ```
 
 - Updating of a module version:
 
 ```bash
-npm version patch   # updated after minor fixes
-npm version minor   # updated after major changes which don't affect API compatibility with previous versions
-npm version major   # updated after major changes which affect API compatibility with previous versions
+yarn version --patch   # updated after minor fixes
+yarn version --minor   # updated after major changes which don't affect API compatibility with previous versions
+yarn version --major   # updated after major changes which affect API compatibility with previous versions
 ```
 
 Visual studio code configurations:

cvat-core/package.json

@@ -9,7 +9,7 @@
     "docs": "jsdoc --readme README.md src/*.js -p -c jsdoc.config.js -d docs",
     "coveralls": "cat ./reports/coverage/lcov.info | coveralls",
     "type-check": "tsc --noEmit",
-    "type-check:watch": "npm run type-check -- --watch"
+    "type-check:watch": "yarn run type-check -- --watch"
   },
   "author": "Intel",
   "license": "MIT",

cvat-data/README.md

@@ -1,15 +1,15 @@
 # cvat-data module
 
 ```bash
-npm run build  # build with minification
-npm run build -- --mode=development     # build without minification
-npm run server # run debug server
+yarn run build  # build with minification
+yarn run build --mode=development     # build without minification
+yarn run server # run debug server
 ```
 
 ## Versioning
 
 If you make changes in this package, please do following:
 
-- After not important changes (typos, backward compatible bug fixes, refactoring) do: `npm version patch`
-- After changing API (backward compatible new features) do: `npm version minor`
-- After changing API (changes that break backward compatibility) do: `npm version major`
+- After not important changes (typos, backward compatible bug fixes, refactoring) do: `yarn version --patch`
+- After changing API (backward compatible new features) do: `yarn version --minor`
+- After changing API (changes that break backward compatibility) do: `yarn version --major`

cvat-data/package.json

@@ -5,10 +5,10 @@
   "main": "src/ts/cvat-data.ts",
   "scripts": {
     "patch": "cd src/ts && patch --dry-run --forward -p0 < 3rdparty_patch.diff >> /dev/null && patch -p0 < 3rdparty_patch.diff; true",
-    "build": "npm run patch; webpack --config ./webpack.config.js",
-    "server": "npm run patch; nodemon --watch config --exec 'webpack-dev-server --config ./webpack.config.js --mode=development --open'",
+    "build": "yarn run patch; webpack --config ./webpack.config.js",
+    "server": "yarn run patch; nodemon --watch config --exec 'webpack-dev-server --config ./webpack.config.js --mode=development --open'",
     "type-check": "tsc --noEmit",
-    "type-check:watch": "npm run type-check -- --watch"
+    "type-check:watch": "yarn run type-check -- --watch"
   },
   "author": "Intel",
   "license": "MIT",

cvat-ui/README.md

@@ -8,32 +8,32 @@ This is a client UI for Computer Vision Annotation Tool based on React, Redux an
 
 If you make changes in this package, please do following:
 
-- After not important changes (typos, bug fixes, refactoring) do: `npm version patch`
-- After adding new features do: `npm version minor`
-- After significant UI redesign do: `npm version major`
+- After not important changes (typos, bug fixes, refactoring) do: `yarn version --patch`
+- After adding new features do: `yarn version --minor`
+- After significant UI redesign do: `yarn version --major`
 
 Important: If you have changed versions for `cvat-core`, `cvat-canvas`, `cvat-data`,
-you also need to do `npm install` to update `package-lock.json`
+you also need to do `yarn install` to update `package-lock.json`
 
 ## Commands
 
 - Installing dependencies:
 
 ```bash
-cd ../cvat-core && npm ci && cd - && npm ci
+cd ../cvat-core && yarn --frozen-lockfile && cd - && yarn --frozen-lockfile
 ```
 
 - Running development UI server with autorebuild on change
 
 ```bash
-npm start
+yarn run start
 ```
 
 - Building the module from sources in the `dist` directory:
 
 ```bash
-npm run build
-npm run build -- --mode=development     # without a minification
+yarn run build
+yarn run build --mode=development     # without a minification
 ```
 
 Important: You also have to run CVAT REST API server (please read `https://openvinotoolkit.github.io/cvat/docs/contributing/`)

cvat-ui/package.json

@@ -7,7 +7,7 @@
     "build": "webpack --config ./webpack.config.js",
     "start": "webpack serve --env API_URL=http://localhost:7000 --config ./webpack.config.js --mode=development",
     "type-check": "tsc --noEmit",
-    "type-check:watch": "npm run type-check -- --watch",
+    "type-check:watch": "yarn run type-check -- --watch",
     "lint": "eslint './src/**/*.{ts,tsx}'",
     "lint:fix": "eslint './src/**/*.{ts,tsx}' --fix"
   },

lint-staged.config.js

@@ -22,11 +22,11 @@ module.exports = (stagedFiles) => {
 
     const mapping = {};
     const commands = [];
-    mapping['npm run precommit:cvat-ui -- '] = cvatUI.join(' ');
-    mapping['npm run precommit:cvat-data -- '] = cvatData.join(' ');
-    mapping['npm run precommit:cvat-core -- '] = cvatCore.join(' ');
-    mapping['npm run precommit:cvat-canvas -- '] = cvatCanvas.join(' ');
-    mapping['npm run precommit:cvat-canvas3d -- '] = cvatCanvas3d.join(' ');
+    mapping['yarn run precommit:cvat-ui -- '] = cvatUI.join(' ');
+    mapping['yarn run precommit:cvat-data -- '] = cvatData.join(' ');
+    mapping['yarn run precommit:cvat-core -- '] = cvatCore.join(' ');
+    mapping['yarn run precommit:cvat-canvas -- '] = cvatCanvas.join(' ');
+    mapping['yarn run precommit:cvat-canvas3d -- '] = cvatCanvas3d.join(' ');
 
     for (const command of Object.keys(mapping)) {
         const files = mapping[command];

package.json

@@ -3,6 +3,7 @@
   "version": "1.0.0",
   "description": "Eslint && remarklint dependencies",
   "main": ".eslintrc.js",
+  "private": true,
   "directories": {
     "test": "tests"
   },
@@ -89,7 +90,7 @@
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "coverage": "npm run instrument && npm run cp && npm run rm",
+    "coverage": "yarn run instrument && yarn run cp && yarn run rm",
     "instrument": "nyc instrument cvat-ui cvat-ui_cov && nyc instrument cvat-canvas cvat-canvas_cov && nyc instrument cvat-data cvat-data_cov && nyc instrument cvat-core cvat-core_cov",
     "cp": "cp -r cvat-ui_cov/* cvat-ui && cp -r cvat-canvas_cov/* cvat-canvas && cp -r cvat-data_cov/* cvat-data && cp -r cvat-core_cov/* cvat-core",
     "rm": "rm -rf cvat-ui_cov cvat-canvas_cov cvat-data_cov cvat-core_cov",
@@ -99,15 +100,15 @@
     "precommit:cvat-canvas": "cd cvat-canvas && eslint --fix",
     "precommit:cvat-canvas3d": "cd cvat-canvas3d && eslint --fix",
     "precommit:cvat-ui": "cd cvat-ui && eslint --fix",
-    "build:cvat-ui": "npm run build --workspace=cvat-ui",
-    "build:cvat-canvas": "npm run build --workspace=cvat-canvas",
-    "build:cvat-canvas3d": "npm run build --workspace=cvat-canvas3d",
-    "build:cvat-core": "npm run build --workspace=cvat-core",
-    "build:cvat-data": "npm run build --workspace=cvat-data",
-    "server:cvat-canvas": "npm run server --workspace=cvat-canvas",
-    "server:cvat-canvas3d": "npm run server --workspace=cvat-canvas3d",
-    "server:cvat-data": "npm run server --workspace=cvat-data",
-    "start:cvat-ui": "npm run start --workspace=cvat-ui"
+    "build:cvat-ui": "yarn workspace cvat-ui run build",
+    "build:cvat-canvas": "yarn workspace cvat-canvas run build",
+    "build:cvat-canvas3d": "yarn workspace cvat-canvas3d run build",
+    "build:cvat-core": "yarn workspace cvat-core run build",
+    "build:cvat-data": "yarn workspace cvat-data run build",
+    "server:cvat-canvas": "yarn workspace cvat-canvas run server",
+    "server:cvat-canvas3d": "yarn workspace cvat-canvas3d run server",
+    "server:cvat-data": "yarn workspace cvat-data run server",
+    "start:cvat-ui": "yarn workspace cvat-ui run start"
   },
   "repository": {
     "type": "git",
@@ -118,5 +119,12 @@
   "bugs": {
     "url": "https://github.com/openvinotoolkit/cvat/issues"
   },
-  "homepage": "https://github.com/openvinotoolkit/cvat#readme"
+  "homepage": "https://github.com/openvinotoolkit/cvat#readme",
+  "resolutions": {
+    "@types/react": "^17.0.30",
+    "@types/react-dom": "^18.0.5",
+    "@types/react-redux": "^7.1.24",
+    "@types/react-router-dom": "^5.3.3",
+    "@types/prettier": "2.4.1"
+  }
 }

site/content/en/docs/contributing/development-environment.md

@@ -15,9 +15,10 @@ description: 'Installing a development environment for different operating syste
   ```
 
   ```bash
-  # Install Node.js 16
+  # Install Node.js 16 and yarn
   curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash -
   sudo apt-get install -y nodejs
+  sudo npm install --global yarn
   ```
 
   MacOS 10.15
@@ -111,7 +112,7 @@ description: 'Installing a development environment for different operating syste
 - Install npm packages for UI (run the following command from CVAT root directory):
 
   ```bash
-  npm ci
+  yarn --frozen-lockfile
   ```
 
   > Note for Mac users
@@ -134,11 +135,11 @@ description: 'Installing a development environment for different operating syste
 - Start npm UI debug server (run the following command from CVAT root directory):
   - If you want to run CVAT in localhost:
     ```sh
-    npm run start:cvat-ui
+    yarn run start:cvat-ui
      ```
   - If you want to access CVAT from outside of your host:
     ```sh
-    CVAT_UI_HOST='<YOUR_HOST_IP>' npm run start:cvat-ui
+    CVAT_UI_HOST='<YOUR_HOST_IP>' yarn run start:cvat-ui
     ```
 - Open a new terminal window.
 - Run VScode from the virtual environment (run the following command from CVAT root directory):

site/content/en/docs/contributing/running-tests.md

@@ -25,14 +25,14 @@ description: 'Instructions on how to run all existence tests.'
 1. Install npm dependencies:
    ```
    cd tests
-   npm ci
+   yarn --frozen-lockfile
    ```
 
 **Running tests**
 
 ```
-npm run cypress:run:chrome
-npm run cypress:run:chrome:canvas3d
+yarn run cypress:run:chrome
+yarn run cypress:run:chrome:canvas3d
 ```
 
 # REST API tests
@@ -75,7 +75,7 @@ pytest ./tests/rest_api --rebuild
    ```
 1. Install npm dependencies:
    ```
-   npm ci
+   yarn --frozen-lockfile
    ```
 1. Run CVAT instance
    ```
@@ -90,5 +90,5 @@ pytest ./tests/rest_api --rebuild
 1. JS tests
    ```
    cd cvat-core
-   npm run test
+   yarn run test
    ```

tests/package.json

@@ -15,5 +15,6 @@
     "extract-zip": "^2.0.1",
     "fs-extra": "^10.1.0",
     "jimp": "^0.16.1"
-  }
+  },
+  "version": "0.0.0"
 }