Class: Flr::Command

Inherits:
Object
  • Object
show all
Defined in:
lib/flr/command.rb

Constant Summary collapse

@@listener =

Listen Class Instance

nil

Class Method Summary collapse

Class Method Details

display recommended flutter resource structure



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/flr/command.rb', line 37

def self.display_recommended_flutter_resource_structure
  message = "Flr recommends the following flutter resource structure schemes:\n\n\#{\"------------------------------ scheme 1 ------------------------------\".bold.bg_red}\n\n  flutter_project_root_dir\n  \u251C\u2500\u2500 build\n  \u2502   \u251C\u2500\u2500 ..\n  \u251C\u2500\u2500 lib\n  \u2502   \u251C\u2500\u2500 assets\n  \u2502   \u2502   \u251C\u2500\u2500 images \#{\"// image resource directory of all modules\".red}\n  \u2502   \u2502   \u2502   \u251C\u2500\u2500 \\\#{module} \#{\"// image resource directory of a module\".red}\n  \u2502   \u2502   \u2502   \u2502   \u251C\u2500\u2500 \\\#{main_image_asset}\n  \u2502   \u2502   \u2502   \u2502   \u251C\u2500\u2500 \\\#{variant-dir} \#{\"// image resource directory of a variant\".red}\n  \u2502   \u2502   \u2502   \u2502   \u2502   \u251C\u2500\u2500 \\\#{image_asset_variant}\n  \u2502   \u2502   \u2502   \u2502\n  \u2502   \u2502   \u2502   \u251C\u2500\u2500 home \#{\"// image resource directory of home module\".red}\n  \u2502   \u2502   \u2502   \u2502   \u251C\u2500\u2500 home_badge.svg\n  \u2502   \u2502   \u2502   \u2502   \u251C\u2500\u2500 home_icon.png\n  \u2502   \u2502   \u2502   \u2502   \u251C\u2500\u2500 3.0x \#{\"// image resource directory of a 3.0x-ratio-variant\".red}\n  \u2502   \u2502   \u2502   \u2502   \u2502   \u251C\u2500\u2500 home_icon.png\n  \u2502   \u2502   \u2502   \u2502   \n  \u2502   \u2502   \u251C\u2500\u2500 texts \#{\"// text resource directory\".red}\n  \u2502   \u2502   \u2502   \u2502     \#{\"// (you can also break it down further by module)\".red}\n  \u2502   \u2502   \u2502   \u2514\u2500\u2500 test.json\n  \u2502   \u2502   \u2502   \u2514\u2500\u2500 test.yaml\n  \u2502   \u2502   \u2502   \u2502\n  \u2502   \u2502   \u251C\u2500\u2500 fonts \#{\"// font resource directory of all font-families\".red}\n  \u2502   \u2502   \u2502   \u251C\u2500\u2500 \\\#{font-family} \#{\"// font resource directory of a font-family\".red}\n  \u2502   \u2502   \u2502   \u2502   \u251C\u2500\u2500 \\\#{font-family}-\\\#{font_weight_or_style}.ttf\n  \u2502   \u2502   \u2502   \u2502\n  \u2502   \u2502   \u2502   \u251C\u2500\u2500 Amiri \#{\"// font resource directory of Amiri font-family\".red}\n  \u2502   \u2502   \u2502   \u2502   \u251C\u2500\u2500 Amiri-Regular.ttf\n  \u2502   \u2502   \u2502   \u2502   \u251C\u2500\u2500 Amiri-Bold.ttf\n  \u2502   \u2502   \u2502   \u2502   \u251C\u2500\u2500 Amiri-Italic.ttf\n  \u2502   \u2502   \u2502   \u2502   \u251C\u2500\u2500 Amiri-BoldItalic.ttf\n  \u2502   \u251C\u2500\u2500 ..\n\n\#{\"[*]: Then config the resource directories that need to be scanned as follows\uFF1A\".tips_style}\n\n  \#{\"flr:\".tips_style}\n\#{\"core_version: \#{Flr::CORE_VERSION}\".tips_style}\n\#{\"dartfmt_line_length: \#{Flr::DARTFMT_LINE_LENGTH}\".tips_style}\n\#{\"# config the image and text resource directories that need to be scanned\".tips_style}\n\#{\"assets:\".tips_style}\n  \#{\"- lib/assets/images\".tips_style}\n  \#{\"- lib/assets/texts\".tips_style}\n\#{\"# config the font resource directories that need to be scanned\".tips_style}\n\#{\"fonts:\".tips_style}\n  \#{\"- lib/assets/fonts\".tips_style}\n\n\#{\"------------------------------ scheme 2 ------------------------------\".bold.bg_red}\n\n  flutter_project_root_dir\n  \u251C\u2500\u2500 build\n  \u2502   \u251C\u2500\u2500 ..\n  \u251C\u2500\u2500 lib\n  \u2502   \u251C\u2500\u2500 ..\n  \u251C\u2500\u2500 assets\n  \u2502   \u251C\u2500\u2500 images \#{\"// image resource directory of all modules\".red}\n  \u2502   \u2502   \u251C\u2500\u2500 \\\#{module} \#{\"// image resource directory of a module\".red}\n  \u2502   \u2502   \u2502   \u251C\u2500\u2500 \\\#{main_image_asset}\n  \u2502   \u2502   \u2502   \u251C\u2500\u2500 \\\#{variant-dir} \#{\"// image resource directory of a variant\".red}\n  \u2502   \u2502   \u2502   \u2502   \u251C\u2500\u2500 \\\#{image_asset_variant}\n  \u2502   \u2502   \u2502\n  \u2502   \u2502   \u251C\u2500\u2500 home \#{\"// image resource directory of home module\".red}\n  \u2502   \u2502   \u2502   \u251C\u2500\u2500 home_badge.svg\n  \u2502   \u2502   \u2502   \u251C\u2500\u2500 home_icon.png\n  \u2502   \u2502   \u2502   \u251C\u2500\u2500 3.0x \#{\"// image resource directory of a 3.0x-ratio-variant\".red}\n  \u2502   \u2502   \u2502   \u2502   \u251C\u2500\u2500 home_icon.png\n  \u2502   \u2502   \u2502   \n  \u2502   \u251C\u2500\u2500 texts \#{\"// text resource directory\".red}\n  \u2502   \u2502   \u2502     \#{\"// (you can also break it down further by module)\".red}\n  \u2502   \u2502   \u2514\u2500\u2500 test.json\n  \u2502   \u2502   \u2514\u2500\u2500 test.yaml\n  \u2502   \u2502   \u2502\n  \u2502   \u251C\u2500\u2500 fonts \#{\"// font resource directory of all font-families\".red}\n  \u2502   \u2502   \u251C\u2500\u2500 \\\#{font-family} \#{\"// font resource directory of a font-family\".red}\n  \u2502   \u2502   \u2502   \u251C\u2500\u2500 \\\#{font-family}-\\\#{font_weight_or_style}.ttf\n  \u2502   \u2502   \u2502\n  \u2502   \u2502   \u251C\u2500\u2500 Amiri \#{\"// font resource directory of Amiri font-family\".red}\n  \u2502   \u2502   \u2502   \u251C\u2500\u2500 Amiri-Regular.ttf\n  \u2502   \u2502   \u2502   \u251C\u2500\u2500 Amiri-Bold.ttf\n  \u2502   \u2502   \u2502   \u251C\u2500\u2500 Amiri-Italic.ttf\n  \u2502   \u2502   \u2502   \u251C\u2500\u2500 Amiri-BoldItalic.ttf\n  \u2502   \u251C\u2500\u2500 ..\n\n\#{\"[*]: Then config the resource directories that need to be scanned as follows\uFF1A\".tips_style}\n\n  \#{\"flr:\".tips_style}\n\#{\"core_version: \#{Flr::CORE_VERSION}\".tips_style}\n\#{\"dartfmt_line_length: \#{Flr::DARTFMT_LINE_LENGTH}\".tips_style}\n\#{\"# config the image and text resource directories that need to be scanned\".tips_style}\n\#{\"assets:\".tips_style}\n  \#{\"- assets/images\".tips_style}\n  \#{\"- assets/texts\".tips_style}\n\#{\"# config the font resource directories that need to be scanned\".tips_style}\n\#{\"fonts:\".tips_style}\n  \#{\"- assets/fonts\".tips_style}\n  MESSAGE\n\n  puts(message)\nend\n"

.generate_all ⇒ Object 



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/flr/command.rb', line 356

def self.generate_all
  flutter_main_project_root_dir = FileUtil.get_flutter_main_project_root_dir

  # ----- Step-1 Begin -----
  # 进行环境检测；若发现不合法的环境，则抛出异常，终止当前进程。
  #  - 检测当前flutter主工程根目录是否存在 pubspec.yaml
  #
  begin
    Checker.check_pubspec_file_is_existed(flutter_main_project_root_dir)
  rescue Exception => e
    puts(e.message)
    return
  end

  # ----- Step-1 End -----

  puts("generate for all flutter projects now...")

  # ----- Step-2 Begin -----
  # 获取主工程和其所有子工程，对它们进行generate_one操作
  # - 获取flutter主工程根目录下所有的子工程目录
  # - 对主工程执行generate_one操作
  # - 对所有子工程执行generate_one操作
  #
  flutter_sub_project_root_dir_array = FileUtil.get_flutter_sub_project_root_dirs(flutter_main_project_root_dir)

  puts("")
  generate_one(flutter_main_project_root_dir)

  flutter_sub_project_root_dir_array.each do |flutter_project_root_dir|
    puts("")
    generate_one(flutter_project_root_dir)
  end

  # ----- Step-2 End -----

  # ----- Step-3 Begin -----
  # 调用 flutter 工具，为主工程和所有子工程获取依赖
  #
  puts("")
  puts("get dependencies for all flutter projects via execute \"flutter pub get\" now ...")

  get_flutter_pub_cmd = "flutter pub get"
  system(get_flutter_pub_cmd)

  puts("[√]: get dependencies for all flutter projects done !!!")

  # ----- Step-3 End -----
  puts("")
  puts("[√]: generate for all flutter projects done !!!")
end

.generate_one(flutter_project_root_dir) ⇒ Object

为指定 flutter 工程扫描资源目录，自动为资源添加声明到 pubspec.yaml 和生成 r.g.dart



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
 
# File 'lib/flr/command.rb', line 409

def self.generate_one(flutter_project_root_dir)
  puts("--------------------------- generate for specified project ---------------------------")
  puts("generate for #{flutter_project_root_dir} now...")

  # 警告日志数组
  warning_messages = []

  # ----- Step-1 Begin -----
  # 进行环境检测；若发现不合法的环境，则抛出异常，终止当前进程：
  # - 检测当前flutter工程根目录是否存在pubspec.yaml
  # - 检测当前pubspec.yaml中是否存在Flr的配置
  # - 检测当前flr_config中的resource_dir配置是否合法：
  #   判断合法的标准是：assets配置或者fonts配置了至少1个legal_resource_dir
  #

  begin
    Checker.check_pubspec_file_is_existed(flutter_project_root_dir)

    pubspec_file_path = FileUtil.get_pubspec_file_path(flutter_project_root_dir)

    pubspec_config = FileUtil.load_pubspec_config_from_file(pubspec_file_path)

    Checker.check_flr_config_is_existed(pubspec_config)

    flr_config = pubspec_config["flr"]

    resource_dir_result_tuple = Checker.check_flr_assets_is_legal(flutter_project_root_dir, flr_config)

  rescue Exception => e
    puts(e.message)
    puts("[x]: generate for #{flutter_project_root_dir} failed".error_style)
    puts("--------------------------------------------------------------------------------------")
    return
  end

  is_package_project_type = FileUtil.is_package_project_type?(flutter_project_root_dir)
  package_name = pubspec_config["name"]

  # ----- Step-1 End -----

  # ----- Step-2 Begin -----
  # 进行核心逻辑版本检测：
  # 检测flr_config中的core_version和当前工具的core_version是否一致；若不一致，则按照以下规则处理：
  #  - 更新flr_config中的core_version的值为当前工具的core_version；
  #  - 生成“核心逻辑版本不一致”的警告日志，存放到警告日志数组。
  #

  flr_core_version = flr_config["core_version"]

  if flr_core_version.nil?
    flr_core_version = "unknown"
  end

  if flr_core_version != Flr::CORE_VERSION
    flr_config["core_version"] = Flr::CORE_VERSION

    message = "\#{\"[!]: warning, some team members may be using Flr tool with core_version \#{flr_core_version}, while you are using Flr tool with core_version \#{Flr::CORE_VERSION}\".warning_style}\n\#{\"[*]: to fix it, you and your team members should use the Flr tool with same core_version\".tips_style}\n\#{\"[*]: \\\"core_version\\\" is the core logic version of Flr tool, you can run \\\"flr version\\\" to get it\".tips_style}\n\n    MESSAGE\n\n    warning_messages.push(message)\n  end\n\n  # ----- Step-2 End -----\n\n  # ----- Step-3 Begin -----\n  # \u83B7\u53D6assets_legal_resource_dir\u6570\u7EC4\u3001fonts_legal_resource_dir\u6570\u7EC4\u548Cillegal_resource_dir\u6570\u7EC4\uFF1A\n  # - \u4ECEflr_config\u4E2D\u7684assets\u914D\u7F6E\u83B7\u53D6assets_legal_resource_dir\u6570\u7EC4\u548Cassets_illegal_resource_dir\u6570\u7EC4\uFF1B\n  # - \u4ECEflr_config\u4E2D\u7684fonts\u914D\u7F6E\u83B7\u53D6fonts_legal_resource_dir\u6570\u7EC4\u548Cfonts_illegal_resource_dir\u6570\u7EC4\uFF1B\n  # - \u5408\u5E76assets_illegal_resource_dir\u6570\u7EC4\u548Cfonts_illegal_resource_dir\u6570\u7EC4\u4E3Aillegal_resource_dir\u6570\u7EC4\u2018\uFF1B\u82E5illegal_resource_dir\u6570\u7EC4\u957F\u5EA6\u5927\u4E8E0\uFF0C\u5219\u751F\u6210\u201C\u5B58\u5728\u975E\u6CD5\u7684\u8D44\u6E90\u76EE\u5F55\u201D\u7684\u8B66\u544A\u65E5\u5FD7\uFF0C\u5B58\u653E\u5230\u8B66\u544A\u65E5\u5FD7\u6570\u7EC4\u3002\n\n  # \u5408\u6CD5\u7684\u8D44\u6E90\u76EE\u5F55\u6570\u7EC4\n  assets_legal_resource_dir_array = resource_dir_result_tuple[0]\n  fonts_legal_resource_dir_array = resource_dir_result_tuple[1]\n  # \u975E\u6CD5\u7684\u8D44\u6E90\u76EE\u5F55\u6570\u7EC4\n  illegal_resource_dir_array = resource_dir_result_tuple[2]\n\n  if illegal_resource_dir_array.length > 0\n    message = \"[!]: warning, found the following resource directory which is not existed: \".warning_style\n    illegal_resource_dir_array.each do |resource_dir|\n      message = message + \"\\n\" + \"  - \#{resource_dir}\".warning_style\n    end\n\n    warning_messages.push(message)\n  end\n\n  # ----- Step-3 End -----\n\n  # \u626B\u63CF\u8D44\u6E90\n  puts(\"scan assets now ...\")\n\n  # ----- Step-4 Begin -----\n  # \u626B\u63CFassets_legal_resource_dir\u6570\u7EC4\u4E2D\u7684legal_resource_dir\uFF0C\u8F93\u51FA\u6709\u5E8F\u7684image_asset\u6570\u7EC4\u3001non_svg_image_asset\u6570\u7EC4\u3001svg_image_asset\u6570\u7EC4\u3001illegal_image_file\u6570\u7EC4\uFF1A\n  # - \u521B\u5EFAimage_asset\u6570\u7EC4\u3001illegal_image_file\u6570\u7EC4\uFF1B\n  # - \u904D\u5386assets_legal_resource_dir\u6570\u7EC4\uFF0C\u6309\u7167\u5982\u4E0B\u5904\u7406\u6BCF\u4E2A\u8D44\u6E90\u76EE\u5F55\uFF1A\n  #  - \u626B\u63CF\u5F53\u524D\u8D44\u6E90\u76EE\u5F55\u548C\u5176\u6240\u6709\u5C42\u7EA7\u7684\u5B50\u76EE\u5F55\uFF0C\u67E5\u627E\u6240\u6709image_file\uFF1B\n  #  - \u6839\u636Elegal_resource_file\u7684\u6807\u51C6\uFF0C\u7B5B\u9009\u67E5\u627E\u7ED3\u679C\u751F\u6210legal_image_file\u5B50\u6570\u7EC4\u548Cillegal_image_file\u5B50\u6570\u7EC4\uFF1Billegal_image_file\u5B50\u6570\u7EC4\u5408\u5E76\u5230illegal_image_file\u6570\u7EC4\uFF1B\n  #  - \u6839\u636Eimage_asset\u7684\u5B9A\u4E49\uFF0C\u904D\u5386legal_image_file\u5B50\u6570\u7EC4\uFF0C\u751F\u6210image_asset\u5B50\u6570\uFF1B\u7EC4\uFF1Bimage_asset\u5B50\u6570\u7EC4\u5408\u5E76\u5230image_asset\u6570\u7EC4\u3002\n  # - \u5BF9image_asset\u6570\u7EC4\u505A\u53BB\u91CD\u5904\u7406\uFF1B\n  # - \u6309\u7167\u5B57\u5178\u987A\u5E8F\u5BF9image_asset\u6570\u7EC4\u505A\u5347\u5E8F\u6392\u5217\uFF08\u4E00\u822C\u4F7F\u7528\u5F00\u53D1\u8BED\u8A00\u63D0\u4F9B\u7684\u9ED8\u8BA4\u7684sort\u7B97\u6CD5\u5373\u53EF\uFF09\uFF1B\n  # - \u6309\u7167SVG\u5206\u7C7B\uFF0C\u4ECEimage_asset\u6570\u7EC4\u7B5B\u9009\u5F97\u5230\u6709\u5E8F\u7684non_svg_image_asset\u6570\u7EC4\u548Csvg_image_asset\u6570\u7EC4\uFF1A\n  #  - \u6309\u7167SVG\u5206\u7C7B\uFF0C\u4ECEimage_asset\u6570\u7EC4\u7B5B\u9009\u5F97\u5230non_svg_image_asset\u6570\u7EC4\u548Csvg_image_asset\u6570\u7EC4\uFF1B\n  #  - \u6309\u7167\u5B57\u5178\u987A\u5E8F\u5BF9non_svg_image_asset\u6570\u7EC4\u548Csvg_image_asset\u6570\u7EC4\u505A\u5347\u5E8F\u6392\u5217\uFF08\u4E00\u822C\u4F7F\u7528\u5F00\u53D1\u8BED\u8A00\u63D0\u4F9B\u7684\u9ED8\u8BA4\u7684sort\u7B97\u6CD5\u5373\u53EF\uFF09\uFF1B\n  # - \u8F93\u51FA\u6709\u5E8F\u7684image_asset\u6570\u7EC4\u3001non_svg_image_asset\u6570\u7EC4\u3001svg_image_asset\u6570\u7EC4\u3001illegal_image_file\u6570\u7EC4\u3002\n\n  image_asset_array = []\n  illegal_image_file_array = []\n\n  assets_legal_resource_dir_array.each do |resource_dir|\n    image_file_result_tuple = FileUtil.find_image_files(resource_dir)\n    legal_image_file_subarray = image_file_result_tuple[0]\n    illegal_image_file_subarray = image_file_result_tuple[1]\n\n    illegal_image_file_array += illegal_image_file_subarray\n\n    image_asset_subarray = AssetUtil.generate_image_assets(flutter_project_root_dir, package_name, legal_image_file_subarray)\n    image_asset_array += image_asset_subarray\n  end\n\n  image_asset_array.uniq!\n  image_asset_array.sort!\n\n  non_svg_image_asset_array = []\n  svg_image_asset_array = []\n\n  image_asset_array.each do |image_asset|\n    if FileUtil.is_svg_image_resource_file?(image_asset)\n      svg_image_asset_array.push(image_asset)\n    else\n      non_svg_image_asset_array.push(image_asset)\n    end\n\n  end\n\n  non_svg_image_asset_array.sort!\n  svg_image_asset_array.sort!\n\n  # ----- Step-4 End -----\n\n  # ----- Step-5 Begin -----\n  # \u626B\u63CFassets_legal_resource_dir\u6570\u7EC4\u4E2D\u7684legal_resource_dir\uFF0C\u8F93\u51FAtext_asset\u6570\u7EC4\u548Cillegal_text_file\u6570\u7EC4\uFF1A\n  # - \u521B\u5EFAtext_asset\u6570\u7EC4\u3001illegal_text_file\u6570\u7EC4\uFF1B\n  # - \u904D\u5386assets_legal_resource_dir\u6570\u7EC4\uFF0C\u6309\u7167\u5982\u4E0B\u5904\u7406\u6BCF\u4E2A\u8D44\u6E90\u76EE\u5F55\uFF1A\n  #  - \u626B\u63CF\u5F53\u524D\u8D44\u6E90\u76EE\u5F55\u548C\u5176\u6240\u6709\u5C42\u7EA7\u7684\u5B50\u76EE\u5F55\uFF0C\u67E5\u627E\u6240\u6709text_file\uFF1B\n  #  - \u6839\u636Elegal_resource_file\u7684\u6807\u51C6\uFF0C\u7B5B\u9009\u67E5\u627E\u7ED3\u679C\u751F\u6210legal_text_file\u5B50\u6570\u7EC4\u548Cillegal_text_file\u5B50\u6570\u7EC4\uFF1Billegal_text_file\u5B50\u6570\u7EC4\u5408\u5E76\u5230illegal_text_file\u6570\u7EC4\uFF1B\n  #  - \u6839\u636Etext_asset\u7684\u5B9A\u4E49\uFF0C\u904D\u5386legal_text_file\u5B50\u6570\u7EC4\uFF0C\u751F\u6210text_asset\u5B50\u6570\u7EC4\uFF1Btext_asset\u5B50\u6570\u7EC4\u5408\u5E76\u5230text_asset\u6570\u7EC4\u3002\n  # - \u5BF9text_asset\u6570\u7EC4\u505A\u53BB\u91CD\u5904\u7406\uFF1B\n  # - \u6309\u7167\u5B57\u5178\u987A\u5E8F\u5BF9text_asset\u6570\u7EC4\u505A\u5347\u5E8F\u6392\u5217\uFF08\u4E00\u822C\u4F7F\u7528\u5F00\u53D1\u8BED\u8A00\u63D0\u4F9B\u7684\u9ED8\u8BA4\u7684sort\u7B97\u6CD5\u5373\u53EF\uFF09\uFF1B\n  # - \u8F93\u51FAtext_asset\u6570\u7EC4\u548Cillegal_image_file\u6570\u7EC4\u3002\n  #\n\n  text_asset_array = []\n  illegal_text_file_array = []\n\n  assets_legal_resource_dir_array.each do |resource_dir|\n    text_file_result_tuple = FileUtil.find_text_files(resource_dir)\n    legal_text_file_subarray = text_file_result_tuple[0]\n    illegal_text_file_subarray = text_file_result_tuple[1]\n\n    illegal_text_file_array += illegal_text_file_subarray\n\n    text_asset_subarray = AssetUtil.generate_text_assets(flutter_project_root_dir, package_name, legal_text_file_subarray)\n    text_asset_array += text_asset_subarray\n  end\n\n  text_asset_array.uniq!\n  text_asset_array.sort!\n\n  # ----- Step-5 End -----\n\n  # ----- Step-6 Begin -----\n  # \u626B\u63CFfonts_legal_resource_dir\u6570\u7EC4\u4E2D\u7684legal_resource_dir\uFF0C\u8F93\u51FAfont_family_config\u6570\u7EC4\u3001illegal_font_file\u6570\u7EC4\uFF1A\n  # - \u521B\u5EFAfont_family_config\u6570\u7EC4\u3001illegal_font_file\u6570\u7EC4\uFF1B\n  # - \u904D\u5386fonts_legal_resource_dir\u6570\u7EC4\uFF0C\u6309\u7167\u5982\u4E0B\u5904\u7406\u6BCF\u4E2A\u8D44\u6E90\u76EE\u5F55\uFF1A\n  #  - \u626B\u63CF\u5F53\u524D\u8D44\u6E90\u76EE\u5F55\uFF0C\u83B7\u5F97\u5176\u7B2C1\u7EA7\u5B50\u76EE\u5F55\u6570\u7EC4\uFF0C\u5E76\u6309\u7167\u5B57\u5178\u987A\u5E8F\u5BF9\u6570\u7EC4\u505A\u5347\u5E8F\u6392\u5217\uFF08\u4E00\u822C\u4F7F\u7528\u5F00\u53D1\u8BED\u8A00\u63D0\u4F9B\u7684\u9ED8\u8BA4\u7684sort\u7B97\u6CD5\u5373\u53EF\uFF09\uFF1B\n  #  - \u904D\u5386\u7B2C1\u7EA7\u5B50\u76EE\u5F55\u6570\u7EC4\uFF0C\u6309\u7167\u5982\u4E0B\u5904\u7406\u6BCF\u4E2A\u5B50\u76EE\u5F55\uFF1A\n  #    - \u83B7\u53D6\u5F53\u524D\u5B50\u76EE\u5F55\u7684\u540D\u79F0\uFF0C\u751F\u6210font_family_name\uFF1B\n  #    - \u626B\u63CF\u5F53\u524D\u5B50\u76EE\u5F55\u548C\u5176\u6240\u6709\u5B50\u76EE\u5F55\uFF0C\u67E5\u627E\u6240\u6709font_file\uFF1B\n  #    - \u6839\u636Elegal_resource_file\u7684\u6807\u51C6\uFF0C\u7B5B\u9009\u67E5\u627E\u7ED3\u679C\u751F\u6210legal_font_file\u6570\u7EC4\u548Cillegal_font_file\u5B50\u6570\u7EC4\uFF1Billegal_font_file\u5B50\u6570\u7EC4\u5408\u5E76\u5230illegal_font_file\u6570\u7EC4\uFF1B\n  #    - \u636Efont_asset\u7684\u5B9A\u4E49\uFF0C\u904D\u5386legal_font_file\u6570\u7EC4\uFF0C\u751F\u6210font_asset_config\u6570\u7EC4\uFF1B\n  #    - \u6309\u7167\u5B57\u5178\u987A\u5E8F\u5BF9\u751F\u6210font_asset_config\u6570\u7EC4\u505A\u5347\u5E8F\u6392\u5217\uFF08\u6BD4\u8F83asset\u7684\u503C\uFF09\uFF1B\n  #    - \u6839\u636Efont_family_config\u7684\u5B9A\u4E49\uFF0C\u4E3A\u5F53\u524D\u5B50\u76EE\u5F55\u7EC4\u7EC7font_family_name\u548Cfont_asset_config\u6570\u7EC4\u751F\u6210font_family_config\u5BF9\u8C61\uFF0C\u6DFB\u52A0\u5230font_family_config\u5B50\u6570\u7EC4\uFF1Bfont_family_config\u5B50\u6570\u7EC4\u5408\u5E76\u5230font_family_config\u6570\u7EC4\u3002\n  # - \u8F93\u51FAfont_family_config\u6570\u7EC4\u3001illegal_font_file\u6570\u7EC4\uFF1B\n  # - \u6309\u7167\u5B57\u5178\u987A\u5E8F\u5BF9font_family_config\u6570\u7EC4\u505A\u5347\u5E8F\u6392\u5217\uFF08\u6BD4\u8F83family\u7684\u503C\uFF09\u3002\n  #\n\n  font_family_config_array = []\n  illegal_font_file_array = []\n\n  fonts_legal_resource_dir_array.each do |resource_dir|\n    font_family_dir_array = FileUtil.find_top_child_dirs(resource_dir)\n\n    font_family_dir_array.each do |font_family_dir|\n      font_family_name = File.basename(font_family_dir)\n\n      font_file_result_tuple = FileUtil.find_font_files_in_font_family_dir(font_family_dir)\n      legal_font_file_array = font_file_result_tuple[0]\n      illegal_font_file_subarray = font_file_result_tuple[1]\n\n      illegal_font_file_array += illegal_font_file_subarray\n\n      unless legal_font_file_array.length > 0\n        next\n      end\n\n      font_asset_config_array = AssetUtil.generate_font_asset_configs(flutter_project_root_dir, package_name, legal_font_file_array)\n      font_asset_config_array.sort!{|a, b| a[\"asset\"] <=> b[\"asset\"]}\n\n      font_family_config =  Hash[\"family\" => font_family_name , \"fonts\" => font_asset_config_array]\n      font_family_config_array.push(font_family_config)\n    end\n  end\n\n  font_family_config_array.sort!{|a, b| a[\"family\"] <=> b[\"family\"]}\n\n  # ----- Step-6 End -----\n\n  puts(\"scan assets done !!!\")\n\n  # ----- Step-7 Begin -----\n  # \u68C0\u6D4B\u662F\u5426\u5B58\u5728illegal_resource_file\uFF1A\n  # - \u5408\u5E76illegal_image_file\u6570\u7EC4\u3001illegal_text_file\u6570\u7EC4\u548Cillegal_font_file\u6570\u7EC4\u4E3Aillegal_resource_file\u6570\u7EC4\uFF1B\n  # - \u82E5illegal_resource_file\u6570\u7EC4\u957F\u5EA6\u5927\u4E8E0\uFF0C\u5219\u751F\u6210\u201C\u5B58\u5728\u975E\u6CD5\u7684\u8D44\u6E90\u6587\u4EF6\u201D\u7684\u8B66\u544A\u65E5\u5FD7\uFF0C\u5B58\u653E\u5230\u8B66\u544A\u65E5\u5FD7\u6570\u7EC4\u3002\n\n  illegal_resource_file_array = illegal_image_file_array + illegal_text_file_array + illegal_font_file_array\n  if illegal_resource_file_array.length > 0\n    message = \"[!]: warning, found the following illegal resource file who's file basename contains illegal characters: \".warning_style\n    illegal_resource_file_array.each do |resource_file|\n      message = message + \"\\n\" + \"  - \#{resource_file}\".warning_style\n    end\n    message = message + \"\\n\" + \"[*]: to fix it, you should only use letters (a-z, A-Z), numbers (0-9), and the other legal characters ('_', '+', '-', '.', '\u00B7', '!', '@', '&', '$', '\uFFE5') to name the file\".tips_style\n\n    warning_messages.push(message)\n  end\n\n  # ----- Step-7 End -----\n\n  puts(\"specify scanned assets in pubspec.yaml now ...\")\n\n  # ----- Step-8 Begin -----\n  # \u4E3A\u626B\u63CF\u5F97\u5230\u7684legal_resource_file\u6DFB\u52A0\u8D44\u6E90\u58F0\u660E\u5230pubspec.yaml\uFF1A\n  # - \u5408\u5E76image_asset\u6570\u7EC4\u548Ctext_asset\u6570\u7EC4\u4E3Anew_asset_array\uFF08image_asset\u6570\u7EC4\u5143\u7D20\u5728\u524D\uFF09\uFF1B\n  # - \u8BFB\u53D6pubspec.yaml\u4E2Dflutter-assets\u914D\u7F6E\uFF0C\u83B7\u5F97old_asset_array\uFF0C\u7136\u540E\u548Cnew_asset_array\u5408\u5E76\u4E3Aasset\u6570\u7EC4\uFF1B\n  # - \u4FEE\u6539pubspec.yaml\u4E2Dflutter-assets\u914D\u7F6E\u7684\u503C\u4E3Aasset\u6570\u7EC4\uFF1B\n  # - \u4FEE\u6539pubspec.yaml\u4E2Dflutter-fonts\u914D\u7F6E\u7684\u503C\u4E3Afont_family_config\u6570\u7EC4\u3002\n\n  flutter_config = pubspec_config[\"flutter\"]\n  if flutter_config.nil?\n    flutter_config = {}\n  end\n\n  new_asset_array = image_asset_array + text_asset_array\n  old_asset_array = flutter_config[\"assets\"]\n  if old_asset_array.nil? or old_asset_array.is_a?(Array) == false\n    old_asset_array = []\n  end\n\n  asset_array = AssetUtil.mergeFlutterAssets(flutter_project_root_dir, package_name, new_asset_array, old_asset_array)\n  if asset_array.length > 0\n    flutter_config[\"assets\"] = asset_array\n  else\n    flutter_config.delete(\"assets\")\n  end\n\n  if font_family_config_array.length > 0\n    flutter_config[\"fonts\"] = font_family_config_array\n  else\n    flutter_config.delete(\"fonts\")\n  end\n\n  pubspec_config[\"flutter\"] = flutter_config\n  FileUtil.dump_pubspec_config_to_file(pubspec_config, pubspec_file_path)\n\n  # ----- Step-8 End -----\n\n  puts(\"specify scanned assets in pubspec.yaml done !!!\")\n\n  # ----- Step-9 Begin -----\n  # \u5206\u522B\u904D\u5386non_svg_image_asset\u6570\u7EC4\u3001svg_image_asset\u6570\u7EC4\u3001text_asset\u6570\u7EC4\uFF0C\n  # \u6839\u636Easset_id\u751F\u6210\u7B97\u6CD5\uFF0C\u5206\u522B\u8F93\u51FAnon_svg_image_asset_id\u5B57\u5178\u3001svg_image_asset_id \u5B57\u5178\u3001text_asset_id\u5B57\u5178\u3002\n  # \u5B57\u5178\u7684key\u4E3Aasset\uFF0Cvalue\u4E3Aasset_id\u3002\n  #\n  non_svg_image_asset_id_dict = Hash[]\n  svg_image_asset_id_dict = Hash[]\n  text_asset_id_dict = Hash[]\n\n  non_svg_image_asset_array.each do |asset|\n    used_asset_id_array = non_svg_image_asset_id_dict.values\n    asset_id = CodeUtil.generate_asset_id(asset, used_asset_id_array, Flr::PRIOR_NON_SVG_IMAGE_FILE_TYPE)\n    non_svg_image_asset_id_dict[asset] = asset_id\n  end\n\n  svg_image_asset_array.each do |asset|\n    used_asset_id_array = svg_image_asset_id_dict.values\n    asset_id = CodeUtil.generate_asset_id(asset, used_asset_id_array, Flr::PRIOR_SVG_IMAGE_FILE_TYPE)\n    svg_image_asset_id_dict[asset] = asset_id\n  end\n\n  text_asset_array.each do |asset|\n    used_asset_id_array = text_asset_id_dict.values\n    asset_id = CodeUtil.generate_asset_id(asset, used_asset_id_array, Flr::PRIOR_TEXT_FILE_TYPE)\n    text_asset_id_dict[asset] = asset_id\n  end\n\n  # ----- Step-9 End -----\n\n  puts(\"generate \\\"r.g.dart\\\" now ...\")\n\n  # ----- Step-10 Begin -----\n  # \u5728\u5F53\u524D\u6839\u76EE\u5F55\u4E0B\u521B\u5EFA\u65B0\u7684r.g.dart\u6587\u4EF6\u3002\n  #\n\n  r_dart_path = \"\#{flutter_project_root_dir}/lib/r.g.dart\"\n  r_dart_file = File.open(r_dart_path, \"w\")\n\n  # ----- Step-10 End -----\n\n  # ----- Step-11 Begin -----\n  # \u751F\u6210 R \u7C7B\u7684\u4EE3\u7801\uFF0C\u8FFD\u52A0\u5199\u5165r.g.dart\n  #\n\n  g_R_class_code = CodeUtil.generate_R_class(package_name)\n  r_dart_file.puts(g_R_class_code)\n\n  # ----- Step-11 End -----\n\n  # ----- Step-12 Begin -----\n  # \u751F\u6210 AssetResource \u7C7B\u7684\u4EE3\u7801\uFF0C\u8FFD\u52A0\u5199\u5165r.g.dart\n  #\n\n  r_dart_file.puts(\"\\n\")\n  g_AssetResource_class_code = CodeUtil.generate_AssetResource_class(package_name)\n  r_dart_file.puts(g_AssetResource_class_code)\n\n  # ----- Step-12 End -----\n\n  # ----- Step-13 Begin -----\n  # \u904D\u5386 non_svg_image_asset \u6570\u7EC4\uFF0C\u751F\u6210 _R_Image_AssetResource \u7C7B\uFF0C\u8FFD\u52A0\u5199\u5165 r.g.dart\n  #\n\n  r_dart_file.puts(\"\\n\")\n  g__R_Image_AssetResource_class_code = CodeUtil.generate__R_Image_AssetResource_class(non_svg_image_asset_array, non_svg_image_asset_id_dict, package_name, is_package_project_type)\n  r_dart_file.puts(g__R_Image_AssetResource_class_code)\n\n  # ----- Step-13 End -----\n\n  # ----- Step-14 Begin -----\n  # \u904D\u5386 svg_image_asset \u6570\u7EC4\uFF0C\u751F\u6210 _R_Svg_AssetResource \u7C7B\uFF0C\u8FFD\u52A0\u5199\u5165 r.g.dart\u3002\n  #\n\n  r_dart_file.puts(\"\\n\")\n  g__R_Svg_AssetResource_class_code = CodeUtil.generate__R_Svg_AssetResource_class(svg_image_asset_array, svg_image_asset_id_dict,  package_name, is_package_project_type)\n  r_dart_file.puts(g__R_Svg_AssetResource_class_code)\n\n  # ----- Step-14 End -----\n\n  # ----- Step-15 Begin -----\n  # \u904D\u5386 text_asset \u6570\u7EC4\uFF0C\u751F\u6210 _R_Image_AssetResource \u7C7B\uFF0C\u8FFD\u52A0\u5199\u5165 r.g.dart\n  #\n\n  r_dart_file.puts(\"\\n\")\n  g__R_Text_AssetResource_class_code = CodeUtil.generate__R_Text_AssetResource_class(text_asset_array, text_asset_id_dict, package_name, is_package_project_type)\n  r_dart_file.puts(g__R_Text_AssetResource_class_code)\n\n  # ----- Step-15 End -----\n\n\n  # ----- Step-16 Begin -----\n  # \u904D\u5386non_svg_image_asset\u6570\u7EC4\uFF0C\u751F\u6210 _R_Image \u7C7B\uFF0C\u8FFD\u52A0\u5199\u5165 r.g.dart\n  #\n\n  r_dart_file.puts(\"\\n\")\n  g__R_Image_class_code = CodeUtil.generate__R_Image_class(non_svg_image_asset_array, non_svg_image_asset_id_dict, package_name)\n  r_dart_file.puts(g__R_Image_class_code)\n\n  # ----- Step-16 End -----\n\n  # ----- Step-17 Begin -----\n  # \u904D\u5386 svg_image_asset \u6570\u7EC4\uFF0C\u751F\u6210 _R_Svg \u7C7B\uFF0C\u8FFD\u52A0\u5199\u5165 r.g.dart\u3002\n  #\n\n  r_dart_file.puts(\"\\n\")\n  g__R_Svg_class_code = CodeUtil.generate__R_Svg_class(svg_image_asset_array, svg_image_asset_id_dict, package_name)\n  r_dart_file.puts(g__R_Svg_class_code)\n\n  # ----- Step-17 End -----\n\n  # ----- Step-18 Begin -----\n  # \u904D\u5386 text_asset \u6570\u7EC4\uFF0C\u751F\u6210 _R_Image \u7C7B\uFF0C\u8FFD\u52A0\u5199\u5165 r.g.dart\u3002\n  #\n\n  r_dart_file.puts(\"\\n\")\n  g__R_Text_class_code = CodeUtil.generate__R_Text_class(text_asset_array, text_asset_id_dict, package_name)\n  r_dart_file.puts(g__R_Text_class_code)\n\n  # ----- Step-18 End -----\n\n  # ----- Step-19 Begin -----\n  # \u904D\u5386font_family_config\u6570\u7EC4\uFF0C\u6839\u636E\u4E0B\u9762\u7684\u6A21\u677F\u751F\u6210_R_Font_Family\u7C7B\uFF0C\u8FFD\u52A0\u5199\u5165r.g.dart\u3002\n\n  r_dart_file.puts(\"\\n\")\n  g__R_Font_Family_class_code = CodeUtil.generate__R_FontFamily_class(font_family_config_array, package_name)\n  r_dart_file.puts(g__R_Font_Family_class_code)\n\n  # ----- Step-19 End -----\n\n  # ----- Step-20 Begin -----\n  # \u7ED3\u675F\u64CD\u4F5C\uFF0C\u4FDD\u5B58 r.g.dart\n  #\n\n  r_dart_file.close\n  puts(\"generate \\\"r.g.dart\\\" done !!!\")\n\n  # ----- Step-20 End -----\n\n  # ----- Step-21 Begin -----\n  # \u8C03\u7528 flutter \u5DE5\u5177\u5BF9 r.g.dart \u8FDB\u884C\u683C\u5F0F\u5316\u64CD\u4F5C\n  #\n\n  dartfmt_line_length = flr_config[\"dartfmt_line_length\"]\n  if dartfmt_line_length.nil? or dartfmt_line_length.is_a?(Integer) == false\n    dartfmt_line_length = Flr::DARTFMT_LINE_LENGTH\n  end\n\n  if dartfmt_line_length < Flr::DARTFMT_LINE_LENGTH\n    dartfmt_line_length = Flr::DARTFMT_LINE_LENGTH\n  end\n\n  flutter_format_cmd = \"flutter format \#{r_dart_path} -l \#{dartfmt_line_length}\"\n  puts(\"execute \\\"\#{flutter_format_cmd}\\\" now ...\")\n  system(flutter_format_cmd)\n  puts(\"execute \\\"\#{flutter_format_cmd}\\\" done !!!\")\n\n  # ----- Step-21 End -----\n\n  # ----- Step-22 Begin -----\n  # \u5224\u65AD\u8B66\u544A\u65E5\u5FD7\u6570\u7EC4\u662F\u5426\u4E3A\u7A7A\uFF0C\u82E5\u4E0D\u4E3A\u7A7A\uFF0C\u8F93\u51FA\u6240\u6709\u8B66\u544A\u65E5\u5FD7\n  #\n\n  if warning_messages.length > 0\n    warning_messages.each do |warning_message|\n      puts(\"\")\n      puts(warning_message)\n    end\n  end\n\n  # ----- Step-22 End -----\n\n  puts(\"[\u221A]: generate for \#{flutter_project_root_dir} done !!!\")\n  puts(\"--------------------------------------------------------------------------------------\")\n\nend\n"

.get_r_dart_library_version ⇒ Object

get the right version of r_dart_library package based on flutter’s version to get more detail, see github.com/YK-Unit/r_dart_library#dependency-relationship-table



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/flr/command.rb', line 144

def self.get_r_dart_library_version
  r_dart_library_version = "0.1.1"

  # $ flutter --version
  # Flutter 1.12.13+hotfix.5 • channel stable • https://github.com/flutter/flutter.git
  # Framework • revision 27321ebbad (5 weeks ago) • 2019-12-10 18:15:01 -0800
  # Engine • revision 2994f7e1e6
  # Tools • Dart 2.7.0
  flutter_version_result = `flutter --version`
  if (flutter_version_result.nil? == true || flutter_version_result.empty? == true)
    return r_dart_library_version
  end

  version_with_hotfix_str = flutter_version_result.split(" ")[1]
  version_without_hotfix_str = version_with_hotfix_str.split("+")[0]

  if Version.new(version_with_hotfix_str) >= Version.new("1.10.15")
    r_dart_library_version = "0.2.1"
  end

  return r_dart_library_version
end

.init_all ⇒ Object 



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/flr/command.rb', line 167

def self.init_all
  flutter_main_project_root_dir = FileUtil.get_flutter_main_project_root_dir

  # ----- Step-1 Begin -----
  # 进行环境检测；若发现不合法的环境，则抛出异常，终止当前进程
  #  - 检测当前flutter主工程根目录是否存在 pubspec.yaml
  #

  begin
    Checker.check_pubspec_file_is_existed(flutter_main_project_root_dir)
  rescue Exception => e
    puts(e.message)
    return
  end

  # ----- Step-1 End -----

  puts("init all flutter projects now...")

  # ----- Step-2 Begin -----
  # 获取主工程和其所有子工程，对它们进行init_one操作
  # - 获取flutter主工程根目录下所有的子工程目录
  # - 初始化主工程
  # - 初始化所有子工程
  #
  flutter_sub_project_root_dir_array = FileUtil.get_flutter_sub_project_root_dirs(flutter_main_project_root_dir)

  puts("")
  init_one(flutter_main_project_root_dir)

  flutter_sub_project_root_dir_array.each do |flutter_project_root_dir|
    puts("")
    init_one(flutter_project_root_dir)
  end

  # ----- Step-2 End -----

  # ----- Step-3 Begin -----
  # 调用 flutter 工具，为主工程和所有子工程获取依赖
  #
  puts("")
  puts("get dependencies for all flutter projects via execute \"flutter pub get\" now ...")

  get_flutter_pub_cmd = "flutter pub get"
  system(get_flutter_pub_cmd)

  puts("[√]: get dependencies for all flutter projects done !!!")

  # ----- Step-3 End -----
  puts("")
  puts("[√]: init all flutter projects 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

.init_one(flutter_project_root_dir) ⇒ Object

对指定 flutter 工程进行初始化



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/flr/command.rb', line 224

def self.init_one(flutter_project_root_dir)
  puts("------------------------------- init specified project -------------------------------")

  puts("init #{flutter_project_root_dir} now...")

  # ----- Step-1 Begin -----
  # 进行环境检测；若发现不合法的环境，则抛出异常，终止当前进程
  #  - 检测 pubspec.yaml 是否存在
  #  - 检测 pubspec.yaml 是否合法
  #
  begin
    Checker.check_pubspec_file_is_existed(flutter_project_root_dir)
    pubspec_file_path = FileUtil.get_pubspec_file_path(flutter_project_root_dir)
    pubspec_config = FileUtil.load_pubspec_config_from_file(pubspec_file_path)
  rescue Exception => e
    puts(e.message)
    puts("[x]: init #{flutter_project_root_dir} failed".error_style)
    puts("--------------------------------------------------------------------------------------")
    return
  end

  # ----- Step-1 End -----

  # ----- Step-2 Begin -----
  # 添加 flr_config 和 r_dart_library 的依赖声明到 pubspec.yaml
  #

  dependencies_config = pubspec_config["dependencies"]

  # 添加flr_config到pubspec.yaml：检测当前是否存在flr_config；若不存在，则添加flr_config；若存在，则按照以下步骤处理：
  #  - 读取dartfmt_line_length选项、assets选项和fonts选项的值（这些选项值若存在，则应用于新建的flr_config；需要注意，使用前需要判断选项值是否合法：dartfmt_line_length选项值 >=80；assets选项和fonts选项的值为数组）
  #  - 新建flr_config，然后使用旧值或者默认值设置各个选项
  #
  # flr_config: Flr的配置信息
  # ```yaml
  # flr:
  #  core_version: 1.0.0
  #  dartfmt_line_length: 80
  #  assets: []
  #  fonts: []
  # ```

  dartfmt_line_length = Flr::DARTFMT_LINE_LENGTH
  asset_resource_dir_array = []
  font_resource_dir_array = []

  old_flr_config = pubspec_config["flr"]
  if old_flr_config.is_a?(Hash)
    dartfmt_line_length = old_flr_config["dartfmt_line_length"]
    if dartfmt_line_length.nil? or dartfmt_line_length.is_a?(Integer) == false
      dartfmt_line_length = Flr::DARTFMT_LINE_LENGTH
    end
    if dartfmt_line_length < Flr::DARTFMT_LINE_LENGTH
      dartfmt_line_length = Flr::DARTFMT_LINE_LENGTH
    end

    asset_resource_dir_array = old_flr_config["assets"]
    if asset_resource_dir_array.nil? or asset_resource_dir_array.is_a?(Array) == false
      asset_resource_dir_array = []
    end

    font_resource_dir_array = old_flr_config["fonts"]
    if font_resource_dir_array.nil? or font_resource_dir_array.is_a?(Array) == false
      font_resource_dir_array = []
    end
  end

  flr_config = Hash["core_version" => "#{Flr::CORE_VERSION}", "dartfmt_line_length" => dartfmt_line_length,  "assets" => asset_resource_dir_array, "fonts" => font_resource_dir_array]
  pubspec_config["flr"] = flr_config

  # 添加 r_dart_library（https://github.com/YK-Unit/r_dart_library）的依赖声明
  #  - 获取正确的库版本
  #  - 添加依赖声明
  #
  # r_dart_library的依赖声明：
  # ```yaml
  # r_dart_library:
  #  git:
  #    url: "https://github.com/YK-Unit/r_dart_library.git"
  #    ref: 0.1.1
  # ```
  r_dart_library_version = get_r_dart_library_version
  r_dart_library_config = Hash["git" => Hash["url" => "https://github.com/YK-Unit/r_dart_library.git", "ref" => r_dart_library_version]]
  dependencies_config["r_dart_library"] = r_dart_library_config
  pubspec_config["dependencies"] = dependencies_config

  puts("add flr configuration into pubspec.yaml done!")
  puts("add dependency \"r_dart_library\"(https://github.com/YK-Unit/r_dart_library) into pubspec.yaml done!")

  # ----- Step-2 End -----

  # ----- Step-3 Begin -----
  # 对Flutter配置进行修正，以避免执行获取依赖操作时会失败：
  # - 检测Flutter配置中的assets选项是否是一个非空数组；若不是，则删除assets选项；
  # - 检测Flutter配置中的fonts选项是否是一个非空数组；若不是，则删除fonts选项。
  #

  flutter_config = pubspec_config["flutter"]
  if flutter_config.nil?
    flutter_config = {}
  end

  flutter_assets = flutter_config["assets"]
  should_rm_flutter_assets_Key = true
  if flutter_assets.is_a?(Array) == true and flutter_assets.empty? == false
    should_rm_flutter_assets_Key = false
  end
  if should_rm_flutter_assets_Key
    flutter_config.delete("assets")
  end

  flutter_fonts = flutter_config["fonts"]
  should_rm_flutter_fonts_Key = true
  if flutter_fonts.is_a?(Array) == true and flutter_fonts.empty? == false
    should_rm_flutter_fonts_Key = false
  end
  if should_rm_flutter_fonts_Key
    flutter_config.delete("fonts")
  end

  pubspec_config["flutter"] = flutter_config

  # ----- Step-3 End -----

  # 保存 pubspec.yaml
  FileUtil.dump_pubspec_config_to_file(pubspec_config, pubspec_file_path)

  puts("[√]: init #{flutter_project_root_dir} done !!!")
  puts("--------------------------------------------------------------------------------------")

end

.start_monitor ⇒ Object

启动一个资源变化监控服务，若检测到flutter主工程和其子工程有资源变化，就自动执行generate_all操作；手动输入‘Ctrl-C`，可终止当前服务



867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'lib/flr/command.rb', line 867

def self.start_monitor

  flutter_main_project_root_dir = FileUtil.get_flutter_main_project_root_dir

  # ----- Step-1 Begin -----
  # 对flutter主工程进行环境检测:
  #  - 检测当前flutter主工程根目录是否存在 pubspec.yaml
  #

  begin
    Checker.check_pubspec_file_is_existed(flutter_main_project_root_dir)
  rescue Exception => e
    puts(e.message)
    return
  end

  # ----- Step-1 End -----


  # ----- Step-2 Begin -----
  # 对flutter工程进行合法资源目录检测:
  # - 获取主工程的所有子工程根目录，生成工程根目录数组flutter_project_root_dir_array
  # - 遍历flutter_project_root_dir_array，获取每个工程的legal_resource_dir数组：
  #   - 从flr_config中的assets配置获取assets_legal_resource_dir数组；
  #   - 从flr_config中的fonts配置获取fonts_legal_resource_dir数组；
  #   - 合并assets_legal_resource_dir数组和fonts_legal_resource_dir数组到legal_resource_dir数组。
  # - 检测legal_resource_dir数组是否为空，为空则结束运行。
  #
  puts("")
  puts("get the valid resource directories of all projects now ...")

  flutter_main_project_root_dir = FileUtil.get_flutter_main_project_root_dir
  flutter_sub_project_root_dir_array = FileUtil.get_flutter_sub_project_root_dirs(flutter_main_project_root_dir)

  flutter_project_root_dir_array = []
  flutter_project_root_dir_array.push(flutter_main_project_root_dir)
  flutter_project_root_dir_array += flutter_sub_project_root_dir_array

  # 合法的资源目录数组
  legal_resource_dir_array = []
  # 非法的资源目录数组
  illegal_resource_dir_array = []

  flutter_project_root_dir_array.each do |flutter_project_root_dir|
    begin
      puts("")
      puts("--------------------------- get info of specified project ----------------------------")
      puts("get the valid resource directories from #{flutter_project_root_dir} now...")

      Checker.check_pubspec_file_is_existed(flutter_project_root_dir)

      pubspec_file_path = FileUtil.get_pubspec_file_path(flutter_project_root_dir)

      pubspec_config = FileUtil.load_pubspec_config_from_file(pubspec_file_path)

      Checker.check_flr_config_is_existed(pubspec_config)

      flr_config = pubspec_config["flr"]

      resource_dir_result_tuple = Checker.check_flr_assets_is_legal(flutter_project_root_dir, flr_config)

      assets_legal_resource_dir_array = resource_dir_result_tuple[0]
      fonts_legal_resource_dir_array = resource_dir_result_tuple[1]
      legal_resource_dir_array += (assets_legal_resource_dir_array + fonts_legal_resource_dir_array)

      illegal_resource_dir_array += resource_dir_result_tuple[2]
      puts("get the valid resource directories from #{flutter_project_root_dir} done !!!")
      puts("--------------------------------------------------------------------------------------")
    rescue Exception => e
      puts(e.message)
      puts("[x]: #{flutter_project_root_dir} has no valid resource directories".error_style)
      puts("--------------------------------------------------------------------------------------")
    end
  end

  if legal_resource_dir_array.length <= 0
    puts("")
    puts("[x]: have no valid resource directories to be monitored".error_style)
    return
  end

  puts("")
  puts("get the valid resource directories of all projects done !!!")

  # ----- Step-2 End -----


  # ----- Step-3 Begin -----
  # 执行一次 generate_all 操作
  #

  puts("")
  puts("now generate for all projects once before launching the monitoring service ...")
  puts("")
  generate_all
  puts("")
  puts("did generate for all projects, now is going to launching the monitoring service ...")

  # ----- Step-3 End -----


  # ----- Step-4 Begin -----
  # 启动资源监控服务
  #  - 启动一个文件监控服务，对 legal_resource_dir 数组中的资源目录进行文件监控
  #  - 若服务检测到资源变化（资源目录下的发生增/删/改文件），则执行一次 flr generate 操作
  #

  puts("")
  now_str = Time.now.to_s
  puts("----------------------------- #{now_str} -----------------------------")
  puts("launch a monitoring service now ...")
  puts("launching ...")
  # stop the monitoring service if exists
  stop_monitor
  puts("launch a monitoring service done !!!")
  puts("the monitoring service is monitoring the following resource directory:")
  legal_resource_dir_array.each do |resource_dir|
    puts("  - #{resource_dir}")
  end
  if illegal_resource_dir_array.length > 0
    puts("")
    puts("[!]: warning, found the following resource directory which is not existed: ".warning_style)
    illegal_resource_dir_array.each do |resource_dir|
      puts("  - #{resource_dir}".warning_style)
    end
  end
  puts("--------------------------------------------------------------------------------------")
  puts("\n")

  # Allow array of directories as input #92
  # https://github.com/guard/listen/pull/92
  @@listener = Listen.to(*legal_resource_dir_array, ignore: [/\.DS_Store/], latency: 0.5, wait_for_delay: 5, relative: true) do |modified, added, removed|
    # for example: 2013-03-30 03:13:14 +0900
    now_str = Time.now.to_s
    puts("----------------------------- #{now_str} -----------------------------")
    puts("modified resource files: #{modified}")
    puts("added resource files: #{added}")
    puts("removed resource files: #{removed}")
    puts("generate for all projects now ...")
    puts("\n")
    generate_all
    puts("\n")
    puts("generate for all projects done !!!")
    puts("--------------------------------------------------------------------------------------")
    puts("\n")
    puts("[*]: the monitoring service is monitoring the asset changes, and then auto scan assets, specifies assets and generates \"r.g.dart\" ...".tips_style)
    puts("[*]: you can press \"Ctrl-C\" to terminate it".tips_style)
    puts("\n")
  end
  # not blocking
  @@listener.start

  # https://ruby-doc.org/core-2.5.0/Interrupt.html
  begin
    puts("[*]: the monitoring service is monitoring the asset changes, and then auto scan assets, specifies assets and generates \"r.g.dart\" ...".tips_style)
    puts("[*]: you can press \"Ctrl-C\" to terminate it".tips_style)
    puts("\n")
    loop {}
  rescue Interrupt => e
    stop_monitor
    puts("")
    puts("[√]: terminate monitor service done !!!")
  end

  # ----- Step-4 End -----

end

.stop_monitor ⇒ Object

停止资源变化监控服务



1036
1037
1038
1039
1040
1041
 
# File 'lib/flr/command.rb', line 1036

def self.stop_monitor
  if @@listener.nil? == false
    @@listener.stop
    @@listener = nil
  end
end

.version ⇒ Object

display the version of flr



31
32
33
34
 
# File 'lib/flr/command.rb', line 31

def self.version
  version_desc = "Flr version #{Flr::VERSION}\nCoreLogic version #{Flr::CORE_VERSION}"
  puts(version_desc)
end