Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump to 1.3.0 #20

Merged
merged 3 commits into from
Feb 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions embed/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# CHANGELOG

## 1.3.0

- Update `toml` dependency to 0.15.0 (#17 by @bramp)
- Required Dart SDK version is now 3.2 or higher

## 1.2.0

- New feature: embedding binary contents (#13 by @NicolaVerbeeck)
Expand Down
14 changes: 12 additions & 2 deletions embed/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,12 +177,13 @@ You can find many more examples in the following resources:

## How to use

Currently, there are 2 types of embedding methods:
Currently, there are 3 types of embedding methods:

- [Embed a text content as a String literal](#embed-a-text-content-as-a-string-literal)
- [Embed contents as binary](#embed-contents-as-binary)
- [Embed a structured data as a Dart object](#embed-a-structured-data-as-a-dart-object)

What content to embed and how to embed it can be described using predefined annotations. For example, you can use the `EmbedStr` annotation to embed a text content as a string literal. Note that only top-level variables can be annotated, as shown below:
What content to embed and how to embed it can be described using predefined annotations. For example, you can use the `EmbedStr` annotation to embed text content as a string literal. Note that only top-level variables can be annotated, as shown below:

```dart
@EmbedStr(...) // This is OK
Expand Down Expand Up @@ -430,6 +431,15 @@ flutter clean && flutter pub run build_runner build

<br/>

## Contributors

Thanks to all the contributors!

- [@NicolaVerbeeck](https://github.com/NicolaVerbeeck): Support embedding binary files ([#13](https://github.com/fujidaiti/embed.dart/pull/13))
- [@bramp](https://github.com/bramp): Bumped the toml and lint dependencies to their latest([#17](https://github.com/fujidaiti/embed.dart/pull/17))

<br/>

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
Expand Down
2 changes: 1 addition & 1 deletion embed/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: embed
description: Code generation for embedding arbitrary file content into Dart code.
version: 1.2.0
version: 1.3.0
repository: https://github.com/fujidaiti/embed.dart.git

environment:
Expand Down
4 changes: 4 additions & 0 deletions embed_annotation/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# CHANGELOG

## 1.2.1

- Documentation updates

## 1.2.0

- Added a new annotation for embedding binary contents (#13 by @NicolaVerbeeck)
Expand Down
7 changes: 3 additions & 4 deletions embed_annotation/lib/embed_annotation.dart
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
library embed_annotation;

/// Base class for the all annotation classes
/// that configures how content is embedded.
/// Base class for the all annotation classes that configures how content is embedded.
///
/// Use the one of the folowing subclasses to
/// configure how content should be embedded.
/// Use the one of the following subclasses to configure how content should be embedded.
///
/// * [EmbedStr] : For embedding a text content as a string literal.
/// * [EmbedBinary] : For embedding a binary data as an integer list or a base64 string.
/// * [EmbedLiteral] : For embedding a structured data as a dart object.
///
/// Only top level elements can be annotated with these annotations.
Expand Down
2 changes: 1 addition & 1 deletion embed_annotation/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: embed_annotation
description: A package exposing annotations for embed.
version: 1.2.0
version: 1.2.1
repository: https://github.com/fujidaiti/embed.dart.git

environment:
Expand Down
Loading