搜尋套件、儲存庫與 APP 分類

套件詳情v2.2.1

enum_to_string

更好的列舉轉換為字串。Dart 在呼叫 enum.toString 時會使用令人困擾的 EnumName.ValueName 語法,此套件解決了這個問題。

AndroidiOSWebmacOSWindowsLinux
近 30 天下載
17.7萬
喜歡數
331
Pub 分數
150

安裝套件

flutter pub add enum_to_string

套件介紹

根據套件公開資料產生的選型評估,僅供參考。

一個 Dart 套件,透過消除冗長的 EnumName.ValueName 語法,簡化了列舉轉換為字串的過程。它提供一種乾淨直覺的方式來取得列舉值的字串表示,提升可讀性並減少重複程式碼。非常適合經常處理列舉且希望獲得更簡單 toString() 替代方案的開發者。此套件支援所有主要平台,並能順暢整合至 Flutter 項目中。

適用情境

  • 在 UI 中將列舉值轉換為可讀字串
  • 簡化列舉資料的序列化
  • 改進日誌中列舉狀態的程式碼可讀性
  • 在 API 請求或設定中使用列舉字串
  • 避免重複的 EnumName.ValueName 參考

主要特色

  • 乾淨的列舉到字串轉換
  • 消除冗長的列舉語法
  • 支援所有 Flutter 平台
  • 最小化設定和整合
  • 提升程式碼可維護性

適合對象

  • 使用列舉的 Flutter 開發人員
  • 需要列舉字串序列化的專案
  • 重視程式碼乾淨、易讀的團隊
  • 頻繁使用列舉的應用程式
  • 尋求減少樣板程式碼的開發者

使用建議

  • 需要手動註冊列舉
  • 可能不支援所有進階列舉模式
  • 僅限基本字串表示需求
  • 不適合複雜的列舉轉換
  • 依賴於正確的列舉實現

原始 README

以下為關聯原始碼儲存庫的 README 原文快照,最新內容請造訪原始碼儲存庫。

enum_to_string

CI

Better conversion of ENUMs to string - It also can handle converting back again!

What it does

It takes an enum such as:

enum TestEnum { testValue1 }

and converts it to

testValue1

Also handles camel case

Input enum TestEnum { testValue1 } Output Test value 1

You can also capitalize all words using the capitalizeWords flag: Input enum TestEnum { testValue1 } Output with capitalizeWords: true: Test Value 1

Usage

import 'package:enum_to_string/enum_to_string.dart';

enum TestEnum { testValue1, testValue2 };

convert(){
    String result = EnumToString.convertToString(TestEnum.testValue1);
    //result = 'testValue1'

    String result = EnumToString.convertToString(TestEnum.testValue1, camelCase: true);
    //result = 'Test value 1'

    String result = EnumToString.convertToString(TestEnum.testValue1, camelCase: true, capitalizeWords: true);
    //result = 'Test Value 1'

    EnumToString.fromString(TestEnum.values, "testValue1"); //Enum
    // TestEnum.testValue1

    EnumToString.fromString(TestEnum.values, "Test Value 1", camelCase: true);
    // TestEnum.testValue1

    List<String> result = EnumToString.toList(TestEnum.values);
    //result = ['testValue1','testValue2'],

    List<String> result = EnumToString.toList(TestEnum.values, camelCase: true);
    //result = ['Test value 1','Test value 2'],
    
    List result = EnumToString.fromList(TestEnum.values, ["ValueOne", "Value2"]); //List<Enum>
    //result = [TestEnum.valueOne, TestEnum.value2];
}

Contributing

Any pull requests / extensions welcome, this was just an annoying thing I needed to fix a couple of times so viola! a package was born.

The project uses GitHub Actions for CI (migrated from Travis CI), which automatically runs the following checks on all pull requests:

  • Dart formatting
  • Static analysis
  • Tests

You can run all checks locally before submitting a PR using the provided script:

./tool/check.sh

Or run them individually:

# Get dependencies
dart pub get

# Format code
dart format --output=none --set-exit-if-changed .

# Run static analysis
dart analyze

# Run tests
dart test

The CI pipeline requires all tests to pass. Please ensure your changes include appropriate test coverage.

Enhanced Enum Support (Dart 2.17+)

Starting from version 2.2.0, this package supports Dart's enhanced enums with custom string mappings. This is particularly useful when you need enum string representations that can't be valid Dart identifiers.

enum Rating {
  G,
  PG13('PG-13'),  // Custom mapping with hyphen
  R,
  unrated;        // Falls back to normal EnumToString behavior

  final String? value;
  const Rating([this.value]);
}

void main() {
  // Custom mapped values use their explicit mapping
  print(EnumToString.convertToString(Rating.PG13));  // Prints: PG-13
  
  // Unmapped values use normal EnumToString behavior
  print(EnumToString.convertToString(Rating.unrated));  // Prints: unrated
  
  // All other EnumToString features work as expected
  print(EnumToString.fromString(Rating.values, 'PG-13') == Rating.PG13);  // true
  print(EnumToString.toList(Rating.values));  // ['G', 'PG-13', 'R', 'unrated']
}

This feature is particularly useful when:
- You need special characters in your enum strings (like hyphens or spaces)
- Your enum strings need to match an external API or format exactly
- You want some enum values to have custom string representations while others use the default behavior

所屬分類

原始碼儲存庫

使用此套件的專案