chore(docs): update readmes with new badges + new formatting (#234)

* chore(docs): update readmes with new badges + new formatting * chore: update recommendations in workspace settings and deps * chore(docs): address @coderabbitai code-review suggestions * chore(docs): add @coderabbitai badge to readmes * chore(docs): correct minor grammatical issues in readmes
tsinis · Oct 14, 2024 · e1e056a · e1e056a
1 parent 9d385f3
commit e1e056a
Show file tree

Hide file tree

Showing 9 changed files with 109 additions and 93 deletions.
diff --git a/.github/readme.md b/.github/readme.md
@@ -1,11 +1,14 @@
 [![CodeFactor](https://www.codefactor.io/repository/github/tsinis/sealed_world/badge)](https://www.codefactor.io/repository/github/tsinis/sealed_world)
 [![Codecov](https://codecov.io/github/tsinis/sealed_world/branch/main/graph/badge.svg)](https://app.codecov.io/github/tsinis/sealed_world/flags)
+![CodeRabbit](https://img.shields.io/badge/reviewed-code?style=flat&logo=vowpalwabbit&logoColor=orange&label=coderabbit&color=dark-green&link=https%3A%2F%2Fcoderabbit.ai)
+![Dart Code Metrics](https://img.shields.io/badge/passing-dcm?style=flat&logo=dart&logoColor=lightskyblue&label=dcm&color=dark-green&link=https%3A%2F%2Fdcm.dev)
 ![Last commit](https://img.shields.io/github/last-commit/tsinis/sealed_world)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+![GitHub stars](https://img.shields.io/github/stars/tsinis/sealed_world?style=flat&color=green)
+[![License MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ## Sealed World
 
-Pure Dart, fully tested and ISO-driven ecosystem for the world's data in form of compile-time, tree-shakable constant sealed classes.
+A pure Dart, fully tested and ISO-driven ecosystem for the world's data in the form of compile-time, tree-shakable constant sealed classes.
 
 > [!TIP]
 > Flutter packages follow a **world** prefix convention, whereas Dart packages utilize the **sealed** prefix.
@@ -14,9 +17,9 @@ Pure Dart, fully tested and ISO-driven ecosystem for the world's data in form of
 | ------------------------------------------------------------------------------------------------ | ----------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
 | [world_countries](https://github.com/tsinis/sealed_world/tree/main/packages/world_countries)     | **Flutter** | Country/phone/currency/language pickers and APIs for typed localizations. | [![pub.dev](https://img.shields.io/pub/v/world_countries.svg)](https://pub.dev/packages/world_countries)     |
 | [world_flags](https://github.com/tsinis/sealed_world/tree/main/packages/world_flags)             | **Flutter** | Country flags built entirely with Flutter's CustomPainters.               | [![pub.dev](https://img.shields.io/pub/v/world_flags.svg)](https://pub.dev/packages/world_flags)             |
-| [sealed_countries](https://github.com/tsinis/sealed_world/tree/main/packages/sealed_countries)   | Dart        | Countries in form of compile-time constant sealed classes.                | [![pub.dev](https://img.shields.io/pub/v/sealed_countries.svg)](https://pub.dev/packages/sealed_countries)   |
-| [sealed_currencies](https://github.com/tsinis/sealed_world/tree/main/packages/sealed_currencies) | Dart        | Currencies in form of compile-time constant sealed classes.               | [![pub.dev](https://img.shields.io/pub/v/sealed_currencies.svg)](https://pub.dev/packages/sealed_currencies) |
-| [sealed_languages](https://github.com/tsinis/sealed_world/tree/main/packages/sealed_languages)   | Dart        | Languages in form of compile-time constant sealed classes.                | [![pub.dev](https://img.shields.io/pub/v/sealed_languages.svg)](https://pub.dev/packages/sealed_languages)   |
+| [sealed_countries](https://github.com/tsinis/sealed_world/tree/main/packages/sealed_countries)   | Dart        | Countries in the form of compile-time constant sealed classes.            | [![pub.dev](https://img.shields.io/pub/v/sealed_countries.svg)](https://pub.dev/packages/sealed_countries)   |
+| [sealed_currencies](https://github.com/tsinis/sealed_world/tree/main/packages/sealed_currencies) | Dart        | Currencies in the form of compile-time constant sealed classes.           | [![pub.dev](https://img.shields.io/pub/v/sealed_currencies.svg)](https://pub.dev/packages/sealed_currencies) |
+| [sealed_languages](https://github.com/tsinis/sealed_world/tree/main/packages/sealed_languages)   | Dart        | Languages in the form of compile-time constant sealed classes.            | [![pub.dev](https://img.shields.io/pub/v/sealed_languages.svg)](https://pub.dev/packages/sealed_languages)   |
 
 **This ecosystem exhibits a strict hierarchical dependency structure**. At the foundation are **languages and scripts**, essential for localization and translation across all packages. Building upon this, **currencies** are required for subsequent packages dealing with **countries**. The **countries** package, is necessary for rendering country **flags**, which is then needed by the **world_countries** package for displaying localized (given that a locale typically consists of three components: language, script, and region/country) country, language and currency names, and also **flags** (for example within country/phone code pickers).
 

diff --git a/.vscode/sealed_world.code-workspace b/.vscode/sealed_world.code-workspace
@@ -38,12 +38,9 @@
   "settings": {
     "search.exclude": {
       "**/.git": true,
-      "**/.fvm": true,
       "coverage/**": true,
       "**/coverage/*": true,
-      "**/*.g.dart": true,
-      "**/*.freezed.dart": true,
-      "**/*.select.dart": true
+      "**/*.g.dart": true
     },
     "explorer.confirmDragAndDrop": false,
     "explorer.fileNesting.enabled": true,
@@ -164,43 +161,38 @@
       "alexisvt.flutter-snippets",
       "bierner.github-markdown-preview",
       "bierner.markdown-checkbox",
-      "blaxou.freezed",
       "circlecodesolution.ccs-flutter-color",
-      "codeium.codeium",
       "coenraads.bracket-pair-colorizer-2",
       "dart-code.dart-code",
       "dart-code.flutter",
       "davidanson.vscode-markdownlint",
       "esbenp.prettier-vscode",
-      "felixangelov.bloc",
       "formulahendry.code-runner",
       "foxundermoon.shell-format",
       "gaetschwartz.build-runner",
       "github.vscode-pull-request-github",
       "giyyapan.fast-snippet",
       "gmlewis-vscode.flutter-stylizer",
       "gruntfuggly.todo-tree",
-      "hirantha.json-to-dart",
       "ibm.output-colorizer",
       "jasonlhy.hungry-delete",
       "jeroen-meijer.pubspec-assist",
-      "kameshkotwani.google-search",
       "lacroixdavid1.vscode-format-context-menu",
       "marinv.flutter-print-tools",
       "nash.awesome-flutter-snippets",
       "nhoizey.gremlins",
       "peterhdd.dartgettersetter",
       "peterschmalfeldt.explorer-exclude",
       "plibither8.remove-comments",
+      "plugfox.flutter-plus",
       "prasadsunny1.flutter-create-wizard",
       "rafamel.subtle-brackets",
       "redhat.vscode-yaml",
       "ricardo-emerson.dart-data-class-tools",
       "stkb.rewrap",
       "streetsidesoftware.code-spell-checker",
       "tenraneko.pubspec-dependency-opener",
-      "tyriar.sort-lines",
-      "withfig.fig"
+      "tyriar.sort-lines"
     ]
   },
   "launch": {

diff --git a/packages/_sealed_world_tests/README.md b/packages/_sealed_world_tests/README.md
@@ -1,6 +1,10 @@
 [![CodeFactor](https://www.codefactor.io/repository/github/tsinis/sealed_world/badge)](https://www.codefactor.io/repository/github/tsinis/sealed_world)
 [![Codecov](https://codecov.io/github/tsinis/sealed_world/branch/main/graph/badge.svg)](https://app.codecov.io/github/tsinis/sealed_world/flags)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+![CodeRabbit](https://img.shields.io/badge/reviewed-code?style=flat&logo=vowpalwabbit&logoColor=orange&label=coderabbit&color=dark-green&link=https%3A%2F%2Fcoderabbit.ai)
+![Dart Code Metrics](https://img.shields.io/badge/passing-dcm?style=flat&logo=dart&logoColor=lightskyblue&label=dcm&color=dark-green&link=https%3A%2F%2Fdcm.dev)
+![Last commit](https://img.shields.io/github/last-commit/tsinis/sealed_world)
+![GitHub stars](https://img.shields.io/github/stars/tsinis/sealed_world?style=flat&color=green)
+[![License MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 # Internal Testing Package