Skip to content

Commit 1b78bae

Browse files
bdlukaabdlukaa
committed
chore: Prepare app for pub.dev release
1 parent e9b5223 commit 1b78bae

6 files changed

Lines changed: 127 additions & 5 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
analyze:
11+
name: Analyze
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v4
15+
- uses: dart-lang/setup-dart@v1
16+
with:
17+
sdk: stable
18+
19+
- name: Install dependencies
20+
run: dart pub get
21+
22+
- name: Verify formatting
23+
run: dart format --output=none --set-exit-if-changed .
24+
25+
- name: Analyze project source
26+
run: dart analyze --fatal-infos
27+
28+
test:
29+
name: Test
30+
runs-on: ubuntu-latest
31+
steps:
32+
- uses: actions/checkout@v4
33+
- uses: dart-lang/setup-dart@v1
34+
with:
35+
sdk: stable
36+
37+
- name: Install dependencies
38+
run: dart pub get
39+
40+
- name: Run tests
41+
run: dart test
42+
43+
benchmark:
44+
name: Benchmark
45+
runs-on: ubuntu-latest
46+
steps:
47+
- uses: actions/checkout@v4
48+
- uses: dart-lang/setup-dart@v1
49+
with:
50+
sdk: stable
51+
52+
- name: Install dependencies
53+
run: dart pub get
54+
55+
- name: Run benchmarks
56+
run: dart run benchmark/romanize_benchmark.dart
57+

‎.github/workflows/publish.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Publish
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*'
7+
8+
jobs:
9+
publish:
10+
name: Publish to pub.dev
11+
runs-on: ubuntu-latest
12+
permissions:
13+
id-token: write
14+
steps:
15+
- uses: actions/checkout@v4
16+
- uses: dart-lang/setup-dart@v1
17+
with:
18+
sdk: stable
19+
20+
- name: Install dependencies
21+
run: dart pub get
22+
23+
- name: Verify formatting
24+
run: dart format --output=none --set-exit-if-changed .
25+
26+
- name: Analyze
27+
run: dart analyze --fatal-infos
28+
29+
- name: Run tests
30+
run: dart test
31+
32+
- name: Publish to pub.dev
33+
run: dart pub publish --force
34+

‎LICENSE‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
BSD 3-Clause License
2+
3+
Copyright (c) 2025, Bruno D'Luka
4+
All rights reserved.
5+
6+
Redistribution and use in source and binary forms, with or without
7+
modification, are permitted provided that the following conditions are met:
8+
9+
1. Redistributions of source code must retain the above copyright notice, this
10+
list of conditions and the following disclaimer.
11+
12+
2. Redistributions in binary form must reproduce the above copyright notice,
13+
this list of conditions and the following disclaimer in the documentation
14+
and/or other materials provided with the distribution.
15+
16+
3. Neither the name of the copyright holder nor the names of its
17+
contributors may be used to endorse or promote products derived from
18+
this software without specific prior written permission.
19+
20+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30+

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ Some romanizers have additional options. For example, the `ChineseRomanizer` has
8787
## Supported Languages
8888

8989
- **Korean** (한국어)
90-
- **Japanese** (日本語) - Using `kana_kit` for Kana conversion
91-
- **Chinese** (中文) - Using `pinyin` for Pinyin conversion (Simplified and Traditional)
90+
- **Japanese** (日本語) - Using [`kana_kit`](https://pub.dev/packages/kana_kit) for Kana conversion
91+
- **Chinese** (中文) - Using [`pinyin`](https://pub.dev/packages/pinyin) for Pinyin conversion (Simplified and Traditional)
9292
- **Cyrillic** (Кириллица) - Custom transliteration for Russian, Ukrainian, Serbian, and more
9393
- **Arabic** (العربية) - Custom transliteration based on ISO 233 and DIN 31635
9494

‎pubspec.yaml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
name: romanize
2-
description: Convert text to Romanized form.
2+
description: A lightweight Dart package for converting Korean, Japanese, Chinese, Cyrillic, and Arabic text to Romanized form with auto-detection support.
33
version: 0.0.1
4-
# repository: https://github.com/my_org/my_repo
4+
repository: https://github.com/themelodyai/romanize
5+
issue_tracker: https://github.com/themelodyai/romanize/issues
56

67
environment:
78
sdk: ^3.8.0

‎test/romanize_test.dart‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ void main() {
4848
test('should return empty string for whitespace-only input', () {
4949
const input = ' \n\t ';
5050
final result = TextRomanizer.romanize(input);
51-
expect(result, isEmpty);
51+
expect(result, equals(input));
5252
});
5353

5454
test(

0 commit comments

Comments
 (0)