Package structure improvements

miquelbeltran · miquelbeltran · commit 30de78200c57 · 2025-01-27T13:41:22.000+01:00
- Moved package source to `src`
- Exposed "public API" with `lib/raygun_cli.dart`
- Created empty example
- Updated `bin/raygun_cli.dart` to use the exposed public API
diff --git a/bin/raygun_cli.dart b/bin/raygun_cli.dart
@@ -1,7 +1,5 @@
 import 'package:args/args.dart';
-import 'package:raygun_cli/sourcemap/sourcemap_command.dart';
-import 'package:raygun_cli/symbols/flutter_symbols.dart';
-import 'package:raygun_cli/deployments/deployments_command.dart';
+import 'package:raygun_cli/raygun_cli.dart';
 
 const String version = '0.0.2';
 
diff --git a/example/main.dart b/example/main.dart
@@ -0,0 +1,5 @@
+void main() {
+  // This package is not intended to be used as a library.
+  // It is a command line tool.
+  // See README.md for usage.
+}
diff --git a/lib/raygun_cli.dart b/lib/raygun_cli.dart
@@ -0,0 +1,3 @@
+export 'src/sourcemap/sourcemap_command.dart';
+export 'src/symbols/flutter_symbols.dart';
+export 'src/deployments/deployments_command.dart';
diff --git a/lib/src/config_props.dart b/lib/src/config_props.dart
@@ -1,7 +1,7 @@
 import 'dart:io';
 
 import 'package:args/args.dart';
-import 'package:raygun_cli/environment.dart';
+import 'package:raygun_cli/src/environment.dart';
 
 /// A Config property is a value
 /// that can be set via argument
diff --git a/lib/src/deployments/deployments.dart b/lib/src/deployments/deployments.dart
@@ -1,9 +1,10 @@
 import 'dart:io';
 
-import 'package:raygun_cli/deployments/deployments_api.dart';
+import 'package:raygun_cli/src/deployments/deployments_api.dart';
 import 'package:args/args.dart';
 import '../config_props.dart';
 
+/// Deployments command
 class Deployments {
   final ArgResults command;
   final bool verbose;
@@ -13,6 +14,7 @@ class Deployments {
     required this.verbose,
   });
 
+  /// Notifies Raygun that a new deployment has been made.
   Future<void> notify() async {
     if (!command.wasParsed('version')) {
       print('Error: Missing "--version"');
diff --git a/lib/src/deployments/deployments_api.dart b/lib/src/deployments/deployments_api.dart
@@ -1,6 +1,7 @@
 import 'dart:convert';
 import 'package:http/http.dart' as http;
 
+/// Creates a deployment in Raygun.
 Future<bool> createDeployment({
   required String token,
   required String apiKey,
diff --git a/lib/src/deployments/deployments_command.dart b/lib/src/deployments/deployments_command.dart
@@ -1,10 +1,11 @@
 import 'dart:io';
 
 import 'package:args/args.dart';
-import 'package:raygun_cli/deployments/deployments.dart';
+import 'package:raygun_cli/src/deployments/deployments.dart';
 
 const kDeploymentsCommand = 'deployments';
 
+/// Builds the deployments command parser
 ArgParser buildParserDeployments() {
   return ArgParser()
     ..addFlag(
@@ -57,6 +58,7 @@ ArgParser buildParserDeployments() {
     );
 }
 
+/// Parses the deployments command arguments
 void parseDeploymentsCommand(ArgResults command, bool verbose) {
   if (command.wasParsed('help')) {
     print('Usage: raygun-cli deployments <arguments>');
diff --git a/lib/src/environment.dart b/lib/src/environment.dart
diff --git a/lib/src/sourcemap/flutter/sourcemap_flutter.dart b/lib/src/sourcemap/flutter/sourcemap_flutter.dart
@@ -1,9 +1,10 @@
 import 'dart:io';
 
-import 'package:raygun_cli/config_props.dart';
-import 'package:raygun_cli/sourcemap/sourcemap_api.dart';
-import 'package:raygun_cli/sourcemap/sourcemap_base.dart';
+import 'package:raygun_cli/src/config_props.dart';
+import 'package:raygun_cli/src/sourcemap/sourcemap_api.dart';
+import 'package:raygun_cli/src/sourcemap/sourcemap_base.dart';
 
+/// Uploads a Flutter web sourcemap file to Raygun.
 class SourcemapFlutter extends SourcemapBase {
   SourcemapFlutter({
     required super.command,
diff --git a/lib/src/sourcemap/node/sourcemap_node.dart b/lib/src/sourcemap/node/sourcemap_node.dart
@@ -1,7 +1,9 @@
 import 'dart:io';
 
-import 'package:raygun_cli/sourcemap/sourcemap_base.dart';
+import 'package:raygun_cli/src/sourcemap/sourcemap_base.dart';
 
+/// Uploads a Node app sourcemap file to Raygun.
+/// TODO: Not implemented yet.
 class SourcemapNode extends SourcemapBase {
   SourcemapNode({
     required super.command,
diff --git a/lib/src/sourcemap/sourcemap_api.dart b/lib/src/sourcemap/sourcemap_api.dart
@@ -1,6 +1,8 @@
 import 'dart:io';
 import 'package:http/http.dart' as http;
 
+/// Uploads a sourcemap file to Raygun.
+/// returns true if the upload was successful.
 Future<bool> uploadSourcemap({
   required String appId,
   required String token,
diff --git a/lib/src/sourcemap/sourcemap_base.dart b/lib/src/sourcemap/sourcemap_base.dart
@@ -1,13 +1,18 @@
 import 'package:args/args.dart';
 
+/// Base class for JavaScript sourcemap uploaders
 abstract class SourcemapBase {
   SourcemapBase({
     required this.command,
     required this.verbose,
   });
 
+  /// Command line arguments
   final ArgResults command;
+
+  /// Print verbose output
   final bool verbose;
 
+  /// Uploads the sourcemap
   Future<void> upload();
 }
diff --git a/lib/src/sourcemap/sourcemap_command.dart b/lib/src/sourcemap/sourcemap_command.dart
@@ -1,12 +1,13 @@
 import 'dart:io';
 
 import 'package:args/args.dart';
-import 'package:raygun_cli/sourcemap/flutter/sourcemap_flutter.dart';
-import 'package:raygun_cli/sourcemap/node/sourcemap_node.dart';
-import 'package:raygun_cli/sourcemap/sourcemap_single_file.dart';
+import 'package:raygun_cli/src/sourcemap/flutter/sourcemap_flutter.dart';
+import 'package:raygun_cli/src/sourcemap/node/sourcemap_node.dart';
+import 'package:raygun_cli/src/sourcemap/sourcemap_single_file.dart';
 
 const kSourcemapCommand = 'sourcemap';
 
+/// Creates a parser for the sourcemap command
 ArgParser buildParserSourcemap() {
   return ArgParser()
     ..addFlag(
@@ -48,6 +49,7 @@ ArgParser buildParserSourcemap() {
     );
 }
 
+/// Parses the sourcemap command
 void parseSourcemapCommand(ArgResults command, bool verbose) {
   if (command.wasParsed('help')) {
     print('Usage: raygun-cli sourcemap <arguments>');
diff --git a/lib/src/sourcemap/sourcemap_single_file.dart b/lib/src/sourcemap/sourcemap_single_file.dart
@@ -1,9 +1,10 @@
 import 'dart:io';
 
-import 'package:raygun_cli/config_props.dart';
-import 'package:raygun_cli/sourcemap/sourcemap_api.dart';
-import 'package:raygun_cli/sourcemap/sourcemap_base.dart';
+import 'package:raygun_cli/src/config_props.dart';
+import 'package:raygun_cli/src/sourcemap/sourcemap_api.dart';
+import 'package:raygun_cli/src/sourcemap/sourcemap_base.dart';
 
+/// Uploads a single sourcemap file to Raygun.
 class SourcemapSingleFile extends SourcemapBase {
   SourcemapSingleFile({
     required super.command,
diff --git a/lib/src/symbols/flutter_symbols.dart b/lib/src/symbols/flutter_symbols.dart
@@ -1,11 +1,12 @@
 import 'dart:io';
 
 import 'package:args/args.dart';
-import 'package:raygun_cli/config_props.dart';
-import 'package:raygun_cli/symbols/flutter_symbols_api.dart';
+import 'package:raygun_cli/src/config_props.dart';
+import 'package:raygun_cli/src/symbols/flutter_symbols_api.dart';
 
 const kSymbolsCommand = 'symbols';
 
+/// Parses the symbols command
 void parseSymbolsCommand(ArgResults command, bool verbose) {
   if (command.wasParsed('help')) {
     print(
@@ -73,6 +74,7 @@ Future<bool> _run({
   return false;
 }
 
+/// Builds the symbols command parser
 ArgParser buildParserSymbols() {
   return ArgParser()
     ..addFlag(
diff --git a/lib/src/symbols/flutter_symbols_api.dart b/lib/src/symbols/flutter_symbols_api.dart
@@ -2,6 +2,7 @@ import 'dart:convert';
 import 'dart:io';
 import 'package:http/http.dart' as http;
 
+/// Uploads Flutter symbols files to Raygun.
 Future<bool> uploadSymbols({
   required String appId,
   required String token,
@@ -42,6 +43,7 @@ Future<bool> uploadSymbols({
   }
 }
 
+/// Lists Flutter symbols files in Raygun.
 Future<bool> listSymbols({
   required String appId,
   required String token,
@@ -72,6 +74,7 @@ Future<bool> listSymbols({
   }
 }
 
+/// Deletes a Flutter symbols file in Raygun.
 Future<bool> deleteSymbols({
   required String appId,
   required String token,
diff --git a/test/config_props_test.dart b/test/config_props_test.dart
@@ -1,6 +1,6 @@
 import 'package:args/args.dart';
-import 'package:raygun_cli/config_props.dart';
-import 'package:raygun_cli/environment.dart';
+import 'package:raygun_cli/src/config_props.dart';
+import 'package:raygun_cli/src/environment.dart';
 import 'package:test/test.dart';
 
 void main() {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export 'src/sourcemap/sourcemap_command.dart';`
	`2`	`+export 'src/symbols/flutter_symbols.dart';`
	`3`	`+export 'src/deployments/deployments_command.dart';`