astro-indexnow 2.3.1 → 2.3.3

package/README.MD

@@ -6,7 +6,7 @@ to **IndexNow** after each build.
 This package is designed for **modern CI/CD pipelines**, **Docker-based deployments**, and
 **large static sites**, while remaining fully deterministic and explicit.
 
-> **Current release:** v2.3.1  
+> **Current release:** v2.3.3  
 > **Stateful by design. `changed` by default, `all` available. Batch-safe. CI-aware.**
 
 ---
@@ -28,6 +28,8 @@ Instead of waiting for crawlers, your site tells search engines exactly which UR
 - 🧠 Stores a small on-disk cache to avoid re-submitting unchanged URLs
 - 📦 **Batches submissions** safely (IndexNow 10,000 URL limit)
 - 🔀 Optional `submissionMode` lets you choose `changed` or `all`
+- 🧪 Optional `dryRun` plans submissions without sending requests
+- 🗣 Optional `logMode` controls verbosity with `quiet`, `normal`, and `verbose`
 - 🧪 Fully **CI/CD and Docker safe**
 - 🔒 No secrets prompted, stored, or mutated
 - 🧩 No client-side or runtime code added
@@ -221,6 +223,41 @@ indexnow({ enabled: false })
 
 ---
 
+### `dryRun` (optional)
+
+Type: `boolean`
+Default: `false`
+
+When `true`, the integration performs discovery, diffing, and batching, then logs the plan without sending any IndexNow requests.
+Dry runs do not mutate the cache file.
+
+```js
+indexnow({
+  dryRun: true,
+})
+```
+
+---
+
+### `logMode` (optional)
+
+Type: `"quiet" | "normal" | "verbose"`
+Default: `"normal"`
+
+Controls how much the integration logs:
+
+- `quiet` suppresses info and warning logs
+- `normal` keeps high-level info and warnings, but not URL lists
+- `verbose` includes cache, diff, and the full planned URL list
+
+```js
+indexnow({
+  logMode: "verbose",
+})
+```
+
+---
+
 ### `cacheDir` (optional)
 
 Type: `string`  

package/dist/index.d.ts

@@ -4,6 +4,8 @@ export interface IndexNowOptions {
     siteUrl?: string;
     enabled?: boolean;
     cacheDir?: string;
+    dryRun?: boolean;
+    logMode?: "quiet" | "normal" | "verbose";
     submissionMode?: "changed" | "all";
 }
 export default function indexNow(options?: IndexNowOptions): AstroIntegration;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,OAAO,CAAC;AAM9C,MAAM,WAAW,eAAe;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC;CACpC;AAED,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,OAAO,GAAE,eAAoB,GAC5B,gBAAgB,CA8MlB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,OAAO,CAAC;AAM9C,MAAM,WAAW,eAAe;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;IACzC,cAAc,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC;CACpC;AAED,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,OAAO,GAAE,eAAoB,GAC5B,gBAAgB,CAsPlB"}

package/dist/index.js

@@ -17,13 +17,13 @@ export default function indexNow(options = {}) {
     function ensureCacheFile(logger) {
         const dir = path.dirname(cachePath);
         if (!fs.existsSync(dir)) {
-            logger.debug(`[astro-indexnow] creating cache directory: ${dir}`);
+            logger.debug(`creating cache directory: ${dir}`);
             fs.mkdirSync(dir, { recursive: true });
         }
         const exists = fs.existsSync(cachePath);
-        logger.debug(`[astro-indexnow] cache exists: ${exists} (${cachePath})`);
+        logger.debug(`cache exists: ${exists} (${cachePath})`);
         if (!exists) {
-            logger.debug("[astro-indexnow] creating cache file");
+            logger.debug("creating cache file");
             fs.writeFileSync(cachePath, "{}", "utf8");
         }
     }
@@ -34,17 +34,17 @@ export default function indexNow(options = {}) {
         return `sha256:${hash.digest("hex")}`;
     }
     function loadCache(logger) {
-        logger.debug("[astro-indexnow] loading cache file");
+        logger.debug("loading cache file");
         try {
             return JSON.parse(fs.readFileSync(cachePath, "utf8"));
         }
         catch {
-            logger.warn("[astro-indexnow] cache file unreadable, resetting");
+            logger.warn("cache file unreadable, resetting");
             return {};
         }
     }
     function saveCache(logger, data) {
-        logger.debug("[astro-indexnow] writing cache file");
+        logger.debug("writing cache file");
         fs.writeFileSync(cachePath, JSON.stringify(data, null, 2), "utf8");
     }
     function chunk(array, size) {
@@ -54,6 +54,24 @@ export default function indexNow(options = {}) {
         }
         return chunks;
     }
+    function isQuiet() {
+        return options.logMode === "quiet";
+    }
+    function isVerbose() {
+        return options.logMode === "verbose";
+    }
+    function logInfo(logger, message) {
+        if (!isQuiet())
+            logger.info(message);
+    }
+    function logWarn(logger, message) {
+        if (!isQuiet())
+            logger.warn(message);
+    }
+    function logVerbose(logger, message) {
+        if (isVerbose())
+            logger.info(message);
+    }
     /* =========================================================
        Integration
        ========================================================= */
@@ -67,7 +85,7 @@ export default function indexNow(options = {}) {
                 site =
                     options.siteUrl ??
                         (config.site ? config.site.replace(/\/$/, "") : null);
-                logger.debug(`[astro-indexnow] project root: ${projectRoot}`);
+                logVerbose(logger, `project root: ${projectRoot}`);
                 ensureCacheFile(logger);
             },
             /* -----------------------------------------------
@@ -75,7 +93,7 @@ export default function indexNow(options = {}) {
                ----------------------------------------------- */
             "astro:build:done": async ({ dir, logger }) => {
                 if (options.enabled === false) {
-                    logger.info("[astro-indexnow] disabled");
+                    logInfo(logger, "disabled");
                     return;
                 }
                 if (!options.key) {
@@ -109,26 +127,38 @@ export default function indexNow(options = {}) {
                     }
                 }
                 walk(outDir);
-                logger.debug("[astro-indexnow] page diff:");
+                logVerbose(logger, "page diff:");
                 for (const url of Object.keys(nextCache)) {
                     const state = previousCache[url] === nextCache[url]
                         ? "unchanged"
                         : "new/changed";
-                    logger.debug(` - ${url} (${state})`);
+                    if (isVerbose()) {
+                        logVerbose(logger, ` - ${url} (${state})`);
+                    }
                 }
                 const urlsToSubmit = options.submissionMode === "all"
                     ? Object.keys(nextCache)
                     : changedUrls;
                 if (urlsToSubmit.length === 0) {
-                    logger.info("[astro-indexnow] no changed URLs detected, skipping submission");
+                    logInfo(logger, "no changed URLs detected, skipping submission");
                     saveCache(logger, nextCache);
                     return;
                 }
                 const batches = chunk(urlsToSubmit, INDEXNOW_BATCH_SIZE);
-                logger.info(`[astro-indexnow] submitting ${urlsToSubmit.length} URL(s) in ${batches.length} batch(es) [mode=${options.submissionMode ?? "changed"}]`);
+                logInfo(logger, `submitting ${urlsToSubmit.length} URL(s) in ${batches.length} batch(es) [mode=${options.submissionMode ?? "changed"}]`);
+                if (isVerbose()) {
+                    logVerbose(logger, "planned URL list:");
+                    for (const url of urlsToSubmit) {
+                        logVerbose(logger, ` - ${url}`);
+                    }
+                }
+                if (options.dryRun) {
+                    logInfo(logger, "dry run enabled, skipping submission");
+                    return;
+                }
                 for (let i = 0; i < batches.length; i++) {
                     const batch = batches[i];
-                    logger.debug(`[astro-indexnow] submitting batch ${i + 1}/${batches.length} (${batch.length} URLs)`);
+                    logVerbose(logger, `submitting batch ${i + 1}/${batches.length} (${batch.length} URLs)`);
                     try {
                         const response = await fetch(INDEXNOW_ENDPOINT, {
                             method: "POST",
@@ -141,15 +171,15 @@ export default function indexNow(options = {}) {
                             }),
                         });
                         if (!response.ok) {
-                            logger.warn(`[astro-indexnow] batch ${i + 1} failed (${response.status})`);
+                            logWarn(logger, `batch ${i + 1} failed (${response.status})`);
                         }
                     }
                     catch {
-                        logger.warn(`[astro-indexnow] batch ${i + 1} submission failed (network error)`);
+                        logWarn(logger, `batch ${i + 1} submission failed (network error)`);
                     }
                 }
                 saveCache(logger, nextCache);
-                logger.info(`[astro-indexnow] IndexNow submission complete`);
+                logInfo(logger, `IndexNow submission complete`);
             },
         },
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-indexnow",
-  "version": "2.3.1",
+  "version": "2.3.3",
   "description": "Astro integration to submit pages to IndexNow automatically after build",
   "type": "module",
   "exports": {