ci: add codecov config, publish on release

.github/workflows/ci.yaml

@@ -1,39 +1,21 @@
 name: ci
 on:
+  workflow_dispatch:
   pull_request:
     branches:
       - master
 
 jobs:
   kana_kit:
-    runs-on: ubuntu-latest
     container:
-      image: "google/dart:2.8.4"
+      image: google/dart:2.8.4
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
 
       - name: Install dependencies
         run: pub get
 
-      - name: Dry run publish
-        id: dry_run_publish
-        uses: k-paxian/dart-package-publisher@master
-        with:
-          dryRunOnly: true
-          skipTests: true
-          credentialJson: ${{ secrets.CREDENTIAL_JSON }}
-
-      - name: Compare versions
-        run: |
-          if [ "${{steps.dry_run_publish.outputs.localVersion}}" = "${{steps.dry_run_publish.outputs.remoteVersion}}" ]; then
-            echo "Local package version number ${{steps.dry_run_publish.outputs.localVersion}} and remote pub version number ${{steps.dry_run_publish.outputs.remoteVersion}} are the same."
-            echo "Update the local version number."
-            exit 1
-          else
-            exit 0
-          fi
-
-
       - name: Format
         run: dartfmt --dry-run --set-exit-if-changed .
 
@@ -53,5 +35,3 @@ jobs:
           path: ./coverage/lcov.info
           exclude: "**/*.g.dart lib/src/models/romanization/**"
           min_coverage: 99
-
-          name: Publish plugin

.github/workflows/publish_to_pub.yaml

@@ -1,8 +1,7 @@
 name: publish_to_pub
 on:
-  push:
-    branches:
-      - master
+  release:
+    types: [published]
 
 jobs:
   publish:
@@ -12,7 +11,17 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Publish to pub
+        id: publish
         uses: k-paxian/dart-package-publisher@master
         with:
           skipTests: true
           credentialJson: ${{ secrets.CREDENTIAL_JSON }}
+
+      - name: Verify published
+        run: |
+          if [ "${{steps.publish.outputs.success}}" = "false" ]; then
+            echo "Publishing failed."
+            exit 1
+          else
+            exit 0
+          fi

CHANGELOG.md

@@ -1,13 +1,20 @@
-## [1.0.2] - 2020-07-22
+## 1.0.3
+
+- Add codecov.yml.
+- Change `publish_to_pub` workflow to run on GitHub release publishing.
+- Improve README format with fancy badge.
+- Improve CHANGELOG format for fancy new pub.dev.
+
+## 1.0.2
 
 - Small CI/CD pipeline fix.
 
-## [1.0.1] - 2020-07-22
+## 1.0.1
 
 - Initial pub release.
 - Improved README.
 - Added pub publishing CD workflow.
 
-## [1.0.0] - 2020-07-22
+## [1.0.0
 
 - Initial release 🎉

README.md

@@ -1,6 +1,37 @@
-# KanaKit (カナ・キット)
-
-A Dart library for for detecting and transliterating Hiragana, Katakana, and Romaji.
+<div align="center">
+  <h1>KanaKit (かな・キット)</h1>
+  <h4>A Dart library for for detecting and transliterating Hiragana, Katakana, and Romaji.</h4>
+</div>
+
+<div align="center">
+  <a href="https://pub.dev/packages/kana_kit"
+    ><img alt="Pub Version" src="https://img.shields.io/pub/v/kana_kit"
+  /></a>
+  <a href="https://codecov.io/gh/jeroen-meijer/kana_kit"
+    ><img
+      alt="Codecov"
+      src="https://img.shields.io/codecov/c/github/jeroen-meijer/kana_kit"
+  /></a>
+  <a href="https://github.com/jeroen-meijer/kana_kit/commits/"
+    ><img
+      alt="GitHub last commit"
+      src="https://img.shields.io/github/last-commit/jeroen-meijer/kana_kit"
+  /></a>
+  <a href="https://github.com/jeroen-meijer/kana_kit/issues">
+    <img
+      alt="GitHub issues"
+      src="https://img.shields.io/github/issues/jeroen-meijer/kana_kit"
+    />
+  </a>
+  <a href="https://pub.dev/documentation/kana_kit/latest/">
+    <img
+      alt="Documentation"
+      src="https://img.shields.io/badge/read-the%20docs-blue"
+    />
+  </a>
+</div>
+
+---
 
 This library is mostly a direct port of [WaniKani's WanaKana JavaScript library](https://github.com/WaniKani/WanaKana).
 
@@ -16,7 +47,7 @@ It contains all available methods for detecting and converting Japanese text.
 // If no config is provided, KanaKitConfig.defaultConfig is used.
 const kanaKit = KanaKit();
 
-// String checks
+// Checks
 kanaKit.isJapanese('泣き虫。！～２￥ｚｅｎｋａｋｕ') // true
 
 kanaKit.isKana('あーア') // true
@@ -30,7 +61,7 @@ kanaKit.isKanji('勢い') // false
 
 kanaKit.isRomaji('Tōkyō and Ōsaka') // true
 
-// String converters
+// Converters
 kanaKit.toKana('ONAJI buttsuuji') // 'オナジ ぶっつうじ'
 kanaKit.toKana('座禅‘zazen’スタイル') // '座禅「ざぜん」スタイル'
 kanaKit.toKana('batsuge-mu') // 'ばつげーむ'
@@ -41,10 +72,9 @@ kanaKit.toKatakana('toukyou, おおさか') // 'トウキョウ、　オオサ
 kanaKit.toRomaji('ひらがな　カタカナ') // 'hiragana katakana'
 
 // Use upcaseKatakana to capitalize characters that were converted from Katakana.s
-final kanaKitWithUpcaseKatakana = kanaKit(
-  upcaseKatakana: true,
-);
-kanaKitWithUpcaseKatakana.toRomaji('ひらがな　カタカナ') // 'hiragana KATAKANA'
+kanaKit
+  .copyWithConfig(upcaseKatakana: true)
+  .toRomaji('ひらがな　カタカナ') // 'hiragana KATAKANA'
 ```
 
 ### LICENSE

codecov.yml

@@ -0,0 +1,10 @@
+codecov:
+  require_ci_to_pass: true
+
+coverage:
+  precision: 3
+  range: "99...100"
+
+ignore:
+  - "**/*.g.dart"
+  - "lib/src/models/romanization/**"

pubspec.yaml

@@ -1,8 +1,8 @@
 name: kana_kit
 description: >
-  A Dart library for handling and converting Japanese
-  characters such as hiragana, katakana and kanji.
-version: 1.0.2
+  A Dart library for for detecting and transliterating
+  Hiragana, Katakana, and Romaji.
+version: 1.0.3
 homepage: https://pub.dev/packages/kana_kit
 repository: https://github.com/jeroen-meijer/kana_kit
 

scripts/pre_commit.sh

@@ -12,8 +12,8 @@ lcov --remove ./coverage/lcov.info -o ./coverage/filtered.info\
   'lib/src/models/romanization/**'
 genhtml -o coverage ./coverage/filtered.info
 open ./coverage/index.html
-echo "Running dartdoc..."
-dartdoc
+echo "Running dry run publish..."
+pub publish --dry-run
 
 echo ""
 echo "Done."