feat: Convert the package into a proper Command Line application (#6)

The package can now be activated and then run as a CLI tool.

Closes #4

Author: st-pasha

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+
+## 0.1.0
+
+- Initial release.

README.md

@@ -4,9 +4,14 @@ This is a command line tool that can parse your Dart files to extract API inform
 save that information into a file in JSON format. This output can then be consumed by downstream
 tools for a variety of purposes, for example to generate documentation.
 
+Install:
+```shell
+dart pub global activate dartdoc_json
+```
+
 Usage:
 ```shell
-dart run dartdoc_json.dart FILENAME(s)
+dartdoc_json FILENAME(s)
 ```
 
 

bin/main.dart

@@ -0,0 +1,74 @@
+import 'dart:convert';
+import 'dart:io';
+import 'package:analyzer/dart/analysis/features.dart';
+import 'package:analyzer/dart/analysis/utilities.dart';
+import 'package:args/args.dart';
+import 'package:dartdoc_json/dartdoc_json.dart';
+import 'package:path/path.dart' as path;
+
+void main(List<String> args) {
+  exitCode = 0;
+  final parser = ArgParser(usageLineLength: 80)
+    ..addOption(
+      'root',
+      abbr: 'r',
+      defaultsTo: '.',
+      help: 'The path to the root folder of the package. The input file names '
+          'will be resolved relative to this folder.',
+    )
+    ..addOption(
+      'output',
+      abbr: 'o',
+      defaultsTo: 'out.json',
+      help: 'Output file where the JSON will be written to.',
+    )
+    ..addFlag(
+      'pretty',
+      negatable: false,
+      help: 'Pretty-print the output JSON file.',
+    );
+  final arguments = parser.parse(args);
+  final root = arguments['root'] as String;
+  final output = arguments['output'] as String;
+  final pretty = arguments['pretty'] as bool;
+  final inputs = arguments.rest;
+  if (inputs.isEmpty) {
+    stdout.writeln(
+      'A command-line utility that can extract the API of dart file(s) and\n'
+      'save it in JSON format.',
+    );
+    stdout.writeln();
+    stdout.writeln('Usage: dart run dartdoc_json.dart <input> [Parameters]');
+    stdout.writeln();
+    stdout.writeln('Parameters:');
+    stdout.writeln(parser.usage);
+    exitCode = 1;
+    return;
+  }
+  if (!Directory(root).existsSync()) {
+    stderr.writeln('Directory `$root` does not exist');
+    exitCode = 2;
+    return;
+  }
+  final encoder =
+      pretty ? const JsonEncoder.withIndent('  ') : const JsonEncoder();
+
+  final result = <Map<String, dynamic>>[];
+  for (final input in inputs) {
+    final fullPath = path.canonicalize(path.join(root, input));
+    if (!File(fullPath).existsSync()) {
+      stderr.writeln('File `$fullPath` does not exist');
+      exitCode = 2;
+      return;
+    }
+    final parsed = parseFile(
+      path: fullPath,
+      featureSet: FeatureSet.latestLanguageVersion(),
+    );
+    final unit = serializeCompilationUnit(parsed.unit);
+    unit['source'] = input;
+    result.add(unit);
+  }
+  final json = encoder.convert(result);
+  File(output).writeAsStringSync(json);
+}

lib/dartdoc_json.dart

@@ -1,72 +1 @@
-import 'dart:convert';
-import 'dart:io';
-import 'package:analyzer/dart/analysis/features.dart';
-import 'package:analyzer/dart/analysis/utilities.dart';
-import 'package:args/args.dart';
-import 'package:dartdoc_json/src/compilation_unit.dart';
-import 'package:path/path.dart' as path;
-
-int main(List<String> args) {
-  final parser = ArgParser(usageLineLength: 80)
-    ..addOption(
-      'root',
-      abbr: 'r',
-      defaultsTo: '.',
-      help: 'The path to the root folder of the package. The input file names '
-          'will be resolved relative to this folder.',
-    )
-    ..addOption(
-      'output',
-      abbr: 'o',
-      defaultsTo: 'out.json',
-      help: 'Output file where the JSON will be written to.',
-    )
-    ..addFlag(
-      'pretty',
-      negatable: false,
-      help: 'Pretty-print the output JSON file.',
-    );
-  final arguments = parser.parse(args);
-  final root = arguments['root'] as String;
-  final output = arguments['output'] as String;
-  final pretty = arguments['pretty'] as bool;
-  final inputs = arguments.rest;
-  if (inputs.isEmpty) {
-    // ignore_for_file: avoid_print
-    print(
-      'A command-line utility that can extract the API of dart file(s) and\n'
-      'save it in JSON format.',
-    );
-    print('');
-    print('Usage: dart run dartdoc_json.dart <input> [Parameters]');
-    print('');
-    print('Parameters:');
-    print(parser.usage);
-    return 1;
-  }
-  if (!Directory(root).existsSync()) {
-    print('Directory `$root` does not exist');
-    return 2;
-  }
-  final encoder =
-      pretty ? const JsonEncoder.withIndent('  ') : const JsonEncoder();
-
-  final result = <Map<String, dynamic>>[];
-  for (final input in inputs) {
-    final fullPath = path.canonicalize(path.join(root, input));
-    if (!File(fullPath).existsSync()) {
-      print('File `$fullPath` does not exist');
-      return 2;
-    }
-    final parsed = parseFile(
-      path: fullPath,
-      featureSet: FeatureSet.latestLanguageVersion(),
-    );
-    final unit = serializeCompilationUnit(parsed.unit);
-    unit['source'] = input;
-    result.add(unit);
-  }
-  final json = encoder.convert(result);
-  File(output).writeAsStringSync(json);
-  return 0;
-}
+export 'src/compilation_unit.dart' show serializeCompilationUnit;

pubspec.yaml

@@ -18,3 +18,6 @@ dependencies:
 dev_dependencies:
   flame_lint: ^0.1.3
   test: any
+
+executables:
+  dartdoc_json: main