From ebbcb83464904fa1a108dfb05bdb3b7df9988d31 Mon Sep 17 00:00:00 2001 From: Boris Sekachev <40690378+bsekachev@users.noreply.github.com> Date: Thu, 25 Jul 2019 14:47:24 +0300 Subject: [PATCH] Renamed cvatjs to cvat-core (#590) * cvatjs => cvat-core * Updated version * Fixed docker directories --- .travis.yml | 2 +- .vscode/launch.json | 6 +++--- Dockerfile | 2 +- {cvatjs => cvat-core}/.eslintrc.js | 0 cvat-core/.gitignore | 4 ++++ {cvatjs => cvat-core}/README.md | 17 +++++++++-------- {cvatjs => cvat-core}/jest.config.js | 0 {cvatjs => cvat-core}/jsdoc.config.js | 0 {cvatjs => cvat-core}/package.json | 2 +- .../src/annotations-collection.js | 0 .../src/annotations-objects.js | 0 {cvatjs => cvat-core}/src/annotations-saver.js | 0 {cvatjs => cvat-core}/src/annotations.js | 0 {cvatjs => cvat-core}/src/api-implementation.js | 0 {cvatjs => cvat-core}/src/api.js | 0 {cvatjs => cvat-core}/src/common.js | 0 {cvatjs => cvat-core}/src/enums.js | 0 {cvatjs => cvat-core}/src/exceptions.js | 0 {cvatjs => cvat-core}/src/frames.js | 0 {cvatjs => cvat-core}/src/labels.js | 0 {cvatjs => cvat-core}/src/logging.js | 0 {cvatjs => cvat-core}/src/object-state.js | 0 {cvatjs => cvat-core}/src/plugins.js | 0 {cvatjs => cvat-core}/src/server-proxy.js | 0 {cvatjs => cvat-core}/src/session.js | 0 {cvatjs => cvat-core}/src/statistics.js | 0 {cvatjs => cvat-core}/src/user.js | 0 {cvatjs => cvat-core}/tests/api/annotations.js | 0 {cvatjs => cvat-core}/tests/api/frames.js | 0 {cvatjs => cvat-core}/tests/api/jobs.js | 0 {cvatjs => cvat-core}/tests/api/object-state.js | 0 {cvatjs => cvat-core}/tests/api/plugins.js | 0 {cvatjs => cvat-core}/tests/api/server.js | 0 {cvatjs => cvat-core}/tests/api/tasks.js | 0 {cvatjs => cvat-core}/tests/api/user.js | 0 .../tests/mocks/dummy-data.mock.js | 0 .../tests/mocks/server-proxy.mock.js | 0 {cvatjs => cvat-core}/webpack.config.js | 0 38 files changed, 19 insertions(+), 14 deletions(-) rename {cvatjs => cvat-core}/.eslintrc.js (100%) create mode 100644 cvat-core/.gitignore rename {cvatjs => cvat-core}/README.md (61%) rename {cvatjs => cvat-core}/jest.config.js (100%) rename {cvatjs => cvat-core}/jsdoc.config.js (100%) rename {cvatjs => cvat-core}/package.json (97%) rename {cvatjs => cvat-core}/src/annotations-collection.js (100%) rename {cvatjs => cvat-core}/src/annotations-objects.js (100%) rename {cvatjs => cvat-core}/src/annotations-saver.js (100%) rename {cvatjs => cvat-core}/src/annotations.js (100%) rename {cvatjs => cvat-core}/src/api-implementation.js (100%) rename {cvatjs => cvat-core}/src/api.js (100%) rename {cvatjs => cvat-core}/src/common.js (100%) rename {cvatjs => cvat-core}/src/enums.js (100%) rename {cvatjs => cvat-core}/src/exceptions.js (100%) rename {cvatjs => cvat-core}/src/frames.js (100%) rename {cvatjs => cvat-core}/src/labels.js (100%) rename {cvatjs => cvat-core}/src/logging.js (100%) rename {cvatjs => cvat-core}/src/object-state.js (100%) rename {cvatjs => cvat-core}/src/plugins.js (100%) rename {cvatjs => cvat-core}/src/server-proxy.js (100%) rename {cvatjs => cvat-core}/src/session.js (100%) rename {cvatjs => cvat-core}/src/statistics.js (100%) rename {cvatjs => cvat-core}/src/user.js (100%) rename {cvatjs => cvat-core}/tests/api/annotations.js (100%) rename {cvatjs => cvat-core}/tests/api/frames.js (100%) rename {cvatjs => cvat-core}/tests/api/jobs.js (100%) rename {cvatjs => cvat-core}/tests/api/object-state.js (100%) rename {cvatjs => cvat-core}/tests/api/plugins.js (100%) rename {cvatjs => cvat-core}/tests/api/server.js (100%) rename {cvatjs => cvat-core}/tests/api/tasks.js (100%) rename {cvatjs => cvat-core}/tests/api/user.js (100%) rename {cvatjs => cvat-core}/tests/mocks/dummy-data.mock.js (100%) rename {cvatjs => cvat-core}/tests/mocks/server-proxy.mock.js (100%) rename {cvatjs => cvat-core}/webpack.config.js (100%) diff --git a/.travis.yml b/.travis.yml index b9af3d96..f4218109 100644 --- a/.travis.yml +++ b/.travis.yml @@ -13,4 +13,4 @@ before_script: script: - docker exec -it cvat /bin/bash -c 'python3 manage.py test cvat/apps/engine' - - docker exec -it cvat /bin/bash -c 'cd cvatjs && npm install && npm run test && npm run coveralls' + - docker exec -it cvat /bin/bash -c 'cd cvat-core && npm install && npm run test && npm run coveralls' diff --git a/.vscode/launch.json b/.vscode/launch.json index 44bb77e6..e14338b0 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -122,7 +122,7 @@ "name": "cvat.js debug", "type": "node", "request": "launch", - "cwd": "${workspaceFolder}/cvatjs", + "cwd": "${workspaceFolder}/cvat-core", "runtimeExecutable": "node", "runtimeArgs": [ "--nolazy", @@ -135,10 +135,10 @@ "type": "node", "request": "launch", "name": "jest debug", - "program": "${workspaceFolder}/cvatjs/node_modules/.bin/jest", + "program": "${workspaceFolder}/cvat-core/node_modules/.bin/jest", "args": [ "--config", - "${workspaceFolder}/cvatjs/jest.config.js" + "${workspaceFolder}/cvat-core/jest.config.js" ], "console": "integratedTerminal", "internalConsoleOptions": "neverOpen", diff --git a/Dockerfile b/Dockerfile index ad0ac444..55ddbe4d 100644 --- a/Dockerfile +++ b/Dockerfile @@ -137,7 +137,7 @@ RUN if [ "$WITH_DEXTR" = "yes" ]; then \ COPY ssh ${HOME}/.ssh COPY cvat/ ${HOME}/cvat -COPY cvatjs/ ${HOME}/cvatjs +COPY cvat-core/ ${HOME}/cvat-core COPY tests ${HOME}/tests # Binary option is necessary to correctly apply the patch on Windows platform. # https://unix.stackexchange.com/questions/239364/how-to-fix-hunk-1-failed-at-1-different-line-endings-message diff --git a/cvatjs/.eslintrc.js b/cvat-core/.eslintrc.js similarity index 100% rename from cvatjs/.eslintrc.js rename to cvat-core/.eslintrc.js diff --git a/cvat-core/.gitignore b/cvat-core/.gitignore new file mode 100644 index 00000000..0409a55a --- /dev/null +++ b/cvat-core/.gitignore @@ -0,0 +1,4 @@ +docs +node_modules +reports +package-lock.json diff --git a/cvatjs/README.md b/cvat-core/README.md similarity index 61% rename from cvatjs/README.md rename to cvat-core/README.md index cc2b60ed..f2d22d21 100644 --- a/cvatjs/README.md +++ b/cvat-core/README.md @@ -1,32 +1,33 @@ -# Computer Vision Annotation Tool (JS) +# Module CVAT-CORE ## Description -This CVAT module has been created in order to easy integration process with CVAT. +This CVAT module is a clien-side JavaScipt library to management of objects, frames, logs, etc. +It contains the core logic of the Computer Vision Annotation Tool. -### Short development manual +### Commands -- Install dependencies +- Dependencies installation ```bash npm install ``` -- Build library from sources in ```dist``` directory: +- Building the module from sources in the ```dist``` directory: ```bash npm run-script build npm run build -- --mode=development # without a minification ``` -- Build documentation in ```docs``` directory: +- Building the documentation in the ```docs``` directory: ```bash npm run-script docs ``` -- Run tests: +- Running of tests: ```bash npm run-script test ``` -- Update version of library: +- 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 diff --git a/cvatjs/jest.config.js b/cvat-core/jest.config.js similarity index 100% rename from cvatjs/jest.config.js rename to cvat-core/jest.config.js diff --git a/cvatjs/jsdoc.config.js b/cvat-core/jsdoc.config.js similarity index 100% rename from cvatjs/jsdoc.config.js rename to cvat-core/jsdoc.config.js diff --git a/cvatjs/package.json b/cvat-core/package.json similarity index 97% rename from cvatjs/package.json rename to cvat-core/package.json index 3c7831cd..4573565b 100644 --- a/cvatjs/package.json +++ b/cvat-core/package.json @@ -1,6 +1,6 @@ { "name": "cvat.js", - "version": "1.0.0", + "version": "0.1.0", "description": "Part of Computer Vision Tool which presents an interface for client-side integration", "main": "babel.config.js", "scripts": { diff --git a/cvatjs/src/annotations-collection.js b/cvat-core/src/annotations-collection.js similarity index 100% rename from cvatjs/src/annotations-collection.js rename to cvat-core/src/annotations-collection.js diff --git a/cvatjs/src/annotations-objects.js b/cvat-core/src/annotations-objects.js similarity index 100% rename from cvatjs/src/annotations-objects.js rename to cvat-core/src/annotations-objects.js diff --git a/cvatjs/src/annotations-saver.js b/cvat-core/src/annotations-saver.js similarity index 100% rename from cvatjs/src/annotations-saver.js rename to cvat-core/src/annotations-saver.js diff --git a/cvatjs/src/annotations.js b/cvat-core/src/annotations.js similarity index 100% rename from cvatjs/src/annotations.js rename to cvat-core/src/annotations.js diff --git a/cvatjs/src/api-implementation.js b/cvat-core/src/api-implementation.js similarity index 100% rename from cvatjs/src/api-implementation.js rename to cvat-core/src/api-implementation.js diff --git a/cvatjs/src/api.js b/cvat-core/src/api.js similarity index 100% rename from cvatjs/src/api.js rename to cvat-core/src/api.js diff --git a/cvatjs/src/common.js b/cvat-core/src/common.js similarity index 100% rename from cvatjs/src/common.js rename to cvat-core/src/common.js diff --git a/cvatjs/src/enums.js b/cvat-core/src/enums.js similarity index 100% rename from cvatjs/src/enums.js rename to cvat-core/src/enums.js diff --git a/cvatjs/src/exceptions.js b/cvat-core/src/exceptions.js similarity index 100% rename from cvatjs/src/exceptions.js rename to cvat-core/src/exceptions.js diff --git a/cvatjs/src/frames.js b/cvat-core/src/frames.js similarity index 100% rename from cvatjs/src/frames.js rename to cvat-core/src/frames.js diff --git a/cvatjs/src/labels.js b/cvat-core/src/labels.js similarity index 100% rename from cvatjs/src/labels.js rename to cvat-core/src/labels.js diff --git a/cvatjs/src/logging.js b/cvat-core/src/logging.js similarity index 100% rename from cvatjs/src/logging.js rename to cvat-core/src/logging.js diff --git a/cvatjs/src/object-state.js b/cvat-core/src/object-state.js similarity index 100% rename from cvatjs/src/object-state.js rename to cvat-core/src/object-state.js diff --git a/cvatjs/src/plugins.js b/cvat-core/src/plugins.js similarity index 100% rename from cvatjs/src/plugins.js rename to cvat-core/src/plugins.js diff --git a/cvatjs/src/server-proxy.js b/cvat-core/src/server-proxy.js similarity index 100% rename from cvatjs/src/server-proxy.js rename to cvat-core/src/server-proxy.js diff --git a/cvatjs/src/session.js b/cvat-core/src/session.js similarity index 100% rename from cvatjs/src/session.js rename to cvat-core/src/session.js diff --git a/cvatjs/src/statistics.js b/cvat-core/src/statistics.js similarity index 100% rename from cvatjs/src/statistics.js rename to cvat-core/src/statistics.js diff --git a/cvatjs/src/user.js b/cvat-core/src/user.js similarity index 100% rename from cvatjs/src/user.js rename to cvat-core/src/user.js diff --git a/cvatjs/tests/api/annotations.js b/cvat-core/tests/api/annotations.js similarity index 100% rename from cvatjs/tests/api/annotations.js rename to cvat-core/tests/api/annotations.js diff --git a/cvatjs/tests/api/frames.js b/cvat-core/tests/api/frames.js similarity index 100% rename from cvatjs/tests/api/frames.js rename to cvat-core/tests/api/frames.js diff --git a/cvatjs/tests/api/jobs.js b/cvat-core/tests/api/jobs.js similarity index 100% rename from cvatjs/tests/api/jobs.js rename to cvat-core/tests/api/jobs.js diff --git a/cvatjs/tests/api/object-state.js b/cvat-core/tests/api/object-state.js similarity index 100% rename from cvatjs/tests/api/object-state.js rename to cvat-core/tests/api/object-state.js diff --git a/cvatjs/tests/api/plugins.js b/cvat-core/tests/api/plugins.js similarity index 100% rename from cvatjs/tests/api/plugins.js rename to cvat-core/tests/api/plugins.js diff --git a/cvatjs/tests/api/server.js b/cvat-core/tests/api/server.js similarity index 100% rename from cvatjs/tests/api/server.js rename to cvat-core/tests/api/server.js diff --git a/cvatjs/tests/api/tasks.js b/cvat-core/tests/api/tasks.js similarity index 100% rename from cvatjs/tests/api/tasks.js rename to cvat-core/tests/api/tasks.js diff --git a/cvatjs/tests/api/user.js b/cvat-core/tests/api/user.js similarity index 100% rename from cvatjs/tests/api/user.js rename to cvat-core/tests/api/user.js diff --git a/cvatjs/tests/mocks/dummy-data.mock.js b/cvat-core/tests/mocks/dummy-data.mock.js similarity index 100% rename from cvatjs/tests/mocks/dummy-data.mock.js rename to cvat-core/tests/mocks/dummy-data.mock.js diff --git a/cvatjs/tests/mocks/server-proxy.mock.js b/cvat-core/tests/mocks/server-proxy.mock.js similarity index 100% rename from cvatjs/tests/mocks/server-proxy.mock.js rename to cvat-core/tests/mocks/server-proxy.mock.js diff --git a/cvatjs/webpack.config.js b/cvat-core/webpack.config.js similarity index 100% rename from cvatjs/webpack.config.js rename to cvat-core/webpack.config.js