chill-chinese/stroke-order-animator

Stroke order animator

Pub codecov

This package implements stroke order animations and quizzes of Chinese characters based on Make me a Hanzi, available under the ARPHIC public license.

Try the web version or see it in action in the Chill Chinese App.

Read the docs.

Check out the example.

https://raw.githubusercontent.com/chill-chinese/stroke-order-animator/HEAD/doc/output.gif

Contributing

Set up a developer environment

Install

• just

All available tasks can be displayed by running just.

The following tasks are a prerequisite for all other tasks. They are not added as dependencies to all other tasks because they take too long to execute and don't need to be executed often.

Install dependencies:

just get-dependencies

Run CI pipeline

Run the following commands to make sure that everything works as expected:

just lint
just test

Generate coverage report

Run the following to generate an HTML coverage report combining unit test and integration test coverage:

genhtml 'coverage/*_lcov.info' -o coverage/html --branch-coverage --ignore-errors inconsistent --ignore-errors count,count

Then open the resulting file in a browser, for example:

firefox coverage/html/index.html

Generate code

Code generation is used for test mocks. Generate code whenever you change the interface of a class that is mocked somewhere:

just generate-code

Generated code must be checked into source control so that it doesn't have to be rebuilt during every CI run.

Cut a release

• Set the local main branch to the desired commit
• Push the main branch!
• Run dart run tool/generate_changelog.dart <lastVersion> and prune output as desired
• Run gh release create or create a new release on GitHub
• Copy the changelog