Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/FlutterGen/flutter_gen
The Flutter code generator for your assets, fonts, colors, … — Get rid of all String-based APIs.
https://github.com/FlutterGen/flutter_gen
assets code-generator dart flutter fluttergen fonts swiftgen templates
Last synced: about 2 months ago
JSON representation
The Flutter code generator for your assets, fonts, colors, … — Get rid of all String-based APIs.
- Host: GitHub
- URL: https://github.com/FlutterGen/flutter_gen
- Owner: FlutterGen
- License: mit
- Created: 2020-08-21T09:09:54.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-20T19:53:59.000Z (2 months ago)
- Last Synced: 2024-04-21T21:07:39.390Z (about 2 months ago)
- Topics: assets, code-generator, dart, flutter, fluttergen, fonts, swiftgen, templates
- Language: Dart
- Homepage: https://pub.dev/packages/flutter_gen
- Size: 4.63 MB
- Stars: 1,398
- Watchers: 17
- Forks: 141
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Lists
- awesome-flutter - FlutterGen - Assets code generator for your images, fonts, colors, etc — Get rid of String-based APIs. (Utilities / Top)
- awesome-flutter-cn - FlutterGen - 引用静态资源(图片,字体,颜色等)代码生成器 (工具集 / 热门的)
- awesome-flutter-cn - FlutterGen - 用于生成图像、字体、颜色等的资产代码的生成器,摆脱基于字符串的API。 (实用工具 / Top)
- awesome-flutter - FlutterGen - Assets code generator for your images, fonts, colors, etc — Get rid of String-based APIs. (Utilities / Top)
- awesome-flutter - FlutterGen - Assets code generator for your images, fonts, colors, etc — Get rid of String-based APIs. (Utilities / Top)
- awesome-stars - flutter_gen - based APIs. | FlutterGen | 1431 | (Dart)
- awesome-flutter - FlutterGen - Assets code generator for your images, fonts, colors, etc — Get rid of String-based APIs. (Utilities / Top)
- awesome-flutter - FlutterGen - Assets code generator for your images, fonts, colors, etc — Get rid of String-based APIs. (Utilities / Top)
- awesome-flutter - FlutterGen - Assets code generator for your images, fonts, colors, etc — Get rid of String-based APIs. (Utilities / Top)
- awesome-flutter - FlutterGen - The Flutter code generator for your assets, fonts, colors, … — Get rid of all String-based APIs. ` 📝 10 days ago ` (Utilities [🔝](#readme))
README
The Flutter code generator for your assets, fonts, colors, … — Get rid of all String-based APIs.
Inspired by [SwiftGen](https://github.com/SwiftGen/SwiftGen).
## Motivation
Using asset path string directly is not safe.
```yaml
# pubspec.yaml
flutter:
assets:
- assets/images/profile.jpg
```❌ **Bad**
What would happen if you made a typo?```dart
Widget build(BuildContext context) {
return Image.asset('assets/images/profile.jpeg');
}// The following assertion was thrown resolving an image codec:
// Unable to load asset: assets/images/profile.jpeg
```⭕️ **Good**
We want to use it safely.```dart
Widget build(BuildContext context) {
return Assets.images.profile.image();
}
```## Installation
### Homebrew
Works with macOS and Linux.
```sh
brew install FlutterGen/tap/fluttergen
```### Pub Global
Works with macOS, Linux and Windows.
```sh
dart pub global activate flutter_gen
```You might need to [set up your path](https://dart.dev/tools/pub/cmd/pub-global#running-a-script-from-your-path).
### As a part of build_runner
1. Add [build_runner] and [FlutterGen] to your package's pubspec.yaml file:
```
dev_dependencies:
build_runner:
flutter_gen_runner:
```2. Install [FlutterGen]
```sh
flutter pub get
```3. Use [FlutterGen]
```sh
dart run build_runner build
```## Usage
Run `fluttergen` after the configuration [`pubspec.yaml`](https://dart.dev/tools/pub/pubspec).
```sh
fluttergen -hfluttergen -c example/pubspec.yaml
```## Configuration file
[FlutterGen] generates dart files based on the key **`flutter`** and **`flutter_gen`** of [`pubspec.yaml`](https://dart.dev/tools/pub/pubspec).
Default configuration can be found [here](https://github.com/FlutterGen/flutter_gen/tree/main/packages/core/lib/settings/config_default.dart).```yaml
# pubspec.yaml
# ...flutter_gen:
output: lib/gen/ # Optional (default: lib/gen/)
line_length: 80 # Optional (default: 80)# Optional
integrations:
flutter_svg: true
flare_flutter: true
rive: true
lottie: truecolors:
inputs:
- assets/color/colors.xmlflutter:
uses-material-design: true
assets:
- assets/images/fonts:
- family: Raleway
fonts:
- asset: assets/fonts/Raleway-Regular.ttf
- asset: assets/fonts/Raleway-Italic.ttf
style: italic
```## Available Parsers
### Assets
Just follow the doc [Adding assets and images#Specifying assets](https://flutter.dev/docs/development/ui/assets-and-images#specifying-assets) to specify assets, then [FlutterGen] will generate related dart files.
No other specific configuration is required.
_Ignore duplicated._```yaml
# pubspec.yaml
flutter:
assets:
- assets/images/
- assets/images/chip3/chip.jpg
- assets/images/chip4/chip.jpg
- assets/images/icons/paint.svg
- assets/images/icons/[email protected]
- assets/json/fruits.json
- assets/flare/Penguin.flr
- assets/rive/vehicles.riv
- pictures/ocean_view.jpg
```These configurations will generate **`assets.gen.dart`** under the **`lib/gen/`** directory by default.
#### Generate for packages
If you want to generate assets for a package,
use `package_parameter_enabled` under `flutter_gen > assets > outputs`.```yaml
flutter_gen:
assets:
outputs:
package_parameter_enabled: true # <- Add this line.
```This would add the package constant to the generated class. For example:
```dart
class Assets {
Assets._();static const String package = 'test';
static const $AssetsImagesGen images = $AssetsImagesGen();
static const $AssetsUnknownGen unknown = $AssetsUnknownGen();
}
```Then you can use assets with the package implicitly or explicitly:
```dart
// Implicit usage for `Image`/`SvgPicture`/`Lottie`.
Widget build(BuildContext context) {
return Assets.images.icons.paint.svg(
width: 120,
height: 120,
);
}
```
or
```dart
// Explicit usage for `Image`/`SvgPicture`/`Lottie`.
Widget build(BuildContext context) {
return SvgPicture.asset(
Assets.images.icons.paint.path,
package: Assets.package,
width: 120,
height: 120,
);
}
```#### Generate directories path
If you want to generate the path of directories,
use `directory_path_enabled` under `flutter_gen > assets > outputs`.```yaml
flutter_gen:
assets:
outputs:
directory_path_enabled: true # <- Add this line.
```This would add the `path` getter to the generated directory class. For example:
```dart
class $AssetsImagesGen {
const $AssetsImagesGen();///******///
/// Directory path: assets/images
String get path => 'assets/images';
}
```#### Including additional metadata
At build time, additional metadata may be included in the generated class, by using the
`parse_metadata` option.```yaml
flutter_gen:
parse_metadata: true # <- Add this line (default: false)
```For image based assets, a new nullable `size` field is added to the
generated class. For example:```dart
AssetGenImage get logo =>
const AssetGenImage('assets/images/logo.png', size: Size(209.0, 49.0));
```Which can now be used at runtime without parsing the information from the actual asset.
```dart
Widget build(BuildContext context) {
return Assets.images.logo.size!.width;
}
```#### Usage Example
[FlutterGen] generates [Image](https://api.flutter.dev/flutter/widgets/Image-class.html) class if the asset is Flutter supported image format.
Example results of `assets/images/chip.jpg`:
- **`Assets.images.chip`** is an implementation of [`AssetImage class`](https://api.flutter.dev/flutter/painting/AssetImage-class.html).
- **`Assets.images.chip.image(...)`** returns [`Image class`](https://api.flutter.dev/flutter/widgets/Image-class.html).
- **`Assets.images.chip.provider(...)`** returns [`ImageProvider class`](https://api.flutter.dev/flutter/painting/ImageProvider-class.html).
- **`Assets.images.chip.path`** just returns the path string.
- **`Assets.images.chip.values`** just returns the values list.```dart
Widget build(BuildContext context) {
return Assets.images.chip.image();
}Widget build(BuildContext context) {
return Assets.images.chip.image(
width: 120,
height: 120,
fit: BoxFit.scaleDown,
);Widget build(BuildContext context) {
// Assets.images.chip.path = 'assets/images/chip3/chip3.jpg'
return Image.asset(Assets.images.chip.path);
}```
If you are using SVG images with [flutter_svg](https://pub.dev/packages/flutter_svg) you can use the integration feature.
```yaml
# pubspec.yaml
flutter_gen:
integrations:
flutter_svg: trueflutter:
assets:
- assets/images/icons/paint.svg
``````dart
Widget build(BuildContext context) {
return Assets.images.icons.paint.svg(
width: 120,
height: 120
);
}
```**Available Integrations**
|Packages|File extension|Setting|Usage|
|--|--|--|--|
|[flutter_svg](https://pub.dev/packages/flutter_svg)|.svg| `flutter_svg: true` |Assets.images.icons.paint.**svg()**|
|[flare_flutter](https://pub.dev/packages/flare_flutter)|.flr| `flare_flutter: true` |Assets.flare.penguin.**flare()**|
|[rive](https://pub.dev/packages/rive)|.flr| `rive: true` |Assets.rive.vehicles.**rive()**|
|[lottie](https://pub.dev/packages/lottie)|.json| `lottie: true` |Assets.lottie.hamburgerArrow.**lottie()**|
In other cases, the asset is generated as String class.
```dart
// If don't use the Integrations.
final svg = SvgPicture.asset(Assets.images.icons.paint);final json = await rootBundle.loadString(Assets.json.fruits);
```[FlutterGen] also support generating other style of `Assets` class:
```yaml
# pubspec.yaml
flutter_gen:
assets:
outputs:
# Assets.imagesChip
# style: camel-case# Assets.images_chip
# style: snake-case# Assets.images.chip (default style)
# style: dot-delimiterflutter:
assets:
- assets/images/chip.png
```The root directory will be omitted if it is either **`assets`** or **`asset`**.
```
assets/images/chip3/chip.jpg => Assets.images.chip3.chip
assets/images/chip4/chip.jpg => Assets.images.chip4.chip
assets/images/icons/paint.svg => Assets.images.icons.paint
assets/images/icons/[email protected] => Assets.images.icons.dartTest
assets/json/fruits.json => Assets.json.fruits
pictures/ocean_view.jpg => Assets.pictures.oceanView
```[Example of code generated by FlutterGen](https://github.com/FlutterGen/flutter_gen/blob/main/examples/example/lib/gen/assets.gen.dart)
### Fonts
Just follow the doc [Use a custom font](https://flutter.dev/docs/cookbook/design/fonts) to specify fonts, then [FlutterGen] will generate related dart files.
No other specific configuration is required.
_Ignore duplicated._```yaml
# pubspec.yaml
flutter:
fonts:
- family: Raleway
fonts:
- asset: assets/fonts/Raleway-Regular.ttf
- asset: assets/fonts/Raleway-Italic.ttf
style: italic
- family: RobotoMono
fonts:
- asset: assets/fonts/RobotoMono-Regular.ttf
- asset: assets/fonts/RobotoMono-Bold.ttf
weight: 700
```These configurations will generate **`fonts.gen.dart`** under the **`lib/gen/`** directory by default.
#### Usage Example
```dart
Text(
'Hi there, I\'m FlutterGen',
style: TextStyle(
fontFamily: FontFamily.robotoMono,
fontFamilyFallback: const [FontFamily.raleway],
),
```[Example of code generated by FlutterGen](https://github.com/FlutterGen/flutter_gen/tree/main/examples/example/lib/gen/fonts.gen.dart)
### Colors
[FlutterGen] supports generating colors from [XML](example/assets/color/colors.xml) format files.
_Ignore duplicated._```yaml
# pubspec.yaml
flutter_gen:
colors:
inputs:
- assets/color/colors.xml
- assets/color/colors2.xml
```[FlutterGen] can generate a [Color](https://api.flutter.dev/flutter/material/Colors-class.html) class based on the `name` attribute and the color hex value.
If the element has the attribute `type`, then a specially color will be generated.Currently supported special color types:
- [MaterialColor](https://api.flutter.dev/flutter/material/MaterialColor-class.html)
- [MaterialAccentColor](https://api.flutter.dev/flutter/material/MaterialAccentColor-class.html)> Noticed that there is no official material color generation algorithm. The implementation is based on the [mcg](https://github.com/mbitson/mcg) project.
```xml
#F5CB84
#955E1C
#DF9527
```These configurations will generate **`colors.gen.dart`** under the **`lib/gen/`** directory by default.
#### Usage Example
```dart
Text(
'Hi there, I\'m FlutterGen',
style: TextStyle(
color: ColorName.denim,
),
```[Example of code generated by FlutterGen](https://github.com/FlutterGen/flutter_gen/tree/main/examples/example/lib/gen/colors.gen.dart)
## Credits
The material color generation implementation is based on [mcg](https://github.com/mbitson/mcg) and [TinyColor](https://github.com/bgrins/TinyColor).
## Issues
Please file [FlutterGen] specific issues, bugs, or feature requests in our [issue tracker](https://github.com/FlutterGen/flutter_gen/issues/new).
Plugin issues that are not specific to [FlutterGen] can be filed in the [Flutter issue tracker](https://github.com/flutter/flutter/issues/new).
### Known Issues
#### Bad State: No Element when using build_runner
If you get an error message like this:
```
[SEVERE] flutter_gen_runner:flutter_gen_runner on $package$:Bad state: No element
[SEVERE] Failed after 16.0s
```The you most likely have a customized `build.yaml` to configure the build runner. In that case, all you have to do is to add the `pubspec.yaml` as build source to your `build.yaml`
```yaml
targets:
$default:
sources:
include:
- pubspec.yaml # add this line
- ...
```See #268 for the corresponding issue discussion.
### Error with [internationalization](https://docs.flutter.dev/development/accessibility-and-localization/internationalization)
Please try to remove `generate: true` in your `pubspec.yaml` and disable `synthetic-package` in your `l10n.yaml` like:
```yaml
# pubspec.yaml
flutter:
generate: true <--- ⚠️Remove this line⚠️
``````yaml
# l10n.yaml
arb-dir: lib/l10n
template-arb-file: app_en.arb
output-localization-file: app_localizations.dart
synthetic-package: false <--- ⚠️Add this line⚠️
```If you get
## Contributing
**We are looking for co-developers.**
If you wish to contribute a change to any of the existing plugins in this repo,
please review our [contribution guide](https://github.com/FlutterGen/flutter_gen/blob/master/CONTRIBUTING.md)
and open a [pull request](https://github.com/FlutterGen/flutter_gen/pulls).[build_runner]: https://pub.dev/packages/build_runner
[fluttergen]: https://pub.dev/packages/flutter_gen