A react-md template that I use when spinning up new projects.
format- format all files with prettierlint- run eslint on all typescript and javascript files using @mlaursen/eslint-config- Note: strict eslint rules
typecheck- runtsc --noEmiton the project- Note: strict rules enforced
test- run tests with jest + ts-jestdev- start the development server with nextbuild- build the app for productionbuild-static- build the app as pre-compiled html pages (requires nogetServerSidePropsandgetInitialProps)start- run the production build
# run all tests yarn test # run all tests and display code coverage yarn test --coverage # run tests in watch mode yarn test --watch
Testing libraries included:
- @testing-library/react
- @testing-library/user-event
- @testing-library/jest-dom - just for the
extend-expectbehavior - jest-watch-typeahead - Filter your tests by file name or test name
Use the render from src/test-utils.tsx instead of the
one from @testing-library/react since it'll wrap the test in all the require
context providers.
TODO: Complete this section.
yarn add --dev cypress @testing-library/cypress yarn cypress open
- validate - Continuous integration by
running
yarn lint,yarn typecheck,yarn test --coverage - dependabot.yml - Keep dependencies up-to-date on a weekly schedule
- codeql_analysis.yml - check for security issues in code
New tags will be created after a new react-md version or when a major change
happens in the repo. The tags can be used to see a diff of changes by using the
"compare" view after
viewing a specific tag.