fix(tsconfig): updating how helpers are handled (#50)

* fix(tsconfig): updating how helpers are handled

* chore(update): cleaning up package

* fix(ci): cleaning up github ci

.github/workflows/publish.yml

@@ -1,35 +1,45 @@
-name: Node.js Package
-
+name: Build
+ 
 on:
-  pull_request:
-    branches:
-      - main
-  push:
-    branches:
-      - main
-
+    push:
+      branches: ["main"]  
+    pull_request:
+      branches: ["main"]  
 jobs:
-  validator:
+  ##
+  # Runs semantic release in a regular
+  ##
+  release:
+    name: Semantic Release
+    timeout-minutes: 15
     runs-on: ubuntu-latest
+
+    # https://github.com/semantic-release/npm
+    permissions:
+        contents: write # to be able to publish a GitHub release
+        issues: write # to be able to comment on released issues
+        pull-requests: write # to be able to comment on released pull requests
+        id-token: write # to enable use of OIDC for npm provenance
+
     steps:
-      - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3
-      - uses: RoadieHQ/backstage-entity-validator@70da3dfb77cb4d0e150b9f6de953b806837d16df # tag=v0.3.2
+      - name: Check out code
+        uses: actions/checkout@v4
         with:
-          path: 'catalog-info.yaml'
+          fetch-depth: 2
 
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3
-      - uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048 # tag=v3.2.0
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
         with:
-          node-version: '16.x'
+          node-version: 20
           registry-url: 'https://registry.npmjs.org'
-          scope: '@pocket-tools'
-      - run: npm ci
+      - run: npm install -g npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
+        run: npm audit signatures
       - name: Semantic Release
-        uses: cycjimmy/semantic-release-action@v2
+        run: npm run release 
         env:
-          GITHUB_TOKEN: ${{ secrets.CI_GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+            NPM_CONFIG_PROVENANCE: true

.github/workflows/validate.yml

@@ -0,0 +1,14 @@
+name: Build
+
+on:
+    pull_request:
+      branches: ["main"]  
+
+jobs:
+  backstage_validator:
+      runs-on: ubuntu-latest
+      steps:
+       - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3
+       - uses: RoadieHQ/[email protected]
+         with:
+           path: 'catalog-info.yaml'

.nvmrc

@@ -1 +1 @@
-16
+20

README.md

@@ -12,12 +12,12 @@ This setups up your Typescript tslint settings based on best practices. Check th
 
 ```
 npm i -D @pocket-tools/tsconfig # or yarn install --dev @pocket-tools/tsconfig
-npx install-peerdeps --dev @pocket-tools/tsconfig
 ```
 
 2. You will see several dependencies were installed. Now, create (or update) a `tsconfig.json` file with the following content:
 
 If you don't already have one the NPM post install script will create it for you.
+
 ```json
 {
   "extends": "@pocket-tools/tsconfig",
@@ -36,4 +36,4 @@ If you don't already have one the NPM post install script will create it for you
 }
 ```
 
-Concepts are used from https://github.com/Chatie/tsconfig
+Concepts are used from <https://github.com/Chatie/tsconfig>

bin/install.js

@@ -3,7 +3,7 @@
 import fs from 'fs';
 import path from 'path';
 
-import { pkgUp } from 'pkg-up';
+import { packageUp } from 'package-up';
 
 import { fileURLToPath } from 'url';
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -27,7 +27,7 @@ const TSCONFIG_JSON_CONTENT = `{
 
 async function main() {
   const cwd = path.join(__dirname, '..', '..');
-  const pkg = await pkgUp({ cwd });
+  const pkg = await packageUp({ cwd });
   if (!pkg) {
     return 0;
   }