feat: #2 improve pubdev scores

[TheRealAgentK]

feat: #2 - Improve pubdev score

Description 📝

• Purpose: Get to the max pubdev score that we can
• Approach: Changes suggested by pubdev tooling

Type of change

• New feature (non-breaking change which adds functionality)

Updates

👉 Package dependency changes for better up/downgrades
👉 Structural changes to adhere to format pubdev requires

Author to check 👓

• Project and all contained modules builds successfully
• Self-/dev-tested
• Unit/UI/Automation/Integration tests provided where applicable
• Code is written to standards
• Appropriate documentation written (code comments, internal docs)

Reviewer to check ✔️

• Project and all contained modules builds successfully
• Change has been dev-/reviewer-tested, where possible
• Unit/UI/Automation/Integration tests provided where applicable
• Code is written to standards
• Appropriate documentation written (code comments, internal docs)

[miquelbeltran]

I run the tool they use to calculate the score locally https://pub.dev/packages/pana and currently gives a 140/160. Providing docs give 0/20, I will improve that and push to this branch directly.

[miquelbeltran]

I've done some package structure changes.

• Moved package source to lib/src
• Exposed "public API" with lib/raygun_cli.dart, to be used by the bin/raygun_cli.dart entry point
• Created empty example
• Updated bin/raygun_cli.dart to use the exposed public API

The result from "pana" reads now 160/160. Details below.

---

✓ Follow Dart file conventions (30 / 30)

[*] 10/10 points: Provide a valid pubspec.yaml

[*] 5/5 points: Provide a valid README.md

[*] 5/5 points: Provide a valid CHANGELOG.md

[*] 10/10 points: Use an OSI-approved license

Detected license: MIT.

✓ Provide documentation (20 / 20)

[*] 10/10 points: 20% or more of the public API has dartdoc comments

6 out of 13 API elements (46.2 %) have documentation comments.

Some symbols that are missing documentation: raygun_cli, raygun_cli.buildParserProguard, raygun_cli.kDeploymentsCommand, raygun_cli.kProguardCommand, raygun_cli.kSourcemapCommand.

[*] 10/10 points: Package has an example

✓ Platform support (20 / 20)

[*] 20/20 points: Supports 5 of 6 possible platforms (iOS, Android, Web, Windows, macOS, Linux)

• ✓ Android

• ✓ iOS

• ✓ Windows

• ✓ Linux

• ✓ macOS

These platforms are not supported:

Package not compatible with platform Web

Because:

• package:raygun_cli/raygun_cli.dart that imports:
• package:raygun_cli/src/symbols/flutter_symbols.dart that imports:
• package:raygun_cli/src/symbols/flutter_symbols_api.dart that imports:
• dart:io

[x] 0/0 points: WASM compatibility

Package not compatible with runtime wasm

Because:

• package:raygun_cli/raygun_cli.dart that imports:
• package:raygun_cli/src/symbols/flutter_symbols.dart that imports:
• package:raygun_cli/src/symbols/flutter_symbols_api.dart that imports:
• dart:io

This package is not compatible with runtime wasm, and will not be rewarded full points in a future version of the scoring model.

See https://dart.dev/web/wasm for details.

✓ Pass static analysis (50 / 50)

[*] 50/50 points: code has no errors, warnings, lints, or formatting issues

✓ Support up-to-date dependencies (40 / 40)

[*] 10/10 points: All of the package dependencies are supported in the latest version

Package	Constraint	Compatible	Latest
args	^2.6.0	2.6.0	2.6.0
http	^1.3.0	1.3.0	1.3.0

Transitive dependencies

Package	Constraint	Compatible	Latest
async	-	2.12.0	2.12.0
collection	-	1.19.1	1.19.1
http_parser	-	4.1.2	4.1.2
meta	-	1.16.0	1.16.0
path	-	1.9.1	1.9.1
source_span	-	1.10.1	1.10.1
string_scanner	-	1.4.1	1.4.1
term_glyph	-	1.2.2	1.2.2
typed_data	-	1.4.0	1.4.0
web	-	1.1.0	1.1.0

To reproduce run dart pub outdated --no-dev-dependencies --up-to-date --no-dependency-overrides.

[*] 10/10 points: Package supports latest stable Dart and Flutter SDKs

[*] 20/20 points: Compatible with dependency constraint lower bounds

pub downgrade does not expose any static analysis error.

Points: 160/160.

[TheRealAgentK]

Woohoo, game completed :)