Dev - updated documentation and added samples

Author: aritraop

.github/dependabot.yml

@@ -5,7 +5,7 @@ updates:
   schedule:
     interval: daily
     time: "10:00"
-    timezone: Europe/Budapest
+    timezone: Asia/Kolkata
   open-pull-requests-limit: 5
   versioning-strategy: increase
   commit-message:

.github/workflows/auto-approve-dependabot-workflow.yml

@@ -1,23 +1,24 @@
-name: Dependabot auto-merge
-on:
-  pull_request_target
-jobs:
-  dependabot:
-    runs-on: ubuntu-latest
-    if: github.actor == 'dependabot[bot]'
-    steps:
-    - name: 'Auto approve PR by Dependabot'
-      uses: hmarr/[email protected]
-      with:
-        github-token: "${{ secrets.TYPESTACK_BOT_TOKEN }}"
-    - name: 'Comment merge command'
-      uses: actions/github-script@v3
-      with:
-        github-token: ${{secrets.TYPESTACK_BOT_TOKEN }}
-        script: |
-          await github.issues.createComment({
-            owner: context.repo.owner,
-            repo: context.repo.repo,
-            issue_number: context.issue.number,
-            body: '@dependabot squash and merge'
-          })
+# Basically I don't understand this as of now, therefore not using it, but you are welcome to contribute on this part. 
+# name: Dependabot auto-merge
+# on:
+#   pull_request_target
+# jobs:
+#   dependabot:
+#     runs-on: ubuntu-latest
+#     if: github.actor == 'dependabot[bot]'
+#     steps:
+#     - name: 'Auto approve PR by Dependabot'
+#       uses: hmarr/[email protected]
+#       with:
+#         github-token: "${{ secrets.TYPESTACK_BOT_TOKEN }}"
+#     - name: 'Comment merge command'
+#       uses: actions/github-script@v3
+#       with:
+#         github-token: ${{secrets.TYPESTACK_BOT_TOKEN }}
+#         script: |
+#           await github.issues.createComment({
+#             owner: context.repo.owner,
+#             repo: context.repo.repo,
+#             issue_number: context.issue.number,
+#             body: '@dependabot squash and merge'
+#           })

.github/workflows/continuous-integration-workflow.yml

@@ -27,10 +27,10 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - run: npm ci --ignore-scripts
       - run: npm run test:ci
-      - run: npm install codecov -g
-        if: ${{ matrix.node-version == 'current' }}
-      - run: codecov -f ./coverage/clover.xml -t ${{ secrets.CODECOV_TOKEN }} --commit=$GITHUB_SHA --branch=${GITHUB_REF##*/}
-        if: ${{ matrix.node-version == 'current' }}
+      # - run: npm install codecov -g
+      #   if: ${{ matrix.node-version == 'current' }}
+      # - run: codecov -f ./coverage/clover.xml -t ${{ secrets.CODECOV_TOKEN }} --commit=$GITHUB_SHA --branch=${GITHUB_REF##*/}
+      #   if: ${{ matrix.node-version == 'current' }}
   build:
     name: Build
     runs-on: ubuntu-latest

.github/workflows/lock-closed-issues-workflow.yml

@@ -1,22 +1,23 @@
-name: 'Lock inactive threads'
-on:
-  schedule:
-    - cron: '0 0 * * *'
-jobs:
-  lock:
-    name: Lock closed issues
-    runs-on: ubuntu-latest
-    steps:
-      - uses: dessant/lock-threads@v2
-        with:
-          github-token: ${{ github.token }}
-          issue-lock-inactive-days: 30
-          pr-lock-inactive-days: 30
-          issue-lock-comment: >
-            This issue has been automatically locked since there
-            has not been any recent activity after it was closed.
-            Please open a new issue for related bugs.
-          pr-lock-comment: >
-            This pull request has been automatically locked since there
-            has not been any recent activity after it was closed.
-            Please open a new issue for related bugs.
+# Basically I don't understand this as of now, therefore not using it, but you are welcome to contribute on this part. 
+# name: 'Lock inactive threads'
+# on:
+#   schedule:
+#     - cron: '0 0 * * *'
+# jobs:
+#   lock:
+#     name: Lock closed issues
+#     runs-on: ubuntu-latest
+#     steps:
+#       - uses: dessant/lock-threads@v2
+#         with:
+#           github-token: ${{ github.token }}
+#           issue-lock-inactive-days: 30
+#           pr-lock-inactive-days: 30
+#           issue-lock-comment: >
+#             This issue has been automatically locked since there
+#             has not been any recent activity after it was closed.
+#             Please open a new issue for related bugs.
+#           pr-lock-comment: >
+#             This pull request has been automatically locked since there
+#             has not been any recent activity after it was closed.
+#             Please open a new issue for related bugs.

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
 _This changelog follows the [keep a changelog][keep-a-changelog]_ format to maintain a human readable changelog.
+### [0.0.1](https://github.com/arizworld/class-validator-custom-errors/pull/1/) (2024-03-21)
+
+### Added
+- added `transformFunction` in validatorOptions to customize the message for each time of validation.
+- added `transformKey` in validationOptions to pass specific keys to transformFunction for 
+specific properties.
 
 ### [0.14.0](https://github.com/typestack/class-validator/compare/v0.13.2...v0.14.0) (2022-12-09)
 

LICENSE

@@ -1,7 +1,7 @@
 
 The MIT License
 
-Copyright (c) 2015-2020 TypeStack
+Copyright (c) 2024-2024 Aritra Sadhukhan
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,4 +19,9 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.
+
+---
+
+Modifications:
+- Added the ability to customize the error messages.