flutter_generate_assets 0.4.1

To satisfy our team's needs, I changed something based on previous author's repository(flutter_asset_generator).

flutter_generate_assets

Automatically generate the dart file for pubspec.yaml

The purpose of this library is to help flutter developers automatically generate asset corresponding dart files to help developers release their hands from this meaningless job, and the open source community has a lot of the same functionality.

This library is based on dartlang's build library.

中文文档

English

• flutter_generate_assets
  • screenshot
  • Usage
    • use source
    • pub global
    • Support options
  • File name
  • Config file
    • exclude and include rules
      • Example

screenshot

Usage

use source

add dart,pub to $PATH environment.

git clone https://github.com/cherrybiu/flutter_generate_assets.git
cd flutter_generate_assets
pub get
dart bin/resource_generator.dart -s $flutter_project

pub global

install:

pub global activate flutter_generate_assets

use:

sgen or sgen -s $flutter_project`

Support options

Use $ sgen -h or $ sgen --help see usage document.

sgen -h
-w, --[no-]watch    Continue to monitor changes after execution of orders.
                    (defaults to on)

-p, --[no-]preview  Generate file with preview comments.
                    (defaults to on)

-o, --output        Your resource file path.
                    If it's a relative path, the relative flutter root directory
                    (defaults to "lib/const/resource.dart")

-s, --src           Flutter project root path
                    (defaults to ".")

-n, --name          The class name for the constant.
                    (defaults to "R")

-h, --[no-]help     Help usage

-d, --[no-]debug    debug info

File name

Space, '.' and '-' in the path will be converted to _. @ will be converted to _AT_.

convert filed name example:

    images/1.png => IMAGES_PNG
    images/hello_world.jpg => IMAGES_HELLO_WORLD_JPG
    images/hello-world.jpg => IMAGES_HELLO_WORLD_JPG

Errors will occur in the following situations

  images/
    main_login.png
    main/
      login.png

Because the two field names will be exactly the same.

Config file

The location of the configuration file is conventional. Configuration via commands is not supported. The specified path is sgen.yaml in the flutter project root directory.

exclude and include rules

The file is yaml format, every element is glob style.

The name of the excluded file is under the exclude node, and the type is a string array. If no rule is included, it means no file is excluded.

The include node is the name of the file that needs to be imported, and the type is a string array. If it does not contain any rules, all file are allowed.

In terms of priority, exclude is higher than include, in other words:

First import the file according to the include nodes, and then exclude the files.

Example

exclude:
  - "**/add*.png"
  - "**_**"

include:
  - "**/a*.png"
  - "**/b*"
  - "**/c*"

assets
├── address.png   # exclude by "**/add*.png"
├── [e-mail]  # exclude by "**/add*.png"
├── bluetoothon-fjdfj.png
├── bluetoothon.png
└── camera.png

images
├── address space.png  # exclude by "**/add*.png"
├── address.png  # exclude by "**/add*.png"
├── addto.png  # exclude by "**/add*.png"
├── audio.png
├── bluetooth_link.png  # exclude by **_**
├── bluetoothoff.png
├── child.png
└── course.png

/// Generate by [resource_generator](https://github.com/cherrybiu/flutter_generate_assets) library.
/// PLEASE DO NOT EDIT MANUALLY.
class R {

  /// ![preview](file:///Users/cherrybiu/code/dart/self/flutter_generate_assets/example/assets/bluetoothon-fjdfj.png)
  static const String ASSETS_BLUETOOTHON_FJDFJ_PNG = 'assets/bluetoothon-fjdfj.png';

  /// ![preview](file:///Users/cherrybiu/code/dart/self/flutter_generate_assets/example/assets/bluetoothon.png)
  static const String ASSETS_BLUETOOTHON_PNG = 'assets/bluetoothon.png';

  /// ![preview](file:///Users/cherrybiu/code/dart/self/flutter_generate_assets/example/assets/camera.png)
  static const String ASSETS_CAMERA_PNG = 'assets/camera.png';

  /// ![preview](file:///Users/cherrybiu/code/dart/self/flutter_generate_assets/example/images/audio.png)
  static const String IMAGES_AUDIO_PNG = 'images/audio.png';

  /// ![preview](file:///Users/cherrybiu/code/dart/self/flutter_generate_assets/example/images/bluetoothoff.png)
  static const String IMAGES_BLUETOOTHOFF_PNG = 'images/bluetoothoff.png';

  /// ![preview](file:///Users/cherrybiu/code/dart/self/flutter_generate_assets/example/images/child.png)
  static const String IMAGES_CHILD_PNG = 'images/child.png';

  /// ![preview](file:///Users/cherrybiu/code/dart/self/flutter_generate_assets/example/images/course.png)
  static const String IMAGES_COURSE_PNG = 'images/course.png';
}

To satisfy our team's needs, I changed something based on previous author's repository.