chore: enable TS declarations, add build step to workflow, update ignores

Author: fabiovincenzi

.github/workflows/sample-publish.yml

@@ -9,22 +9,35 @@ permissions:
   contents: read
 
 jobs:
-  build:
+  build-and-publish:
     runs-on: ubuntu-latest
     steps:
       - name: Harden Runner
         uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
         with:
           egress-policy: audit
 
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
-      # Setup .npmrc file to publish to npm
-      - uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
+      - name: Checkout repo
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+      - name: Setup Node.js # Setup .npmrc file to publish to npm
+        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
         with:
           node-version: '18.x'
           registry-url: 'https://registry.npmjs.org'
-      - name: publish sample package
-        run: npm install --include peer && npm publish --access=public
+
+      - name: Install dependencies
+        working-directory: plugins/git-proxy-plugin-samples
+        run: npm ci
+
+      - name: Build TypeScript
+        working-directory: plugins/git-proxy-plugin-samples
+        run: npm run build
+
+      - name: Install peers and publish
         working-directory: plugins/git-proxy-plugin-samples
+        run: |
+          npm install --include=peer
+          npm publish --access=public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.npmignore

@@ -1,3 +1,12 @@
 # This file required to override .gitignore when publishing to npm
+src/
+tests/
+*.test.ts
+
+tsconfig.json
+jest.config.js
+.eslintrc.js
+.prettierrc
+
 website/
-plugins/
+plugins/

package.json

@@ -2,6 +2,8 @@
   "name": "@finos/git-proxy",
   "version": "1.10.0",
   "description": "Deploy custom push protections and policies on top of Git.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "cli": "node ./packages/git-proxy-cli/index.js",
     "client": "vite --config vite.config.js",

tsconfig.json

@@ -7,13 +7,20 @@
     "jsx": "react-jsx",
     "moduleResolution": "Node",
     "strict": true,
-    "noEmit": true,
     "skipLibCheck": true,
-    "isolatedModules": true,
+    "isolatedModules": false,
     "module": "CommonJS",
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
-    "resolveJsonModule": true
+    "resolveJsonModule": true,
+
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "noEmit": false,
+    "types": ["node"]
   },
-  "include": ["src"]
+  "include": ["src"],
+  "exclude": ["node_modules", "dist", "**/*.test.ts"]
 }