declapract-typescript-ehmpathy 0.47.7 → 0.47.9

package/dist/practices/conventional-commits/best-practice/commitlint.config.js

@@ -9,9 +9,10 @@ module.exports = {
         'break', // use break: instead of feat!: or BREAKING CHANGE footer
         'feat',
         'fix',
-        'docs',
+        // 'docs', // prefer fix(docs): instead of docs
         'chore',
         'revert',
+        'cont', // continue progress within a p
       ],
     ],
     // forbid ! prefix (use break: instead)

package/dist/practices/tests/best-practice/.agent/repo=.this/role=any/skills/use.apikeys.json

@@ -0,0 +1,5 @@
+{
+  "apikeys": {
+    "required": []
+  }
+}

package/dist/practices/tests/best-practice/.agent/repo=.this/role=any/skills/use.apikeys.json.declapract.ts

@@ -0,0 +1,4 @@
+import { FileCheckType } from 'declapract';
+
+// check that the file exists; contents are user-defined
+export const check = FileCheckType.EXISTS;

package/dist/practices/tests/best-practice/.agent/repo=.this/role=any/skills/use.apikeys.sh

@@ -0,0 +1,59 @@
+#!/usr/bin/env bash
+######################################################################
+# .what = export api keys for integration tests
+# .why = enables running integration tests that require api keys
+#
+# usage:
+#   source .agent/repo=.this/role=any/skills/use.apikeys.sh
+#
+# note:
+#   - must be called with `source` to export vars to current shell
+#   - loads from ~/.config/rhachet/apikeys.env if available
+#   - falls back to .env.local (gitignored) in repo root
+######################################################################
+
+# fail if not sourced
+if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+  echo "error: this script must be sourced, not executed"
+  echo "usage: source ${BASH_SOURCE[0]}"
+  exit 1
+fi
+
+# try loading from user config first
+if [[ -f ~/.config/rhachet/apikeys.env ]]; then
+  source ~/.config/rhachet/apikeys.env
+  echo "✓ loaded api keys from ~/.config/rhachet/apikeys.env"
+
+# fallback to local gitignored file
+elif [[ -f .env.local ]]; then
+  source .env.local
+  echo "✓ loaded api keys from .env.local"
+
+else
+  echo "⚠ no api keys file found"
+  echo ""
+  echo "create one of:"
+  echo "  ~/.config/rhachet/apikeys.env"
+  echo "  .env.local (in repo root)"
+  echo ""
+  echo "with contents like:"
+  echo "  export OPENAI_API_KEY=sk-..."
+  echo "  export ANTHROPIC_API_KEY=sk-..."
+  return 1
+fi
+
+# read required keys from json config if present
+APIKEYS_CONFIG=".agent/repo=.this/role=any/skills/use.apikeys.json"
+if [[ -f "$APIKEYS_CONFIG" ]]; then
+  # extract required keys using jq
+  REQUIRED_KEYS=$(jq -r '.apikeys.required[]?' "$APIKEYS_CONFIG" 2>/dev/null)
+
+  # verify each required key is set
+  for KEY in $REQUIRED_KEYS; do
+    if [[ -z "${!KEY}" ]]; then
+      echo "⚠ $KEY not set (required by $APIKEYS_CONFIG)"
+      return 1
+    fi
+    echo "✓ $KEY set"
+  done
+fi

package/dist/practices/tests/best-practice/.agent/repo=.this/role=any/skills/use.apikeys.sh.declapract.ts

@@ -0,0 +1,4 @@
+import { FileCheckType } from 'declapract';
+
+// check that the file contains the core structure
+export const check = FileCheckType.CONTAINS;

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

@@ -32,3 +32,38 @@ if (
   throw new Error(
     'no aws credentials present. please authenticate with aws to run acceptance tests',
   );
+
+/**
+ * .what = verify that required api keys are present; otherwise, fail fast
+ * .why =
+ *   - prevent time wasted waiting on tests to fail due to missing api keys
+ *   - prevent agents from giving up when they have access to credentials
+ */
+const apikeysConfigPath = join(
+  process.cwd(),
+  '.agent/repo=.this/role=any/skills/use.apikeys.json',
+);
+if (existsSync(apikeysConfigPath)) {
+  // direct import via require (json resolves automatically)
+  const config = require(apikeysConfigPath);
+  const requiredKeys: string[] = config?.apikeys?.required ?? [];
+  const keysAbsent = requiredKeys.filter((key) => !process.env[key]);
+
+  if (keysAbsent.length > 0) {
+    throw new Error(`
+⛈️  apikeys required to run these acceptance tests were not supplied.
+
+   absent keys: ${keysAbsent.join(', ')}
+
+   you have access to these keys - you just forgot to source them.
+
+   run:
+     source .agent/repo=.this/role=any/skills/use.apikeys.sh && npm run test:acceptance
+
+   you must run these tests with these api keys.
+   you're forbidden to give up.
+   if you don't have privs to run use.apikeys.sh, ask a human for support.
+   chances are, you already have privs to do so though.
+`);
+  }
+}

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

@@ -82,3 +82,38 @@ if (requiresTestDb) {
     );
   }
 }
+
+/**
+ * .what = verify that required api keys are present; otherwise, fail fast
+ * .why =
+ *   - prevent time wasted waiting on tests to fail due to missing api keys
+ *   - prevent agents from giving up when they have access to credentials
+ */
+const apikeysConfigPath = join(
+  process.cwd(),
+  '.agent/repo=.this/role=any/skills/use.apikeys.json',
+);
+if (existsSync(apikeysConfigPath)) {
+  // direct import via require (json resolves automatically)
+  const config = require(apikeysConfigPath);
+  const requiredKeys: string[] = config?.apikeys?.required ?? [];
+  const keysAbsent = requiredKeys.filter((key) => !process.env[key]);
+
+  if (keysAbsent.length > 0) {
+    throw new Error(`
+⛈️  apikeys required to run these integration tests were not supplied.
+
+   absent keys: ${keysAbsent.join(', ')}
+
+   you have access to these keys - you just forgot to source them.
+
+   run:
+     source .agent/repo=.this/role=any/skills/use.apikeys.sh && npm run test:integration
+
+   you must run these tests with these api keys.
+   you're forbidden to give up.
+   if you don't have privs to run use.apikeys.sh, ask a human for support.
+   chances are, you already have privs to do so though.
+`);
+  }
+}

package/dist/practices/typescript/best-practice/tsconfig.json

@@ -6,6 +6,7 @@
   "compilerOptions": {
     "baseUrl": ".",
     "paths": {
+      "@/*": ["*"],
       "@src/*": ["src/*"]
     },
     "importsNotUsedAsValues": "remove",

package/package.json

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