https://github.com/insign/dart_yaml2dart

Converts a YAML file to a Dart file containing global scope constants. It allows developers to easily use YAML data in their Dart projects by generating a separate file with all the YAML data as constants. Especially good for pubspec.yaml.
https://github.com/insign/dart_yaml2dart

dart pubspec yaml yml

Last synced: 4 months ago
JSON representation

Converts a YAML file to a Dart file containing global scope constants. It allows developers to easily use YAML data in their Dart projects by generating a separate file with all the YAML data as constants. Especially good for pubspec.yaml.

• Host: GitHub
• URL: https://github.com/insign/dart_yaml2dart
• Owner: insign
• License: bsd-3-clause
• Created: 2023-02-19T14:56:50.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-20T09:54:08.000Z (about 1 year ago)
• Last Synced: 2024-10-01T05:41:42.176Z (5 months ago)
• Topics: dart, pubspec, yaml, yml
• Language: Dart
• Homepage: https://pub.dev/packages/yaml2dart
• Size: 9.77 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# yaml2dart

Converts a YAML file to a Dart file containing global scope constants. It allows developers to easily use YAML data in their Dart projects by generating a separate file with all the YAML data as constants. Especially good for `pubspec.yaml`.

## Getting started

```dart

dart pub add yaml2dart

```

## Usage

Assuming that the `example.yaml` file contains the following:

```yaml

name: "My Project"

version: "1.0.0"

```

The code is:

```dart

import 'package:yaml2dart/yaml2dart.dart';

void main() async {

  // Create a converter instance with the input and output file paths.

  final converter = Yaml2Dart('pub.yaml', 'lib/example_constants.dart');

  // Convert the YAML to Dart.

  await converter.convert();

}

```

The `example_constants.dart` file will be generated with the following content:

```dart

const exampleName = 'My Project';

const exampleVersion = '1.0.0';

```

To test:

```dart

  // Use the generated constants in your project.

  import 'package:my_project/example_constants.dart';

  print('Example name: $exampleName');

  print('Example version: $exampleVersion');

```

## LICENSE

[BSD 3-Clause License](./LICENSE)

## CONTRIBUTE

If you have an idea for a new feature or have found a bug, just do a pull request (PR).