declapract-typescript-ehmpathy 0.49.1 → 0.49.2

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

@@ -2,6 +2,6 @@
   "dependencies": {
     "@aws-sdk/client-account": "@declapract{check.minVersion('3.1042.0')}",
     "@aws-sdk/client-iam": "@declapract{check.minVersion('3.1042.0')}",
-    "sdk-environment": "@declapract{check.minVersion('0.1.4')}"
+    "sdk-environment": "@declapract{check.minVersion('0.1.5')}"
   }
 }

package/dist/practices/logs/bad-practices/simple-log-methods/src/<star><star>/<star>.ts.declapract.ts

@@ -1,15 +1,46 @@
 import type { FileCheckFunction, FileFixFunction } from 'declapract';
 
+/**
+ * .what = migrates simple-log-methods to sdk-logs with commit flow
+ * .why = sdk-logs with commit flow enables traceability in production logs
+ *
+ * .note = declapract semantics:
+ *   - check returns = bad practice detected (file will be flagged)
+ *   - check throws = bad practice not detected (file will be skipped)
+ *   - fix returns {} = no changes needed
+ */
+
 export const check: FileCheckFunction = (contents) => {
+  // detect files that import from simple-log-methods
   if (contents?.includes("from 'simple-log-methods'")) return;
   throw new Error('does not match bad practice');
 };
 
 export const fix: FileFixFunction = (contents) => {
+  // no contents means no file to fix
   if (!contents) return {};
-  return {
-    contents: contents
-      .replace(/from 'simple-log-methods'/g, "from 'sdk-logs'")
-      .replace(/generateLogMethods/g, 'genLogMethods'),
-  };
+
+  // step 1: replace package import and method name
+  const withSdkLogs = contents
+    .replace(/from 'simple-log-methods'/g, "from 'sdk-logs'")
+    .replace(/generateLogMethods/g, 'genLogMethods');
+
+  // step 2: add sdk-environment import if not already present (idempotent)
+  const needsEnvImport = !withSdkLogs.includes("from 'sdk-environment'");
+  const withEnvImport = needsEnvImport
+    ? withSdkLogs.replace(
+        /import { genLogMethods } from 'sdk-logs';/g,
+        "import { getEnvironment } from 'sdk-environment';\nimport { genLogMethods } from 'sdk-logs';",
+      )
+    : withSdkLogs;
+
+  // step 3: flow commit through env (only for no-arg calls)
+  const withCommitFlow = withEnvImport.replace(
+    /genLogMethods\(\)/g,
+    `genLogMethods({
+  env: { commit: getEnvironment.static().commit },
+})`,
+  );
+
+  return { contents: withCommitFlow };
 };

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

@@ -1,5 +1,6 @@
 {
   "dependencies": {
+    "sdk-environment": "@declapract{check.minVersion('0.1.5')}",
     "sdk-logs": "@declapract{check.minVersion('0.9.2')}"
   }
 }

package/dist/practices/logs/best-practice/src/utils/logger.ts

@@ -1,3 +1,6 @@
+import { getEnvironment } from 'sdk-environment';
 import { genLogMethods } from 'sdk-logs';
 
-export const log = genLogMethods();
+export const log = genLogMethods({
+  env: { commit: getEnvironment.static().commit },
+});

package/package.json

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