Merge pull request #59 from pedrox-hs/feat/pubspec-gen/create-package

kodiakhq[bot] · web-flow · commit 16689b57239b · 2025-06-01T01:44:45.000Z
feat(package): Create pubspec_gen package
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -9,6 +9,7 @@ workspace:
   - auto_route/generator
   - error_adapter
   - logify
+  - pubspec_gen
   - shared_lints
   - shic
   - simple_nav
diff --git a/pubspec_gen/.gitignore b/pubspec_gen/.gitignore
@@ -0,0 +1,12 @@
+# https://dart.dev/guides/libraries/private-files
+# Created by `dart pub`
+.dart_tool/
+
+# Avoid committing pubspec.lock for library packages; see
+# https://dart.dev/guides/libraries/private-files#pubspeclock.
+pubspec.lock
+
+# Flutter
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
diff --git a/pubspec_gen/CHANGELOG.md b/pubspec_gen/CHANGELOG.md
@@ -0,0 +1,3 @@
+## 0.1.0
+
+- Initial version.
diff --git a/pubspec_gen/LICENSE b/pubspec_gen/LICENSE
@@ -0,0 +1,27 @@
+Copyright (c) 2025, Pedro Silva
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/pubspec_gen/README.md b/pubspec_gen/README.md
@@ -0,0 +1,129 @@
+# pubspec_gen
+
+[![pub package](https://img.shields.io/pub/v/pubspec_gen.svg)](https://pub.dev/packages/pubspec_gen)
+
+A Dart and Flutter builder that generates a Dart class containing information from `pubspec.yaml`.
+
+This allows you to access information like package name, version, description, repository URL, and more directly from your Dart code.
+
+---
+
+## 🚀 Motivation
+
+Keeping `pubspec.yaml` information accessible in code is useful for:
+
+- Displaying app name, version, or description in UIs or logs.
+- Avoiding hardcoding and duplication between `pubspec.yaml` and Dart code.
+- Building widgets or commands that reflect package metadata.
+
+---
+
+## ✨ Installation
+
+Add to your project's `pubspec.yaml`:
+
+```yaml
+dev_dependencies:
+  pubspec_gen: ^<latest_version>
+  build_runner: any
+```
+
+---
+
+## 🔧 Configuration (optional)
+
+You can customize which fields to generate by adding a `build.yaml` to your project:
+
+```yaml
+targets:
+  $default:
+    builders:
+      pubspec_gen|pubspec_gen:
+        options:
+          fields:
+            - path: name
+            - path: version
+            - path: description
+            - path: repository.url
+              name: repositoryUrl
+              default: https://github.com/example/repository
+```
+
+### 🏗️ Field properties:
+
+| Property  | Description                                                |
+| ----------| -----------------------------------------------------------|
+| `path`    | Path in YAML, supports nested (`repository.url`)           |
+| `name`    | (optional) Name of the property in the generated class     |
+| `default` | (optional) Default value if not found in pubspec.yaml      |
+
+If `name` is not set, it defaults to the normalized camelCase from `path`.
+
+---
+
+## 🛠️ Usage
+
+Run the builder:
+
+```bash
+dart run build_runner build
+```
+
+It generates:
+
+```
+lib/generated/pubspec_info.dart
+```
+
+Example usage:
+
+```dart
+import 'generated/pubspec_info.dart';
+
+void main() {
+  print('Package name: ${PubspecInfo.name}');
+  print('Version: ${PubspecInfo.version}');
+  print('Description: ${PubspecInfo.description}');
+}
+```
+
+---
+
+## 📜 Example of generated code
+
+```dart
+// GENERATED CODE - DO NOT MODIFY BY HAND
+// ignore_for_file: constant_identifier_names
+
+/// Package information generated from pubspec.yaml
+class PubspecInfo {
+  const PubspecInfo._();
+
+  static const String name = 'my_package';
+  static const String version = '1.0.0';
+  static const String description = 'My awesome package';
+  static const String repositoryUrl = 'https://github.com/example/repository';
+}
+```
+
+---
+
+## 🔍 Full example
+
+Check the [`example/`](./example) directory for a working example.
+
+---
+
+## 💡 Contributing
+
+Contributions are welcome! If you find any issues or have ideas for improvements:
+
+1. Open an issue.
+2. Submit a pull request.
+3. Feel free to suggest new features.
+
+---
+
+## 📝 License
+
+This project is licensed under the BSD-3-Clause License - see the [LICENSE](LICENSE) file for details.
diff --git a/pubspec_gen/analysis_options.yaml b/pubspec_gen/analysis_options.yaml
@@ -0,0 +1 @@
+include: package:shared_lints/dart.yaml
diff --git a/pubspec_gen/build.yaml b/pubspec_gen/build.yaml
@@ -0,0 +1,18 @@
+builders:
+  pubspec_gen:
+    import: "package:pubspec_gen/pubspec_gen.dart"
+    builder_factories: ["packageInfoBuilder"]
+    build_extensions: { "$package$": ["lib/generated/pubspec_info.dart"] }
+    auto_apply: root_package
+    build_to: source
+    defaults:
+      options:
+        output: lib/generated/pubspec_info.dart
+        class_name: PubspecInfo
+        header: |
+          // GENERATED CODE - DO NOT MODIFY BY HAND
+        fields:
+          - path: name
+            default: unknown_package
+          - path: version
+            default: 0.0.0
diff --git a/pubspec_gen/example/bin/pubspec_gen_example.dart b/pubspec_gen/example/bin/pubspec_gen_example.dart
@@ -0,0 +1 @@
+export 'package:pubspec_gen_example/main.dart';
diff --git a/pubspec_gen/example/build.yaml b/pubspec_gen/example/build.yaml
@@ -0,0 +1,12 @@
+targets:
+  $default:
+    builders:
+      pubspec_gen|pubspec_gen:
+        options:
+          fields:
+            - path: name
+            - path: version
+            - path: description
+            - path: repository.url
+              name: repositoryUrl
+              default: https://example.com/default
diff --git a/pubspec_gen/example/lib/generated/pubspec_info.dart b/pubspec_gen/example/lib/generated/pubspec_info.dart
diff --git a/pubspec_gen/example/lib/main.dart b/pubspec_gen/example/lib/main.dart
@@ -0,0 +1,7 @@
+import 'generated/pubspec_info.dart';
+
+void main() {
+  print('Package name: ${PubspecInfo.name}');
+  print('Version: ${PubspecInfo.version}');
+  print('Description: ${PubspecInfo.description}');
+}
diff --git a/pubspec_gen/example/pubspec.yaml b/pubspec_gen/example/pubspec.yaml
@@ -0,0 +1,14 @@
+name: pubspec_gen_example
+description: Example project for pubspec_gen
+version: 1.0.0
+publish_to: none
+
+environment:
+  sdk: '>=3.0.0 <4.0.0'
+
+dependencies:
+  pubspec_gen:
+    path: ../
+
+dev_dependencies:
+  build_runner: ^2.4.15
diff --git a/pubspec_gen/lib/pubspec_gen.dart b/pubspec_gen/lib/pubspec_gen.dart
@@ -0,0 +1,6 @@
+import 'package:build/build.dart';
+
+import 'src/package_info_builder.dart';
+
+Builder packageInfoBuilder(BuilderOptions options) =>
+    PackageInfoBuilder(options);
diff --git a/pubspec_gen/lib/src/field_config.dart b/pubspec_gen/lib/src/field_config.dart
@@ -0,0 +1,30 @@
+class FieldConfig {
+  FieldConfig({
+    required this.path,
+    required this.name,
+    required this.defaultValue,
+  });
+
+  factory FieldConfig.fromMap(Map<String, dynamic> map) {
+    final path = map['path'] as String;
+    final name = (map['name'] as String?) ?? _normalizePath(path);
+    final defaultValue = map.containsKey('default') ? map['default'] : '';
+
+    return FieldConfig(path: path, name: name, defaultValue: defaultValue);
+  }
+
+  final String path;
+  final String name;
+  final dynamic defaultValue;
+
+  static String _normalizePath(String path) {
+    final parts = path.split(RegExp(r'[._-]'));
+    final first = parts.first;
+    final rest = parts.skip(1).map((e) => e[0].toUpperCase() + e.substring(1));
+    return [first, ...rest].join();
+  }
+
+  @override
+  String toString() =>
+      'FieldConfig(path: "$path", name: "$name", defaultValue: "$defaultValue")';
+}
diff --git a/pubspec_gen/lib/src/package_info_builder.dart b/pubspec_gen/lib/src/package_info_builder.dart
@@ -0,0 +1,77 @@
+import 'dart:async';
+import 'package:build/build.dart';
+import 'package:yaml/yaml.dart';
+
+import 'field_config.dart';
+
+class PackageInfoBuilder implements Builder {
+  PackageInfoBuilder(BuilderOptions options)
+    : outputFile =
+          options.config['output'] as String? ??
+          'lib/generated/pubspec_info.dart',
+      className = options.config['class_name'] as String? ?? 'PubspecInfo',
+      header = options.config['header'] as String? ?? '',
+      fields =
+          ((options.config['fields'] ?? []) as List)
+              .cast<Map>()
+              .map((e) => FieldConfig.fromMap(e.cast()))
+              .toList();
+
+  final String outputFile;
+  final String className;
+  final String header;
+  final List<FieldConfig> fields;
+
+  @override
+  Map<String, List<String>> get buildExtensions => {
+    r'$package$': [outputFile],
+  };
+
+  @override
+  Future<void> build(BuildStep buildStep) async {
+    final inputId = AssetId(buildStep.inputId.package, 'pubspec.yaml');
+    if (!await buildStep.canRead(inputId)) {
+      return log.severe('pubspec.yaml not found');
+    }
+
+    final yamlContent = loadYaml(await buildStep.readAsString(inputId));
+
+    final buffer = StringBuffer();
+
+    if (header.isNotEmpty) {
+      buffer.writeln(header.replaceAll('\\n', '\n'));
+    }
+
+    buffer.writeln('''
+/// Package information generated from pubspec.yaml
+class $className {
+  const $className._();
+''');
+
+    for (final field in fields) {
+      final value =
+          _extractValue(yamlContent, field.path) ?? field.defaultValue;
+      final escapedValue = value.toString().replaceAll("'", "\\'");
+      buffer.writeln("  static const String ${field.name} = '$escapedValue';");
+    }
+
+    buffer.writeln('}');
+
+    final outputId = AssetId(buildStep.inputId.package, outputFile);
+
+    await buildStep.writeAsString(outputId, buffer.toString());
+  }
+
+  dynamic _extractValue(dynamic yaml, String path) {
+    final parts = path.split('.');
+    dynamic current = yaml;
+    for (final part in parts) {
+      if (current is Map && current.containsKey(part)) {
+        current = current[part];
+      } else {
+        return null;
+      }
+    }
+    return current;
+  }
+}
diff --git a/pubspec_gen/pubspec.yaml b/pubspec_gen/pubspec.yaml
@@ -0,0 +1,19 @@
+name: pubspec_gen
+description: Code generator for pubspec.yaml info like package name.
+version: 0.1.0
+homepage: https://github.com/pedrox-hs/flutter_packages
+repository: https://github.com/pedrox-hs/flutter_packages/tree/main/pubspec_gen
+
+environment:
+  sdk: ^3.7.2
+
+resolution: workspace
+
+dependencies:
+  yaml: ^3.1.3
+  build: ^2.4.2
+
+dev_dependencies:
+  build_test: ^2.2.3
+  shared_lints: ^0.1.0
+  test: ^1.24.0
diff --git a/pubspec_gen/test/analysis_options.yaml b/pubspec_gen/test/analysis_options.yaml
@@ -0,0 +1 @@
+include: package:shared_lints/test.yaml
diff --git a/pubspec_gen/test/src/package_info_builder_test.dart b/pubspec_gen/test/src/package_info_builder_test.dart

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## 0.1.0`
	`2`	`+`
	`3`	`+- Initial version.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+include: package:shared_lints/dart.yaml`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export 'package:pubspec_gen_example/main.dart';`