declapract-typescript-ehmpathy 0.43.4 → 0.43.6

package/dist/practices/cicd-app-react-native-expo/best-practice/.github/workflows/.deploy-expo.yml

@@ -5,15 +5,15 @@ on:
     inputs:
       stage:
         type: string
-        description: 'the stage of infrastructure to deploy against (e.g., prod, dev)'
+        description: "the stage of infrastructure to deploy against (e.g., prod, dev)"
         required: true
       build:
         type: string
-        description: 'the build to deploy (e.g., production, preview, development)'
+        description: "the build to deploy (e.g., production, preview, development)"
         required: true
       github-environment:
         type: string
-        description: 'the github environment that the apply step will be executed in'
+        description: "the github environment that the apply step will be executed in"
         required: true
       aws-region:
         type: string
@@ -59,12 +59,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set node-version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version-file: '.nvmrc'
+          node-version-file: ".nvmrc"
 
       - name: configure aws credentials
         uses: aws-actions/configure-aws-credentials@v1
@@ -109,12 +109,12 @@ jobs:
     if: ${{ inputs.stage == 'prod' && inputs.app-web-deployment-s3-bucket }}
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set node-version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version-file: '.nvmrc'
+          node-version-file: ".nvmrc"
 
       - name: configure aws credentials
         uses: aws-actions/configure-aws-credentials@v1

package/dist/practices/cicd-common/best-practice/.github/workflows/.declastruct.yml

@@ -30,10 +30,10 @@ jobs:
       has-changes-planned: ${{ steps.evaluate-plan.outputs.has-changes-planned }}
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set node-version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
 
@@ -80,10 +80,10 @@ jobs:
     if: ${{ inputs.allow-apply == true && needs.plan.outputs.has-changes-planned == 'true' }}
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set node-version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
 

package/dist/practices/cicd-common/best-practice/.github/workflows/.install.yml

@@ -14,7 +14,7 @@ jobs:
       node-modules-cache-key: ${{ steps.cache.outputs.cache-primary-key }}
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: node-modules deps hash
         id: deps-hash
@@ -33,7 +33,7 @@ jobs:
 
       - name: node-modules cache miss setup node
         if: steps.cache.outputs.cache-hit != 'true'
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
 

package/dist/practices/cicd-common/best-practice/.github/workflows/.test.yml

@@ -29,12 +29,12 @@ jobs:
     needs: [install]
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0 # we need all commits to test:commits
 
       - name: set node-version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
 
@@ -52,10 +52,10 @@ jobs:
     needs: [install]
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set node-version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
 
@@ -73,10 +73,10 @@ jobs:
     needs: [install]
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set node version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
 
@@ -97,10 +97,10 @@ jobs:
     needs: [install]
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set node-version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
 
@@ -118,10 +118,10 @@ jobs:
     needs: [install]
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set node-version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
 
@@ -139,10 +139,10 @@ jobs:
     needs: [install]
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set node-version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
 
@@ -182,10 +182,10 @@ jobs:
     needs: [install]
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set node-version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
 

package/dist/practices/cicd-package/best-practice/.github/workflows/.publish-npm.yml

@@ -16,13 +16,13 @@ jobs:
     needs: [install]
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set node-version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          registry-url: 'https://registry.npmjs.org/'
-          node-version-file: '.nvmrc'
+          registry-url: "https://registry.npmjs.org/" # required to publish
+          node-version-file: ".nvmrc"
 
       - name: node-modules cache get
         uses: actions/cache/restore@v4
@@ -31,10 +31,6 @@ jobs:
           path: ./node_modules
           key: ${{ needs.install.outputs.node-modules-cache-key }}
 
-      - name: node-modules cache miss install
-        if: steps.cache.outputs.cache-hit != 'true'
-        run: npm ci --ignore-scripts --prefer-offline --no-audit
-
       - name: build
         run: npm run build
 

package/dist/practices/cicd-service/best-practice/.github/workflows/.deploy-sls.yml

@@ -44,10 +44,10 @@ jobs:
     needs: [install]
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set node-version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
 
@@ -80,10 +80,10 @@ jobs:
     needs: [install, deploy]
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set node-version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
 
@@ -129,10 +129,10 @@ jobs:
     needs: [install, deploy]
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set node-version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
 

package/dist/practices/cicd-service/best-practice/.github/workflows/.sql-schema-control.yml

@@ -39,10 +39,10 @@ jobs:
       has-changes-planned: ${{ steps.evaluate-plan.outputs.has-changes-planned }}
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set node-version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
 
@@ -101,10 +101,10 @@ jobs:
     if: ${{ inputs.allow-apply == true && needs.plan.outputs.has-changes-planned == 'true' }}
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set node-version
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
 

package/dist/practices/cicd-service/best-practice/.github/workflows/.terraform.yml

@@ -40,7 +40,7 @@ jobs:
       has-changes-planned: ${{ steps.evaluate-plan.outputs.has-changes-planned }}
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: configure aws credentials
         uses: aws-actions/configure-aws-credentials@v1
@@ -94,7 +94,7 @@ jobs:
         working-directory: ${{ inputs.working-directory }}
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: configure aws credentials
         uses: aws-actions/configure-aws-credentials@v1

package/dist/practices/conventional-commits/bad-practices/commitlint/package.json

@@ -0,0 +1,5 @@
+{
+  "devDependencies": {
+    "commitlint": "@declapract{check.minVersion('0.0.0')}"
+  }
+}

package/dist/practices/conventional-commits/bad-practices/commitlint/package.json.declapract.ts

@@ -0,0 +1,19 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { FileCheckType, type FileFixFunction } from 'declapract';
+
+export const check = FileCheckType.CONTAINS;
+
+export const fix: FileFixFunction = (contents) => {
+  if (!contents) return { contents }; // do nothing if no contents
+  const packageJSON = JSON.parse(contents);
+  const updatedPackageJSON = {
+    ...packageJSON,
+    devDependencies: {
+      ...packageJSON.devDependencies,
+      commitlint: undefined,
+    },
+  };
+  return {
+    contents: JSON.stringify(updatedPackageJSON, null, 2),
+  };
+};

package/dist/practices/conventional-commits/best-practice/.husky/check.commit.sh

@@ -1 +1,7 @@
-npx --no-install commitlint --edit "$1"
+#!/bin/bash
+
+if command -v node > /dev/null 2>&1 && [ -x ./node_modules/.bin/commitlint ]; then
+    ./node_modules/.bin/commitlint --edit "$1"
+else
+    echo "🟡 commitlint not available, wont check commit message"
+fi

package/dist/practices/conventional-commits/best-practice/package.json

@@ -4,8 +4,8 @@
     "test:commits": "LAST_TAG=$(git describe --tags --abbrev=0 @^ 2> /dev/null || git rev-list --max-parents=0 HEAD) && npx commitlint --from $LAST_TAG --to HEAD --verbose"
   },
   "devDependencies": {
-    "@commitlint/cli": "@declapract{check.minVersion('19.3.0')}",
-    "@commitlint/config-conventional": "@declapract{check.minVersion('13.1.0')}",
+    "@commitlint/cli": "@declapract{check.minVersion('19.5.0')}",
+    "@commitlint/config-conventional": "@declapract{check.minVersion('19.5.0')}",
     "cz-conventional-changelog": "@declapract{check.minVersion('3.3.0')}",
     "husky": "@declapract{check.minVersion('7.0.2')}"
   },

package/dist/practices/husky/best-practice/.husky/check.yalc.sh

@@ -1,7 +1,9 @@
 #!/bin/bash
 
 # https://github.com/wclr/yalc
-if [ "$(npx yalc check)" ]; then
-    echo "✋ package.json has yalc references. Run 'npx yalc remove --all' to remove these local testing references."
+if command -v npx &> /dev/null; then
+    if [ "$(npx yalc check 2>/dev/null)" ]; then
+        echo "✋ package.json has yalc references. Run 'npx yalc remove --all' to remove these local testing references."
+    fi
 fi
 

package/dist/practices/lint/best-practice/package.json

@@ -7,8 +7,8 @@
     "fix:format:biome": "biome check --write src",
     "fix:lint": "biome check --write src",
     "test:format:biome": "biome format src",
-    "test:lint:biome": "biome check src",
-    "test:lint:errors": "biome check src --diagnostic-level=error",
+    "test:lint:biome": "biome check src --diagnostic-level=error",
+    "test:lint:biome:all": "biome check src",
     "test:lint:deps": "npx depcheck -c ./.depcheckrc.yml",
     "test:lint": "npm run test:lint:biome && npm run test:lint:deps"
   }

package/dist/practices/package-json-order/best-practice/package.json.declapract.ts

@@ -57,7 +57,7 @@ export const desiredRelativeKeyOrder = {
     'test:format',
     'test:lint:deps',
     'test:lint:biome',
-    'test:lint:errors',
+    'test:lint:biome:all',
     'test:lint:eslint',
     'test:lint',
     'test:unit',

package/dist/practices/tests/best-practice/jest.integration.env.ts

@@ -1,3 +1,4 @@
+import { execSync } from 'child_process';
 import { existsSync, readFileSync } from 'fs';
 import { join } from 'path';
 import util from 'util';
@@ -36,9 +37,10 @@ if (
  *   - prevent time wasted debugging tests which are failing due to hard-to-read missed credential errors
  */
 const declapractUsePath = join(process.cwd(), 'declapract.use.yml');
-const requiresAwsAuth =
-  existsSync(declapractUsePath) &&
-  readFileSync(declapractUsePath, 'utf8').includes('awsAccountId');
+const declapractUseContent = existsSync(declapractUsePath)
+  ? readFileSync(declapractUsePath, 'utf8')
+  : '';
+const requiresAwsAuth = declapractUseContent.includes('awsAccountId');
 if (
   requiresAwsAuth &&
   !(process.env.AWS_PROFILE || process.env.AWS_ACCESS_KEY_ID)
@@ -46,3 +48,37 @@ if (
   throw new Error(
     'no aws credentials present. please authenticate with aws to run integration tests',
   );
+
+/**
+ * .what = verify that the testdb has been provisioned if a databaseUserName is declared
+ * .why =
+ *   - prevent time wasted waiting on tests to fail due to missing testdb
+ *   - prevent confusing "password authentication failed" errors when testdb isn't running or was provisioned for a different repo
+ */
+const requiresTestDb = declapractUseContent.includes('databaseUserName');
+if (requiresTestDb) {
+  const testConfigPath = join(process.cwd(), 'config', 'test.json');
+  if (!existsSync(testConfigPath))
+    throw new Error(
+      'config/test.json not found but serviceUser is declared in declapract.use.yml',
+    );
+  const testConfig = JSON.parse(readFileSync(testConfigPath, 'utf8'));
+  if (
+    !testConfig.database?.tunnel?.local ||
+    !testConfig.database?.role?.crud ||
+    !testConfig.database?.target?.database
+  )
+    throw new Error(
+      'config/test.json database.tunnel.local, database?.role?.crud, or database?.target?.database not found but expected',
+    );
+  try {
+    execSync(
+      `PGPASSWORD="${testConfig.database.role.crud.password}" psql -h ${testConfig.database.tunnel.local.host} -p ${testConfig.database.tunnel.local.port} -U ${testConfig.database.role.crud.username} -d ${testConfig.database.target.database} -c "SELECT 1" > /dev/null 2>&1`,
+      { timeout: 3000 },
+    );
+  } catch {
+    throw new Error(
+      `did you forget to \`npm run start:testdb\`? cant connect to database`,
+    );
+  }
+}

package/package.json

@@ -2,7 +2,7 @@
   "name": "declapract-typescript-ehmpathy",
   "author": "ehmpathy",
   "description": "declapract best practices declarations for typescript",
-  "version": "0.43.4",
+  "version": "0.43.6",
   "license": "MIT",
   "main": "src/index.js",
   "repository": "ehmpathy/declapract-typescript-ehmpathy",