Skip to content

README_DEV.md

Latest commit

 

History

History
122 lines (77 loc) · 4.35 KB

README_DEV.md

File metadata and controls

122 lines (77 loc) · 4.35 KB

General information for NMRium development

Useful Visual Studio Code plugins

Commit messages

Please use conventional commit messages: https://www.conventionalcommits.org/en/v1.0.0/

Programming with React and D3

The idea is to use the approach described in the bottom of the document: React for element creation, D3 as the visualization kernel

Immutable JavaScript

Please read the following blog post:

https://dev.to/glebec/four-ways-to-immutability-in-javascript-3b3l

And in particular, we use Immer: https://github.com/immerjs/immer

Debug what changed to trigger a re-render

If you have a component that re-renders because of a hook that changed but you don't know which hook it was, you can temporarily add a call to useWhatChanged.

It will print to the console what changed at each render.

Remember to remove the call and the import when you have finished debugging!

import { useWhatChanged } from '@simbathesailor/use-what-changed';

export default function SomeComponent() {
  const [state, setState] = useState();
  const context1 = useSomeContext();
  const context2 = useSomeOtherContext();

  useWhatChanged([state, context1, context2], 'state,context1,context2');

  return <div />;
}

Testing

We use the Vitest test runner.

Keep the tests simple and focused. Do not hesitate to write many tests instead of doing everything in the same test. This is important because in case one test fails, the others will still run.

Use describe() blocks to group tests in a meaningful way. It is not useful to have only one big describe() with the name of the file.

Unit tests

Please write any unit test as close to the tested file as possible, in a __tests__ subdirectory. The test file's name should end with .test.{js,jsx,ts,tsx}.

For example, tests for the file located in src/data/data1d/autoPeakPicking.js should be written in src/data/data1d/__tests__/autoPeakPicking.test.js.

You can run all unit tests with node --run test-only.

End-to-end tests

End-to-end (e2e) tests are written in the test-e2e directory.

We use Playwright to write and run the tests in real browsers.

You can run all e2e tests with node --run test-e2e. Note that to test your latest changes, the dev server should be running (node --run dev). Otherwise, the last unminified production build from node --run build-no-minify will be used.

Useful links

The entire Playwright website is a good reference. Here are a few useful links:

Running and debugging tests

See: https://www.youtube.com/watch?v=JRuMGb3JE5k

To run a single test, use the --grep command-line flag:

npx playwright test --grep "my test"

You can grep by file name or test description.

If you want to do step debugging to see what happens in the page during the test, set the PWDEBUG environment variable:

PWDEBUG=1 npx playwright test --grep "my test"

You can also enable the slowMo mode, so that the actions are executed slower.

To do this, edit playwright.config.ts and uncomment the slowMo option.