From 24335e5aac48db542c6ec30eeae2f22ad1f07d15 Mon Sep 17 00:00:00 2001 From: Joanna May Date: Thu, 29 Aug 2024 11:59:38 -0500 Subject: [PATCH] fix: file tree for testing --- .../docs/testing/{testing.md => testing.mdx} | 81 +++++++++++-------- 1 file changed, 46 insertions(+), 35 deletions(-) rename src/content/docs/testing/{testing.md => testing.mdx} (93%) diff --git a/src/content/docs/testing/testing.md b/src/content/docs/testing/testing.mdx similarity index 93% rename from src/content/docs/testing/testing.md rename to src/content/docs/testing/testing.mdx index 2e79663..0f36b5f 100644 --- a/src/content/docs/testing/testing.md +++ b/src/content/docs/testing/testing.mdx @@ -5,6 +5,8 @@ sidebar: order: 1 --- +import { FileTree, TabItem, Tabs } from '@astrojs/starlight/components'; + At Very Good Ventures, our goal is to achieve 100% test coverage on all projects. Writing tests not only helps to reduce the number of bugs, but also encourages code to be written in a very clean, consistent, and maintainable way. While testing can initially add some additional time to the project, the trade-off is fewer bugs, higher confidence when shipping, and less time spent in QA cycles. ## Organize test files @@ -13,41 +15,50 @@ Test files should be organized to match your project file structure. This `my_package` library contains `models` and `widgets`. The `test` folder should copy this structure: -```txt -my_package/ - |- lib/ - | |- models/ - | | - model_a.dart - | | - model_b.dart - | | - models.dart - | |- widgets/ - | | - widget_1.dart - | | - widget_2.dart - | | - widgets.dart - |- test/ - ... -``` - -Bad ❗️ - -```txt -test/ - |- model_a_test.dart - |- model_b_test.dart - |- widgets_test.dart -``` - -Good ✅ - -```txt -test/ - |- models/ - | - model_a_test.dart - | - model_b_test.dart - |- widgets/ - | - widget_1_test.dart - | - widget_2_test.dart -``` + + + - my_package/ + - lib/ + - models/ + - model_a.dart + - model_b.dart + - models.dart + - widgets/ + - widget_1.dart + - widget_2.dart + - widgets.dart + - test/ + ... + + + + + + + + - test/ + - models/ + - model_a_test.dart + - model_b_test.dart + - widgets/ + - widget_1_test.dart + - widget_2_test.dart + + + + + + + + + - test/ + - model_a_test.dart + - model_b_test.dart + - widgets_test.dart + + + + > Note: `models.dart` and `widgets.dart` are barrel files and do not need to be tested.