You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

History

Roman Donchenko 85b5547541 Make the server proxy's properties visible to static analysis (#5345 ) Currently, all properties of the server proxy object are created using `Object.defineProperties` in the constructor, which means that IDEs like VS Code can't analyze the file's static structure to determine what properties there are and what types they have. Consequently, things like autocomplete and go-to-definition don't work. Fix that by removing the `ServerProxy` class altogether and exporting an anonymous object with all properties defined statically.		3 years ago
..
docs	Interpolation of polyshapes in CVAT (#1571 )	6 years ago
src	Make the server proxy's properties visible to static analysis (#5345 )	3 years ago
tests	Convert `api.ts`, `api-implementation.ts` and `frames.ts` to ES6 modules (#5283 )	3 years ago
.dockerignore	User interface with React and antd (#785 )	6 years ago
.eslintrc.js	Added some JEST tests to cover skeleton basic features (#4865 )	4 years ago
README.md	Replace npm with yarn (#113 )	4 years ago
jest.config.js	Added support of skeletons (#1 )	4 years ago
jsdoc.config.js	Fixed Intel license headers (#119 )	4 years ago
package.json	Added force logout on CVAT app start if token is missing (#5331 )	3 years ago
tsconfig.json	Convert `api.ts`, `api-implementation.ts` and `frames.ts` to ES6 modules (#5283 )	3 years ago
webpack.config.js	Typescripted cvat-core, cvat-data (#120 )	4 years ago

README.md

Module CVAT-CORE

Description

This CVAT module is a client-side JavaScript library for management of objects, frames, logs, etc. It contains the core logic of the Computer Vision Annotation Tool.

Versioning

If you make changes in this package, please do following:

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

yarn ci --frozen-lockfile

Building the module from sources in the dist directory:

yarn run build
yarn run build --mode=development     # without a minification

Building the documentation in the docs directory:

yarn run docs

Running of tests:

yarn run test

Updating of a module version:

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.js debug starts debugging with entrypoint api.js
cvat.js test builds library and runs entrypoint tests.js