cdk-insights 0.2.0-beta.8 → 0.3.0

package/README.md

@@ -49,9 +49,9 @@ npx cdk-insights scan
 
 **That's it!** CDK Insights will analyze your infrastructure and show you what needs attention.
 
-### Adding NPM Scripts for Convenience
+### Adding NPM Scripts for Convenience (Recommended)
 
-You can add convenience scripts to your `package.json` to make commands shorter:
+**We recommend adding these scripts to your `package.json`** for shorter, more convenient commands:
 
 ```json
 {
@@ -66,7 +66,7 @@ You can add convenience scripts to your `package.json` to make commands shorter:
 }
 ```
 
-Then you can run:
+After adding these scripts, you can use shorter commands:
 
 ```bash
 npm run scan           # Interactive scan
@@ -77,6 +77,8 @@ npm run scan:summary   # Scan with summary output
 npm run scan:with-issues # Scan and create GitHub issues
 ```
 
+> **💡 Why add scripts?** While `npx cdk-insights scan` works great, adding scripts makes commands shorter and more memorable. It's also the standard way most npm tools are used in projects.
+
 ## ✨ What CDK Insights Does
 
 - **🔍 Static Analysis**: Automatically checks your CDK code for 20+ AWS services
@@ -103,7 +105,7 @@ npx cdk-insights scan --all
 npx cdk-insights scan
 ```
 
-> **💡 Tip**: After installing CDK Insights, you can use `npx cdk-insights <command>` for all commands. You can also add convenience scripts to your `package.json` (see section above).
+> **💡 Tip**: After installing CDK Insights, you can use `npx cdk-insights <command>` for all commands. For convenience, we recommend adding scripts to your `package.json` (see section above) so you can use shorter commands like `npm run scan`.
 
 ### What You'll See
 
@@ -141,14 +143,16 @@ npx cdk-insights scan
 
 ```bash
 # Focus on critical security issues
-cdk-insights scan --rule-filter Security --output table
+npx cdk-insights scan --rule-filter Security --output table
+# Or if you added scripts: npm run scan
 ```
 
 **2. Generate a Report for Your Team**
 
 ```bash
 # Create a markdown report for documentation
-cdk-insights scan --output markdown > security-report.md
+npx cdk-insights scan --output markdown > security-report.md
+# Or if you added scripts: npm run scan:markdown > security-report.md
 ```
 
 **3. Set Up Regular Checks**
@@ -713,4 +717,6 @@ CDK Insights is licensed under the MIT License. Some functionality integrates wi
 
 ---
 
-**Ready to improve your CDK infrastructure?** Start with `npx cdk-insights scan` and discover what insights await! 🚀
+**Ready to improve your CDK infrastructure?** Start with `npx cdk-insights scan` and discover what insights await!
+
+> 💡 **Pro tip**: Add the convenience scripts to your `package.json` (see above) for shorter commands like `npm run scan` 🚀

package/dist/cli/entry.js

@@ -83185,68 +83185,71 @@ var isGeneratedByCDK = (cdkPath, constructType) => {
 };
 var enrichRecommendations = (originalMap, pathToLogicalId, unifiedResourceMap, stack, resourceIdMetadata) => {
   const manifest = loadManifest("cdk.out");
-  return Object.entries(originalMap).reduce((acc, [resourceId, group]) => {
-    const cdkPath = Object.keys(pathToLogicalId).find(
-      (p3) => pathToLogicalId[p3] === resourceId
-    ) ?? group.cdkPath;
-    const constructType = unifiedResourceMap[resourceId]?.__constructType ?? stack.Resources[resourceId]?.Type ?? "";
-    const githubUrl = resourceIdMetadata[resourceId]?.githubUrl;
-    const docUrl = resourceIdMetadata[resourceId]?.docUrl;
-    const constructName = resourceIdMetadata[resourceId]?.constructName;
-    const isGenerated = isGeneratedByCDK(cdkPath, constructType);
-    const displayName = unifiedResourceMap[resourceId]?.displayName;
-    const friendlyName = displayName ?? unifiedResourceMap[resourceId]?.__friendlyName ?? cdkPath.split("/").pop() ?? resourceId;
-    const locationHint = displayName ?? cdkPath ?? group.locationHint;
-    const enhancedFileHint = findEnhancedFileFromPath(manifest, resourceId);
-    const allIssues = [
-      ...group.sources.cdkInsights.issues,
-      ...group.sources.cdkNag.issues
-    ].map((issue) => ({
-      ...issue,
-      locationHint,
-      githubUrl,
-      docUrl,
-      constructName,
-      // Add source location if available
-      ...enhancedFileHint?.filePath && {
-        sourceLocation: {
-          filePath: enhancedFileHint.filePath,
-          line: enhancedFileHint.line || 1,
-          column: enhancedFileHint.column || 1,
-          confidence: enhancedFileHint.confidence || "low"
-        }
-      },
-      // Add additional metadata
-      stackName: enhancedFileHint?.stackName,
-      stackId: enhancedFileHint?.stackName,
-      // Using stackName as stackId for now
-      timestamp: (/* @__PURE__ */ new Date()).toISOString()
-    }));
-    const cdkInsightsIssues = allIssues.filter(
-      (issue) => issue.foundBy !== "cdkNag"
-    );
-    const cdkNagIssues = allIssues.filter(
-      (issue) => issue.foundBy === "cdkNag"
-    );
-    acc[resourceId] = {
-      ...group,
-      resourceId,
-      displayName,
-      cdkPath,
-      friendlyName,
-      locationHint,
-      constructName,
-      githubUrl,
-      docUrl,
-      isGenerated,
-      type: constructType,
-      sources: {
-        cdkInsights: { issues: cdkInsightsIssues },
-        cdkNag: { issues: cdkNagIssues }
-      }
-    };
-    return acc;
-  }, {});
+  return Object.entries(originalMap).reduce(
+    (acc, [resourceId, group]) => {
+      const cdkPath = Object.keys(pathToLogicalId).find(
+        (p3) => pathToLogicalId[p3] === resourceId
+      ) ?? group.cdkPath;
+      const constructType = unifiedResourceMap[resourceId]?.__constructType ?? stack.Resources[resourceId]?.Type ?? "";
+      const githubUrl = resourceIdMetadata[resourceId]?.githubUrl;
+      const docUrl = resourceIdMetadata[resourceId]?.docUrl;
+      const constructName = resourceIdMetadata[resourceId]?.constructName;
+      const isGenerated = isGeneratedByCDK(cdkPath, constructType);
+      const displayName = unifiedResourceMap[resourceId]?.displayName;
+      const friendlyName = displayName ?? unifiedResourceMap[resourceId]?.__friendlyName ?? cdkPath.split("/").pop() ?? resourceId;
+      const locationHint = displayName ?? cdkPath ?? group.locationHint;
+      const enhancedFileHint = findEnhancedFileFromPath(manifest, resourceId);
+      const allIssues = [
+        ...group.sources.cdkInsights.issues,
+        ...group.sources.cdkNag.issues
+      ].map((issue) => ({
+        ...issue,
+        locationHint,
+        githubUrl,
+        docUrl,
+        constructName,
+        // Add source location if available
+        ...enhancedFileHint?.filePath && {
+          sourceLocation: {
+            filePath: enhancedFileHint.filePath,
+            line: enhancedFileHint.line || 1,
+            column: enhancedFileHint.column || 1,
+            confidence: enhancedFileHint.confidence || "low"
+          }
+        },
+        // Add additional metadata
+        stackName: enhancedFileHint?.stackName,
+        stackId: enhancedFileHint?.stackName,
+        // Using stackName as stackId for now
+        timestamp: (/* @__PURE__ */ new Date()).toISOString()
+      }));
+      const cdkInsightsIssues = allIssues.filter(
+        (issue) => issue.foundBy !== "cdkNag"
+      );
+      const cdkNagIssues = allIssues.filter(
+        (issue) => issue.foundBy === "cdkNag"
+      );
+      acc[resourceId] = {
+        ...group,
+        resourceId,
+        displayName,
+        cdkPath,
+        friendlyName,
+        locationHint,
+        constructName,
+        githubUrl,
+        docUrl,
+        isGenerated,
+        type: constructType,
+        sources: {
+          cdkInsights: { issues: cdkInsightsIssues },
+          cdkNag: { issues: cdkNagIssues }
+        }
+      };
+      return acc;
+    },
+    {}
+  );
 };
 
 // src/helpers/extractInlineNagFindings/nagToWAFMap.ts
@@ -84693,7 +84696,10 @@ var TerminalOutput = class _TerminalOutput {
       const trialDuration = trialEnd - trialStart;
       const elapsed = now - trialStart;
       const remaining = trialEnd - now;
-      const trialProgress = Math.max(0, Math.min(100, elapsed / trialDuration * 100));
+      const trialProgress = Math.max(
+        0,
+        Math.min(100, elapsed / trialDuration * 100)
+      );
       const trialFilledBars = Math.round(trialProgress / 100 * barWidth);
       const trialEmptyBars = Math.max(0, barWidth - trialFilledBars);
       const trialProgressBar = "\u2588".repeat(trialFilledBars) + "\u2591".repeat(trialEmptyBars);
@@ -89778,10 +89784,13 @@ var runStaticAnalysis = (cloudformationTemplate, createFinding2, selectedService
   const resourceFilter = createResourceFilter(selectedServices);
   const userResources = Object.entries(cloudformationTemplate.Resources || {}).filter(
     ([, cloudFormationResource]) => resourceFilter(cloudFormationResource)
-  ).reduce((accumulatedResources, [resourceId, cloudFormationResource]) => {
-    accumulatedResources[resourceId] = cloudFormationResource;
-    return accumulatedResources;
-  }, {});
+  ).reduce(
+    (accumulatedResources, [resourceId, cloudFormationResource]) => {
+      accumulatedResources[resourceId] = cloudFormationResource;
+      return accumulatedResources;
+    },
+    {}
+  );
   for (const serviceName of servicesToAnalyze) {
     try {
       const serviceCheckFunction = serviceChecks[serviceName];
@@ -91909,11 +91918,7 @@ var createGithubIssue = async ({
     if (gistUrl) {
       terminal.githubGistCreated(gistUrl);
       if (recommendations && summary) {
-        bodyToWrite = generateMarkdownSummary(
-          stackName,
-          summary,
-          gistUrl
-        );
+        bodyToWrite = generateMarkdownSummary(stackName, summary, gistUrl);
       } else {
         const summarySection = issueBody.split("\n---\n")[0];
         bodyToWrite = `${summarySection}

package/dist/index.js

@@ -54753,10 +54753,13 @@ var runStaticAnalysis = (cloudformationTemplate, createFinding2, selectedService
   const resourceFilter = createResourceFilter(selectedServices);
   const userResources = Object.entries(cloudformationTemplate.Resources || {}).filter(
     ([, cloudFormationResource]) => resourceFilter(cloudFormationResource)
-  ).reduce((accumulatedResources, [resourceId, cloudFormationResource]) => {
-    accumulatedResources[resourceId] = cloudFormationResource;
-    return accumulatedResources;
-  }, {});
+  ).reduce(
+    (accumulatedResources, [resourceId, cloudFormationResource]) => {
+      accumulatedResources[resourceId] = cloudFormationResource;
+      return accumulatedResources;
+    },
+    {}
+  );
   for (const serviceName of servicesToAnalyze) {
     try {
       const serviceCheckFunction = serviceChecks[serviceName];
@@ -57580,7 +57583,10 @@ var TerminalOutput = class _TerminalOutput {
       const trialDuration = trialEnd - trialStart;
       const elapsed = now - trialStart;
       const remaining = trialEnd - now;
-      const trialProgress = Math.max(0, Math.min(100, elapsed / trialDuration * 100));
+      const trialProgress = Math.max(
+        0,
+        Math.min(100, elapsed / trialDuration * 100)
+      );
       const trialFilledBars = Math.round(trialProgress / 100 * barWidth);
       const trialEmptyBars = Math.max(0, barWidth - trialFilledBars);
       const trialProgressBar = "\u2588".repeat(trialFilledBars) + "\u2591".repeat(trialEmptyBars);
@@ -58465,11 +58471,7 @@ var createGithubIssue = async ({
     if (gistUrl) {
       terminal2.githubGistCreated(gistUrl);
       if (recommendations && summary) {
-        bodyToWrite = generateMarkdownSummary(
-          stackName,
-          summary,
-          gistUrl
-        );
+        bodyToWrite = generateMarkdownSummary(stackName, summary, gistUrl);
       } else {
         const summarySection = issueBody.split("\n---\n")[0];
         bodyToWrite = `${summarySection}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cdk-insights",
-  "version": "0.2.0-beta.8",
+  "version": "0.3.0",
   "description": "AWS CDK security and cost analysis tool with AI-powered insights",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",