Refactor Plugin + add missed typing

.github/actions/setup-node-pnpm-install/action.yml

@@ -0,0 +1,26 @@
+# ✍️ Description:
+# This is a composite action, which means it can be used in other actions.
+# It is used in almost all workflows to set up the environment and install dependencies.
+# Updating  the package manager or Node version here will be reflected in all workflows.
+
+# 👀 Example usage:
+#       - name : 📦 Setup Node + PNPM + install deps
+#         uses: ./.github/actions/setup-node-pnpm-install
+
+name: 'Setup  Node + PNPM + Install Dependencies'
+description: 'Setup  Node + PNPM + Install Dependencies'
+runs:
+  using: 'composite'
+  steps:
+    - uses: pnpm/action-setup@v4
+      with:
+        run_install: false
+        version: 9
+    - uses: actions/setup-node@v4
+      with:
+        node-version: 20
+        cache: 'pnpm'
+
+    - name: 📦 Install Project Dependencies
+      run: pnpm install --frozen-lockfile
+      shell: bash

.github/workflows/new-gh-release.yml

@@ -13,7 +13,7 @@ jobs:
       contents: write
     steps:
       - name: 📦 Checkout project repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 

.github/workflows/publish-pkg.yaml

@@ -29,7 +29,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: echo "GH_TOKEN=${GITHUB_TOKEN}" >> $GITHUB_ENV
       - name: 📦 Checkout project repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: master
@@ -40,17 +40,8 @@ jobs:
           git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
           git config --global user.name "github-actions[bot]"
 
-      - uses: pnpm/action-setup@v2
-        with:
-          version: 8
-
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 18
-          cache: 'pnpm'
-
-      - name: 📦 Install Project Dependencies
-        run: pnpm install --frozen-lockfile
+      - name : 📦 Setup Node + PNPM + install deps
+        uses: ./.github/actions/setup-node-pnpm-install
 
       - name: 🏃‍♂️ Create tag
         run: |

.github/workflows/validate-pr.yaml

@@ -12,82 +12,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name : 📦 Checkout project repo
-        uses: actions/checkout@v3
-      - uses: pnpm/action-setup@v2
-        with:
-          version: 8
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 18
-          cache: 'pnpm'
-
-
-      - name: 📦 Install Project Dependencies
-        run: pnpm install --frozen-lockfile
+        uses: actions/checkout@v4
+      - name : 📦 Setup Node + PNPM + install deps
+        uses: ./.github/actions/setup-node-pnpm-install
       - name: 🏃‍♂️ Run TypeScript
-        run : pnpm run type-check
-
-      # - name: 🏃‍♂️ Run TypeScript # Reviewdog tsc errorformat: %f:%l:%c - error TS%n: %m
-      #   run: |
-      #     yarn type-check | reviewdog -name="tsc" -efm="%f(%l,%c): error TS%n: %m" -reporter="github-pr-review" -filter-mode="nofilter" -fail-on-error -tee
-      #   env:
-      #     REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-
-  # lint:
-  #   name: Lint TS (eslint, prettier)
-  #   runs-on: ubuntu-latest
-
-  #   steps:
-  #     - name : 📦 Checkout project repo
-  #       uses: actions/checkout@v3
-  #     - uses: pnpm/action-setup@v2
-  #       with:
-  #         version: 8
-  #     - uses: actions/setup-node@v3
-  #       with:
-  #         node-version: 18
-  #         cache: 'pnpm'
-
-
-  #     - name: 📦 Install Project Dependencies
-  #       run: pnpm install --frozen-lockfile
-  #     - name: 🏃‍♂️ Run ESLint
-  #       run : pnpm run lint
-      # - name: 🏃‍♂️ Run ESLint
-      #   uses: reviewdog/action-eslint@v1
-      #   with:
-      #     github_token: ${{ secrets.GITHUB_TOKEN }}
-      #     reporter: github-pr-review
-      #     eslint_flags: '. --ext .js,.jsx,.ts,.tsx'
-
-  # test:
-  #   name: Tests (jest)
-  #   runs-on: ubuntu-latest
-
-  #   steps:
-  #     - name : 📦 Checkout project repo
-  #       uses: actions/checkout@v3
-  #     - uses: actions/setup-node@v3
-  #       with:
-  #         node-version: 18
-  #         cache: 'yarn'
-
-  #     - name: 📦 Get yarn cache directory path
-  #       id: yarn-cache-dir-path
-  #       run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
-
-  #     - name: 📦 Restore Project Dependencies (node_modules)
-  #       uses: actions/cache@v3
-  #       id: yarn-cache
-  #       with:
-  #         path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-  #         key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-  #         restore-keys: |
-  #           ${{ runner.os }}-yarn-
-
-  #     - name: 📦 Install Project Dependencies
-  #       run: yarn install --immutable
-
-  #     - name: 🏃‍♂️ Run Tests
-  #       run: yarn test:ci
+        run : pnpm run type-check

.gitignore

@@ -3,3 +3,5 @@ assets/*.*.png
 example/*.*.png
 dist
 .DS_Store
+ios/
+android/

.prettierrc.json

@@ -1,4 +1,5 @@
 {
   "singleQuote": true,
-  "endOfLine": "auto"
+  "endOfLine": "auto",
+  "trailingComma": "es5"
 }

README.md

@@ -153,7 +153,9 @@ Commands:
   use-config <configPath>         use json file as a config
   help [command]                  display help for command
 ```
+
 - **add-badge command**
+
 ```
 Usage: app-icon-badge add-badge [options] <iconPath>
 
@@ -169,10 +171,13 @@ Options:
   -b, --background <background>  badge background color
   -c, --color <color>            badge color (choices: "white", "black", default: "white")
 ```
+
 #### example
+
 ```
 npx app-icon-badge ./example/icon.png --type=banner --text=hello --position=top --background=#45f4ee --color=black
 ```
+
 ## 🚧 RoadMap
 
 The library is still in its early stages. We have a lot of ideas to improve it and make it more useful. Here are some of the things we have already had the chance to implement, as well as our plans for additions in the future:

cli/parse-arguments.ts

@@ -1,6 +1,6 @@
 import { parseBadgeJsonConfigFile } from './parse-badge-json-config-file';
 import { IconConfig } from './icon-config';
-import { addBadge } from '..';
+import { addBadge } from '../src/index';
 import { Badge } from '../types';
 import { Command, Option } from 'commander';
 

cli/parse-badge-json-config-file.ts

@@ -3,7 +3,7 @@ import type { Params } from '../types';
 import { validateConfig } from './config-validation';
 import path from 'path';
 import chalk from 'chalk';
-import { addBadge } from '../index';
+import { addBadge } from '../src/index';
 
 export function parseBadgeJsonConfigFile(filePath: string) {
   const resolvedPath = path.resolve(filePath);

cli/types.ts

@@ -1,24 +1 @@
-export type Banner = {
-  type: 'banner';
-  text: string;
-  position?: 'top' | 'bottom';
-  color?: 'white' | 'black';
-  background?: string;
-};
-
-export type Ribbon = {
-  type: 'ribbon';
-  text: string;
-  position?: 'left' | 'right';
-  color?: 'white' | 'black';
-  background?: string;
-};
-
-export type Badge = Banner | Ribbon;
-
-export type Params = {
-  icon: string;
-  dstPath?: string;
-  badges: Array<Badge>;
-  isAdaptiveIcon?: boolean;
-};
+export * from '../types';

demo/.gitignore

@@ -0,0 +1,16 @@
+node_modules/
+.expo/
+dist/
+npm-debug.*
+*.jks
+*.p8
+*.p12
+*.key
+*.mobileprovision
+*.orig.*
+web-build/
+ios/
+android/
+
+# macOS
+.DS_Store

demo/.npmrc

@@ -0,0 +1 @@
+enable-pre-post-scripts=true