[add] Toolchain Configuration files for Engineering Automation (#2)

Author: TechQuery

.github/pr-badge.yml

@@ -0,0 +1,17 @@
+- icon: visualstudio
+  label: 'GitHub.dev'
+  message: 'PR-$prNumber'
+  color: 'blue'
+  url: 'https://github.dev/$owner/$repo/pull/$prNumber'
+
+- icon: github
+  label: 'GitHub codespaces'
+  message: 'PR-$prNumber'
+  color: 'black'
+  url: 'https://codespaces.new/$owner/$repo/pull/$prNumber'
+
+- icon: git
+  label: 'GitPod.io'
+  message: 'PR-$prNumber'
+  color: 'orange'
+  url: 'https://gitpod.io/?autostart=true#https://github.com/$owner/$repo/pull/$prNumber'

.github/settings.yml

@@ -0,0 +1,85 @@
+# These settings are synced to GitHub by https://probot.github.io/apps/settings/
+
+repository:
+  allow_merge_commit: false
+
+  delete_branch_on_merge: true
+
+  enable_vulnerability_alerts: true
+
+labels:
+  - name: bug
+    color: '#d73a4a'
+    description: Something isn't working
+
+  - name: documentation
+    color: '#0075ca'
+    description: Improvements or additions to documentation
+
+  - name: duplicate
+    color: '#cfd3d7'
+    description: This issue or pull request already exists
+
+  - name: enhancement
+    color: '#a2eeef'
+    description: Some improvements
+
+  - name: feature
+    color: '#16b33f'
+    description: New feature or request
+
+  - name: good first issue
+    color: '#7057ff'
+    description: Good for newcomers
+
+  - name: help wanted
+    color: '#008672'
+    description: Extra attention is needed
+
+  - name: invalid
+    color: '#e4e669'
+    description: This doesn't seem right
+
+  - name: question
+    color: '#d876e3'
+    description: Further information is requested
+
+  - name: wontfix
+    color: '#ffffff'
+    description: This will not be worked on
+
+branches:
+  - name: main
+    # https://docs.github.com/en/rest/reference/repos#update-branch-protection
+    protection:
+      # Required. Require at least one approving review on a pull request, before merging. Set to null to disable.
+      required_pull_request_reviews:
+        # The number of approvals required. (1-6)
+        required_approving_review_count: 1
+        # Dismiss approved reviews automatically when a new commit is pushed.
+        dismiss_stale_reviews: true
+        # Blocks merge until code owners have reviewed.
+        require_code_owner_reviews: true
+        # Specify which users and teams can dismiss pull request reviews.
+        # Pass an empty dismissal_restrictions object to disable.
+        # User and team dismissal_restrictions are only available for organization-owned repositories.
+        # Omit this parameter for personal repositories.
+        dismissal_restrictions:
+          # users: []
+          # teams: []
+      # Required. Require status checks to pass before merging. Set to null to disable
+      required_status_checks:
+        # Required. Require branches to be up to date before merging.
+        strict: true
+        # Required. The list of status checks to require in order to merge into this branch
+        contexts: []
+      # Required. Enforce all configured restrictions for administrators.
+      # Set to true to enforce required status checks for repository administrators.
+      # Set to null to disable.
+      enforce_admins: true
+      # Prevent merge commits from being pushed to matching branches
+      required_linear_history: true
+      # Required. Restrict who can push to this branch.
+      # Team and user restrictions are only available for organization-owned repositories.
+      # Set to null to disable.
+      restrictions: null

.github/workflows/main.yml

@@ -0,0 +1,36 @@
+name: CI & CD
+on:
+  push:
+    tags:
+      - v*
+jobs:
+  Test-Build-Publish-Deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 10
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org
+          cache: pnpm
+      - name: Install Dependencies
+        run: pnpm i --frozen-lockfile
+
+      - name: Build & Publish
+        run: npm publish --access public --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Deploy document
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          publish_dir: ./docs
+          personal_token: ${{ secrets.GITHUB_TOKEN }}
+          force_orphan: true

.gitignore

@@ -141,3 +141,6 @@ yarn.lock
 # Vite logs files
 vite.config.js.timestamp-*
 vite.config.ts.timestamp-*
+
+# Document generation
+docs/

.husky/pre-commit

@@ -0,0 +1 @@
+npm test

.husky/pre-push

@@ -0,0 +1 @@
+npm run build

.npmignore

@@ -0,0 +1,5 @@
+test/
+docs/
+.husky/
+.github/
+.vscode/

.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug Jest",
+      "type": "node",
+      "request": "launch",
+      "port": 9229,
+      "runtimeArgs": [
+        "--inspect-brk",
+        "${workspaceRoot}/node_modules/jest/bin/jest.js",
+        "--runInBand"
+      ],
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules\\typescript\\lib"
+}

README.md

@@ -1,7 +1,12 @@
-# MobX-RESTful-migrator
+# MobX RESTful migrator
 
 Data Migration framework based on [MobX-RESTful][1]
 
+[![NPM Dependency](https://img.shields.io/librariesio/github/idea2app/MobX-RESTful-migrator.svg)][2]
+[![CI & CD](https://github.com/idea2app/MobX-RESTful-migrator/actions/workflows/main.yml/badge.svg)][3]
+
+[![NPM](https://nodei.co/npm/mobx-restful-migrator.png?downloads=true&downloadRank=true&stars=true)][4]
+
 ## Overview
 
 MobX-RESTful-migrator is a TypeScript library that provides a flexible data migration framework built on top of MobX-RESTful's ListModel abstraction. It allows you to migrate data from various sources through MobX-RESTful models with customizable field mappings and relationships.
@@ -50,7 +55,7 @@ import { buildURLData } from 'web-utility';
 
 export abstract class TableModel<
   D extends DataObject,
-  F extends Filter<D> = Filter<D>
+  F extends Filter<D> = Filter<D>,
 > extends ListModel<D, F> {
   client = new HTTPClient({ baseURI: 'http://localhost:8080', responseType: 'json' });
 
@@ -65,7 +70,7 @@ export abstract class TableModel<
 
   async loadPage(pageIndex: number, pageSize: number, filter: F) {
     const { body } = await this.client.get<{ list: D[]; count: number }>(
-      `${this.baseURI}?${buildURLData({ ...filter, pageIndex, pageSize })}`
+      `${this.baseURI}?${buildURLData({ ...filter, pageIndex, pageSize })}`,
     );
     return { pageData: body!.list, totalCount: body!.count };
   }
@@ -135,7 +140,6 @@ const loadSourceArticles = () => readCSV<SourceArticle>('article.csv');
 
 // Complete migration configuration demonstrating all 4 mapping types
 const mapping: MigrationSchema<SourceArticle, Article> = {
-
   // 1. Many-to-One mapping: Title + Subtitle → combined title
   title: ({ title, subtitle }) => ({
     title: { value: `${title}: ${subtitle}` },
@@ -198,7 +202,7 @@ const migratorWithCustomLogger = new RestMigrator(
   loadSourceArticles,
   ArticleModel,
   mapping,
-  new CustomEventBus()
+  new CustomEventBus(),
 );
 ```
 
@@ -332,3 +336,6 @@ const migrator = new RestMigrator(loadSourceArticles, ArticleModel, mapping, new
 ```
 
 [1]: https://github.com/idea2app/MobX-RESTful
+[2]: https://libraries.io/npm/mobx-restful-migrator
+[3]: https://github.com/idea2app/MobX-RESTful-migrator/actions/workflows/main.yml
+[4]: https://nodei.co/npm/mobx-restful-migrator/