Skip to content

README_DEVELOPERS.md

Latest commit

 

History

History
111 lines (79 loc) · 2.61 KB

README_DEVELOPERS.md

File metadata and controls

111 lines (79 loc) · 2.61 KB

Testing

Build docker image

$ pnpm --filter devextreme-cli run docker:build

Run docker image with browser

$ pnpm --filter devextreme-cli run docker:run

Run tests

To run tests for all target frameworks, use the following command:

$ pnpm run test

This script creates test applications in the testing/sandbox folder, starts a web server for each framework, and runs the snapshot tests.

You can find test results in the following folders:

  • packages/devextreme-cli/testing/__tests__/__image_snapshots__ - reference snapshots
  • packages/devextreme-cli/testing/__tests__/__diff_snapshots__ - diff snapshots for failed tests
  • packages/devextreme-cli/testing/sandbox/logs - server logs for each framework

Generate Applications

pnpm run create-template

Generate Applications for an Individual Framework

pnpm run create-template -e angular
pnpm run create-template -e react
pnpm run create-template -e react-ts
pnpm run create-template -e vue-v3

Lint Applications

pnpm run lint-template

Lint Applications for an Individual Framework

pnpm run lint-template -e angular
pnpm run lint-template -e react
pnpm run lint-template -e react-ts
pnpm run lint-template -e vue-v3

Test Applications

pnpm run test-template

Test Applications for an Individual Framework

pnpm run test-template -e angular
pnpm run test-template -e react
pnpm run test-template -e react-ts
pnpm run test-template -e vue-v3

Run Tests for Existing Test Applications

pnpm run test-dev

Run Tests for an Individual Framework

pnpm run test -t angular
pnpm run test -t react
pnpm run test -t react-ts
pnpm run test -t vue-v3

Replace etalon

To replace etalon image just remove it from packages/devextreme-cli/testing/__tests__/__image_snapshots__ folder and run tests again

Modify an Application Template

Modifying an application template directly is not recommended. Instead, generate a real application based on this template and modify this application. This is easier because a real application can be run, and you can see how your modifications affect it. Follow these instructions:

  1. Generate an application based on the template in the testing/sandbox folder.

  2. Modify the application as required.

  3. Run a script that updates templates for all frameworks:

    pnpm run update-template

    ... or a script that updates the template for an individual framework:

    pnpm run update-template -p angular
pnpm run update-template -p react-ts
pnpm run update-template -p vue-v3