flr 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edfe0b5dab4b4dda94c17168b8178f80a0903ccb989f498253dca53041b4d751
-  data.tar.gz: 9e83742e89792aeba9f52a0b68e793afa633c0bc84261a1deb3aff8741ed08c2
+  metadata.gz: 1c066c1bf53372cfb42446a4478e319c4251e2dd6d9c30267135588cadee209f
+  data.tar.gz: da3036ab6a3452fe35d05321ee068ca8059f88e64d878f249bfaf230ddada681
 SHA512:
-  metadata.gz: 722245bb8985fe6c2d29116d4cc8b3f8434a21aea05af0acbfcf6e2c62cf9ed1236a2ceea57c389a74f54b39c6f9699bddd631701bb45eff7d6e6a13a186c705
-  data.tar.gz: a8a4136d3e6146eca5f81488ae8adbb3a6307f2bbfa7d952ddebd8ed81f9358ed81d5b87cd652445676bfa47fbfd89305c483b0cccd5c1e6ebb9ee8ee7a079ca
+  metadata.gz: 98e30fa23cae12986881c75b7fc15d6ec7fa2b423d74fd1bc7ba5549f882ff0194211f202867aa30acd3ce81253b70d3d73718022cc3ed9b082e14c8f4cb47d7
+  data.tar.gz: 2d6cbb7417a21c448860f02bdb41c494d37a05108515542638e0bb6ca36677fc52cfb58e19a132bb2642c2d0b2591eae28ccc77290e817fb506b0046143d217e

data/CHANGELOG.md

@@ -1,4 +1,10 @@
+## 1.1.0
+
+- Improve generate-capability to support nonstandard image resource structure
+- Add recommend-capability to display the recommended flutter resource structure
+
 ## 1.0.0
+
 - Support for processing font assets ( `.ttf`, `.otf`, `.ttc`) 
 - Improve robustness
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    flr (1.0.0)
+    flr (1.1.0)
       bundler (~> 2.0, >= 2.0.2)
       listen (~> 3.0, >= 3.2.1)
       thor (~> 1.0, >= 1.0.1)

data/lib/flr.rb

@@ -64,8 +64,16 @@ More details see https://github.com/Fly-Mix/flr-cli
     def run_command
       options[:auto] ? Command.start_monitor : Command.generate
     end
-
     map 'run' => :run_command
 
+    desc "recommend", "Display the recommended flutter resource structure"
+    long_desc <<-LONGDESC
+      Display the good flutter resource structure which is recommended by Flr.
+
+    LONGDESC
+    def recommend
+      Command.display_recommended_flutter_resource_structure
+    end
+
   end
 end

data/lib/flr/command.rb

@@ -27,12 +27,68 @@ module Flr
     # Listen Class Instance
     @@listener = nil
 
-    # show the version of flr
+    # display the version of flr
     def self.version
       version_desc = "Flr version #{Flr::VERSION}\nCoreLogic version #{Flr::CORE_VERSION}"
       puts(version_desc)
     end
 
+    # display recommended flutter resource structure
+    def self.display_recommended_flutter_resource_structure
+      message = <<-MESSAGE
+Flr recommends the following flutter resource structure:
+
+  flutter_project_root_dir
+  ├── build
+  │   ├── ..
+  ├── lib
+  │   ├── assets
+  │   │   ├── \#{module}-images #{"// image resources root directory of a moudle".red}
+  │   │   │   ├── \#{main_image_asset}
+  │   │   │   ├── \#{variant-dir} #{"// image resources root directory of a variant".red}
+  │   │   │   │   ├── \#{image_asset_variant}
+  │   │   │   │   
+  │   │   ├── home-images #{"// image resources root directory of home module".red}
+  │   │   │   ├── home_icon.png
+  │   │   │   ├── home_badge.svg
+  │   │   │   ├── 3.0x #{"// image resources root directory of a 3.0x-ratio-variant".red}
+  │   │   │   │   ├── home_icon.png
+  │   │   │   │   
+  │   │   ├── texts #{"// text resources root directory".red}
+  │   │   │   │     #{"// (you can also break it down further by module)".red}
+  │   │   │   └── test.json
+  │   │   │   └── test.yaml
+  │   │   │   │     
+  │   │   ├── fonts #{"// font resources root directory of all font-family".red}
+  │   │   │   ├── \#{font-family} #{"// font resources root directory of a font-family".red}
+  │   │   │   │   ├── \#{font-family}-\#{font_weight_or_style}.ttf
+  │   │   │   │     
+  │   │   │   ├── Amiri #{"// font resources root directory of Amiri font-family".red}
+  │   │   │   │   ├── Amiri-Regular.ttf
+  │   │   │   │   ├── Amiri-Bold.ttf
+  │   │   │   │   ├── Amiri-Italic.ttf
+  │   │   │   │   ├── Amiri-BoldItalic.ttf
+  │   ├── ..
+  
+#{"[*]: Then config the resource directories that need to be scanned as follows：".tips_style}
+
+    #{"flr:".tips_style}
+      #{"core_version: #{Flr::CORE_VERSION}".tips_style}
+      #{"dartfmt_line_length: #{Flr::DARTFMT_LINE_LENGTH}".tips_style}
+      #{"# config the image and text resource directories that need to be scanned".tips_style}
+      #{"assets:".tips_style}
+        #{"- lib/assets/moduleX-images".tips_style}
+        #{"- lib/assets/home-images".tips_style}
+        #{"- lib/assets/texts".tips_style}
+      #{"# config the font resource directories that need to be scanned".tips_style}
+      #{"fonts:".tips_style}
+        #{"- lib/assets/fonts".tips_style}
+
+      MESSAGE
+
+      puts(message)
+    end
+
     # get the right version of r_dart_library package based on flutter's version
     # to get more detail, see https://github.com/YK-Unit/r_dart_library#dependency-relationship-table
     def self.get_r_dart_library_version
@@ -169,6 +225,10 @@ module Flr
       # ----- Step-4 End -----
 
       puts("[√]: init done !!!")
+
+      puts("")
+      puts("[*]: if you want to know how to make a good resource structure for your flutter project, please run \"flr recommend\" ".tips_style)
+
     end
 
     # 扫描资源目录，自动为资源添加声明到 pubspec.yaml 和生成 r.g.dart
@@ -221,8 +281,10 @@ module Flr
 
       if flr_core_version != Flr::CORE_VERSION
         message = <<-MESSAGE
-#{"[!]: warning, the core logic version of the configured Flr tool is #{flr_core_version}, while the core logic version of the currently used Flr tool is #{Flr::CORE_VERSION}".warning_style}
+#{"[!]: warning, the \"core_version\"(CoreLogic version) of the configured Flr tool is #{flr_core_version}, while the \"core_version\"(CoreLogic version) of the currently used Flr tool is #{Flr::CORE_VERSION}".warning_style}
 #{"[*]: to fix it, you should make sure that the core logic version of the Flr tool you are currently using is consistent with the configuration".tips_style}
+#{"[*]: to get the value of \"core_version\"(CoreLogic version), just run \"flr version\"".tips_style}
+
         MESSAGE
 
         warning_messages.push(message)

data/lib/flr/util/file_util.rb

@@ -105,7 +105,8 @@ module Flr
 
     # find_image_files(resource_dir)  ->  image_file_result_tuple
     #
-    # 扫描指定的资源目录和其第1级子目录，查找所有图片文件
+    # v1.0.0: 扫描指定的资源目录和其第1级子目录，查找所有图片文件
+    # v1.1.0: 放开图片资源扫描目录层级限制，以支持不标准的资源组织目录结构
     # 返回图片文件结果二元组 image_file_result_tuple
     # image_file_result_tuple = [legal_image_file_array, illegal_image_file_array]
     #
@@ -123,7 +124,8 @@ module Flr
       pattern_file_types = Flr::IMAGE_FILE_TYPES.join(",")
       # dir/*{.png.,.jpg} : 查找当前目录的指定类型文件
       # dir/*/*{.png.,.jpg}: 查找当前目录的第1级子目录的指定类型文件
-      Dir.glob(["#{resource_dir}/*{#{pattern_file_types}}", "#{resource_dir}/*/*{#{pattern_file_types}}"]).each do |file|
+      # dir/**/*{.png.,.jpg}:  查找当前目录和其所有子目录的指定类型文件
+      Dir.glob(["#{resource_dir}/**/*{#{pattern_file_types}}"]).each do |file|
         if is_legal_resource_file?(file)
           legal_image_file_array.push(file)
         else

data/lib/flr/version.rb

@@ -1,6 +1,6 @@
 module Flr
   # 工具版本号
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 
   # 核心逻辑版本号
   CORE_VERSION = "1.0.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flr
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - York
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-29 00:00:00.000000000 Z
+date: 2020-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler