cdk-insights 0.2.0-beta.7 → 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**
@@ -705,9 +709,7 @@ CDK Insights offers flexible plans for teams of all sizes:
 - **🚀 Pro Tier**: AI-powered insights, unlimited scanning, and team features
 - **🏢 Enterprise**: Advanced compliance, unlimited usage, and dedicated support
 
-[**View all plans and pricing →**](https://cdkinsights.dev/pricing)
-
-[**Start free →**](https://cdkinsights.dev/signup) | [**Contact sales →**](https://cdkinsights.dev/enterprise)
+[**View all plans and pricing →**](https://cdkinsights.dev/#pricing)
 
 ## 📄 License
 
@@ -715,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/cacheUtils.d.ts

@@ -0,0 +1,3 @@
+import type { FileBasedCache } from '../helpers/cache/fileBasedCache';
+export declare const setGlobalCache: (cache: FileBasedCache<unknown>) => void;
+export declare const getGlobalCache: () => FileBasedCache<unknown> | null;

package/dist/cli/entry.d.ts

@@ -1,2 +1 @@
-import type { FileBasedCache } from '../helpers/cache/fileBasedCache';
-export declare const setGlobalCache: (cache: FileBasedCache<unknown>) => void;
+export {};

package/dist/cli/entry.js

@@ -70795,11 +70795,6 @@ var require_emoji_regex2 = __commonJS({
 });
 
 // src/cli/entry.ts
-var entry_exports = {};
-__export(entry_exports, {
-  setGlobalCache: () => setGlobalCache
-});
-module.exports = __toCommonJS(entry_exports);
 var import_dotenv2 = __toESM(require_main());
 var import_node_child_process6 = require("node:child_process");
 var path12 = __toESM(require("node:path"));
@@ -83190,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
@@ -84698,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);
@@ -89783,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];
@@ -91106,6 +91110,33 @@ var AnalysisProgressHandler = class _AnalysisProgressHandler {
 };
 var analysisProgress = AnalysisProgressHandler.getInstance();
 
+// src/cli/cacheUtils.ts
+var globalAnalysisCache = null;
+var setGlobalCache = (cache3) => {
+  globalAnalysisCache = cache3;
+};
+var handleProcessExit = () => {
+  if (globalAnalysisCache && !process.env.CI) {
+    try {
+      globalAnalysisCache.saveToDisk();
+      cliLogger.info("\u{1F4BE} Cache saved to disk on exit");
+    } catch (error2) {
+      cliLogger.warn("\u26A0\uFE0F  Could not save cache on exit", {
+        error: error2 instanceof Error ? error2.message : String(error2)
+      });
+    }
+  }
+};
+process.on("exit", handleProcessExit);
+process.on("SIGINT", () => {
+  handleProcessExit();
+  process.exit(0);
+});
+process.on("SIGTERM", () => {
+  handleProcessExit();
+  process.exit(0);
+});
+
 // src/cli/analysisJob.ts
 var DEFAULT_CONCURRENCY_CONFIG = {
   maxConcurrent: 5,
@@ -91887,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}
@@ -94364,31 +94391,6 @@ var CONFIG_FIELDS = {
     validation: "JSON object with enabled (boolean), ttl (number), maxSize (number)"
   }
 };
-var globalAnalysisCache = null;
-var setGlobalCache = (cache3) => {
-  globalAnalysisCache = cache3;
-};
-var handleProcessExit = () => {
-  if (globalAnalysisCache && !process.env.CI) {
-    try {
-      globalAnalysisCache.saveToDisk();
-      cliLogger.info("\u{1F4BE} Cache saved to disk on exit");
-    } catch (error2) {
-      cliLogger.warn("\u26A0\uFE0F  Could not save cache on exit", {
-        error: error2 instanceof Error ? error2.message : String(error2)
-      });
-    }
-  }
-};
-process.on("exit", handleProcessExit);
-process.on("SIGINT", () => {
-  handleProcessExit();
-  process.exit(0);
-});
-process.on("SIGTERM", () => {
-  handleProcessExit();
-  process.exit(0);
-});
 var showConfigFieldHelp = (fieldName) => {
   const field = CONFIG_FIELDS[fieldName];
   if (!field) {
@@ -94781,10 +94783,6 @@ var setupCLI = () => {
   ).demandCommand(1, "Please specify a command.").strict().help().wrap(null).epilog(createHelpTable()).parse();
 };
 setupCLI();
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  setGlobalCache
-});
 /*! Bundled license information:
 
 tmp/lib/tmp.js: