locale_sheet 0.0.1

Excelスプレッドシートを単一の真実の情報源として扱い、ローカライズ文字列を複数形式（ARB等）に変換するDart CLIツール。

locale_sheet

README (English) | README (日本語)

locale_sheet is a lightweight Dart CLI and library that treats an Excel spreadsheet as a single source of truth and converts localization strings into multiple output formats (currently: ARB).

Quick Start

1. Add the dependency to your pubspec.yaml:

dependencies:
  locale_sheet: ^0.0.1

2. Install dependencies and run the CLI:

dart pub get
dart run bin/locale_sheet.dart export --input path/to/translations.xlsx --format arb --out ./lib/l10n

3. Programmatic usage (minimal):

import 'package:args/command_runner.dart';
import 'package:locale_sheet/locale_sheet.dart';

void main() async {
  final runner = CommandRunner<int>('locale_sheet', 'programmatic runner')
    ..addCommand(ExportCommand());

  await runner.run(['export', '--input', 'path/to/file.xlsx', '--out', './lib/l10n']);
}

Features

• Parses Excel (.xlsx) into an internal model
• Exports to ARB format (keys are sorted alphabetically)
• Available as both a CLI and a library

Usage

• CLI options:

  • --input / -i: Path to the input XLSX file (required)
  • --format: Output format (e.g. arb)
  • --out / -o: Output directory (default: .)

• Main public API:

  • convertExcelToArb({required String inputPath, required String outDir, ExcelParser? parser, LocalizationExporter? exporter})
  • convertExcelBytesToArb(Uint8List bytes, LocalizationExporter exporter, String outDir, {ExcelParser? parser})
  • ExportCommand — can be registered with a CommandRunner to run the CLI programmatically.

Examples

See the example/ directory for sample XLSX files and example usage.

Exit Codes & Error Handling

• 64 — argument error / UsageException
• 1 — runtime error (file I/O, parsing errors, etc.)

Testing & Coverage

Run unit tests with:

dart test

Generate coverage using the bundled script:

bash scripts/coverage.sh

Contributing

• Format code: dart format .
• Add/update tests: dart test
• Update coverage: bash scripts/coverage.sh

License

MIT