feat(typescript): initial conversion of source code to TS

americanexpress · Nov 13, 2024 · 785fd5e · 785fd5e
1 parent 6fd9e16
commit 785fd5e
Show file tree

Hide file tree

Showing 36 changed files with 4,045 additions and 1,466 deletions.
diff --git a/.babelrc b/.babelrc
@@ -1,3 +1,4 @@
 {
-  "presets": ["amex"]
+  "presets": ["amex"],
+  "plugins": ["@babel/plugin-transform-typescript"]
 }
diff --git a/.eslintignore b/.eslintignore
@@ -1,3 +1,5 @@
 lib
 node_modules
 test-results
+vitest.config.js
+coverage
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,3 +1,50 @@
 {
-  "extends": "amex"
+  "extends": ["amex", "plugin:@typescript-eslint/recommended", "prettier"],
+  "settings": { "import/resolver": { "typescript": {} } },
+  "parserOptions": {
+    "project": true,
+    "extraFileExtensions": [".json"]
+  },
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
+  "overrides": [
+    {
+      "files": ["__tests__/**"],
+      "extends": ["amex/test", "plugin:@typescript-eslint/recommended", "prettier"],
+      "rules": {
+        "import/extensions": [
+          "error",
+          "ignorePackages",
+          {
+            "ts": "never",
+            "tsx": "never",
+            "js": "never",
+            "jsx": "never"
+          }
+        ]
+      }
+    },
+    {
+      "files": ["src/**"],
+      "extends": [
+        "amex",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/strict-type-checked",
+        "prettier"
+      ],
+      "rules": {
+        "import/extensions": [
+          "error",
+          "ignorePackages",
+          {
+            "ts": "never",
+            "tsx": "never",
+            "js": "never",
+            "jsx": "never"
+          }
+        ]
+      }
+    }
+  ],
+  "ignorePatterns": ["types"]
 }
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,28 +1,35 @@
 <!--- Provide a general summary of your changes in the Title above -->
 
 ## Description
+
 <!--- Describe your changes in detail -->
 
 ## Motivation and Context
+
 <!--- Why is this change required? What problem does it solve? -->
 <!--- If it fixes an open issue, please link to the issue here. -->
 
 ## How Has This Been Tested?
+
 <!--- Please describe in detail how you tested your changes. -->
 <!--- Include details of your testing environment, tests ran to see how -->
 <!--- your change affects other areas of the code, etc. -->
 
 ## Types of Changes
+
 <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+
 - [ ] Bug fix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
 - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
 - [ ] Documentation (adding or updating documentation)
 - [ ] Dependency update
 
 ## Checklist:
+
 <!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
 <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+
 - [ ] My change requires a change to the documentation and I have updated the documentation accordingly.
 - [ ] My changes are in sync with the code style of this project.
 - [ ] There aren't any other open Pull Requests for the same issue/update.
@@ -33,4 +40,5 @@
 - [ ] I have added the Apache 2.0 license header to any new files created.
 
 ## What is the Impact to Developers Using vitruvius?
+
 <!--- Please describe how your changes impacts developers using vitruvius. -->
diff --git a/.github/workflows/health-check.yml b/.github/workflows/health-check.yml
@@ -3,29 +3,29 @@ name: Health Check
 on:
   schedule:
     # At minute 0 past hour 0800 and 2000.
-    - cron:  '0 8,20 * * *'
+    - cron: '0 8,20 * * *'
 
 jobs:
   tests:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ '18.x', '20.x' ]
+        node: ['18.x', '20.x']
     name: Node ${{ matrix.node }}
     steps:
-    - uses: actions/checkout@v2
-    - run: |
-        git remote set-branches --add origin main
-        git fetch
-    - name: Setup Node
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node }}
-    - name: Install Dependencies
-      run: npm ci
-      env:
-        NODE_ENV: development
-    - name: Run Test Script
-      run: npm run test
-      env:
-        NODE_ENV: production
+      - uses: actions/checkout@v2
+      - run: |
+          git remote set-branches --add origin main
+          git fetch
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install Dependencies
+        run: npm ci
+        env:
+          NODE_ENV: development
+      - name: Run Test Script
+        run: npm run test
+        env:
+          NODE_ENV: production
diff --git a/.github/workflows/pr-labeler.yml b/.github/workflows/pr-labeler.yml
@@ -1,4 +1,4 @@
-name: "Pull Request Labeler"
+name: 'Pull Request Labeler'
 on:
   pull_request_target:
     types: [opened, reopened]
@@ -7,6 +7,6 @@ jobs:
   triage:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/labeler@v3
-      with:
-        repo-token: "${{ secrets.GITHUB_TOKEN }}"
+      - uses: actions/labeler@v3
+        with:
+          repo-token: '${{ secrets.GITHUB_TOKEN }}'
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
@@ -32,4 +32,4 @@ jobs:
       - run: npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
-        if: ${{ steps.release.outputs.release_created }}
+        if: ${{ steps.release.outputs.release_created }}
diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
@@ -2,22 +2,21 @@ name: Mark stale issues and pull requests
 
 on:
   schedule:
-  - cron: "0 0 * * *"
+    - cron: '0 0 * * *'
 
 jobs:
   stale:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/stale@v3
-      with:
-        repo-token: ${{ secrets.GITHUB_TOKEN }}
-        stale-issue-message: 'This issue is stale because it has been open 30 days with no activity.'
-        stale-pr-message: 'This pull request is stale because it has been open 30 days with no activity.'
-        stale-issue-label: 'stale-issue'
-        exempt-issue-labels: 'enhancement,documentation,good-first-issue,question'
-        stale-pr-label: 'stale-pr'
-        exempt-pr-labels: 'work-in-progress'
-        days-before-stale: 30
-        days-before-close: -1
+      - uses: actions/stale@v3
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          stale-issue-message: 'This issue is stale because it has been open 30 days with no activity.'
+          stale-pr-message: 'This pull request is stale because it has been open 30 days with no activity.'
+          stale-issue-label: 'stale-issue'
+          exempt-issue-labels: 'enhancement,documentation,good-first-issue,question'
+          stale-pr-label: 'stale-pr'
+          exempt-pr-labels: 'work-in-progress'
+          days-before-stale: 30
+          days-before-close: -1
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -10,34 +10,34 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ '18.x', '20.x']
+        node: ['18.x', '20.x']
     name: Node ${{ matrix.node }}
     steps:
-    - uses: actions/checkout@v2
-    - run: |
-        git remote set-branches --add origin main
-        git fetch
-    - name: Setup Node
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node }}
-    - name: Install Dependencies
-      run: npm ci
-      env:
-        NODE_ENV: development
-    - name: Unit Tests
-      run: npm run test:unit
-      env:
-        NODE_ENV: production
-    - name: Git History Test
-      run: npm run test:git-history
-      env:
-        NODE_ENV: production
-    - name: Lockfile Lint Test
-      run: npm run test:lockfile
-      env:
-        NODE_ENV: production
-    - name: Lint
-      run: npm run test:lint
-      env:
-        NODE_ENV: production
+      - uses: actions/checkout@v2
+      - run: |
+          git remote set-branches --add origin main
+          git fetch
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install Dependencies
+        run: npm ci
+        env:
+          NODE_ENV: development
+      - name: Unit Tests
+        run: npm run test:unit
+        env:
+          NODE_ENV: production
+      - name: Git History Test
+        run: npm run test:git-history
+        env:
+          NODE_ENV: production
+      - name: Lockfile Lint Test
+        run: npm run test:lockfile
+        env:
+          NODE_ENV: production
+      - name: Lint
+        run: npm run test:lint
+        env:
+          NODE_ENV: production
diff --git a/.gitignore b/.gitignore
@@ -1,8 +1,11 @@
 test-results
-.jest-cache
+coverage
 node_modules
 lib
 *.log
 *.swp
 *.tgz
+types
 
+.idea
+.vscode
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,4 @@
+/types
+/lib
+/test-results
+coverage
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,23 +2,20 @@
 
 ## [3.0.1](https://github.com/americanexpress/vitruvius/compare/v3.0.0...v3.0.1) (2024-02-07)
 
-
 ### Bug Fixes
 
-* **release-please:** use npmrc and set registry ([#52](https://github.com/americanexpress/vitruvius/issues/52)) ([2d881d3](https://github.com/americanexpress/vitruvius/commit/2d881d353bb382ed3623703804165f9fa4c09159))
+- **release-please:** use npmrc and set registry ([#52](https://github.com/americanexpress/vitruvius/issues/52)) ([2d881d3](https://github.com/americanexpress/vitruvius/commit/2d881d353bb382ed3623703804165f9fa4c09159))
 
 ## [3.0.0](https://github.com/americanexpress/vitruvius/compare/v2.0.1...v3.0.0) (2024-02-06)
 
-
 ### ⚠ BREAKING CHANGES
 
-* **node:** drops support for node versions <18.x
+- **node:** drops support for node versions <18.x
 
 ### Features
 
-* **redux:** redux 5 compatible ([#47](https://github.com/americanexpress/vitruvius/issues/47)) ([e23b819](https://github.com/americanexpress/vitruvius/commit/e23b81951d494cfc15fcb39efa63ec4f25a1d0ad))
-
+- **redux:** redux 5 compatible ([#47](https://github.com/americanexpress/vitruvius/issues/47)) ([e23b819](https://github.com/americanexpress/vitruvius/commit/e23b81951d494cfc15fcb39efa63ec4f25a1d0ad))
 
 ### Miscellaneous Chores
 
-* **node:** drops support for node versions &lt;18.x ([0d9708d](https://github.com/americanexpress/vitruvius/commit/0d9708dd701ee3cac29ce9540cae125f3e64bd77))
+- **node:** drops support for node versions &lt;18.x ([0d9708d](https://github.com/americanexpress/vitruvius/commit/0d9708dd701ee3cac29ce9540cae125f3e64bd77))