refactor(sitemap): simplify config to file= and strip query by default

Replace outputName/output with a single `file` option relative to the
output directory (default output/sitemap.xml). stripQuery is now true by
default. CLI args (-p sitemap:file=...:stripQuery=false) are parsed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Author: DavertMik

docs/plugins/sitemap.md

@@ -30,14 +30,14 @@ The sitemap is written once all tests finish.
 
 Possible config options:
 
-*   `outputName`: file name for the sitemap. Default: `sitemap.xml`.
-*   `output`: directory where the sitemap is stored, relative to the project root. Default: the `output` directory.
-*   `stripQuery`: remove query strings so `/posts?page=1` and `/posts?page=2` become one `/posts` entry. Default: false.
+*   `file`: path to the sitemap file, relative to the output directory. Default: `sitemap.xml`, saved as `output/sitemap.xml`.
+*   `stripQuery`: remove query strings so `/posts?page=1` and `/posts?page=2` become one `/posts` entry. Set to `false` to keep them. Default: true.
 
 CLI examples:
 
     npx codeceptjs run -p sitemap
-    npx codeceptjs run -p sitemap:outputName=visited.xml
+    npx codeceptjs run -p sitemap:file=visited.xml
+    npx codeceptjs run -p sitemap:stripQuery=false
 
 Works with `run-workers`: URLs from all workers are merged into a single sitemap.
 

lib/plugin/sitemap.js

@@ -9,11 +9,11 @@ import event from '../event.js'
 import recorder from '../recorder.js'
 import store from '../store.js'
 import output from '../output.js'
+import { parsePluginArgs } from '../utils/pluginParser.js'
 
 const defaultConfig = {
-  outputName: 'sitemap.xml',
-  output: null,
-  stripQuery: false,
+  file: 'sitemap.xml',
+  stripQuery: true,
 }
 
 const SITEMAP_NS = 'http://www.sitemaps.org/schemas/sitemap/0.9'
@@ -41,31 +41,27 @@ const PARTIAL_PREFIX = '.sitemap.'
  *
  * Possible config options:
  *
- * * `outputName`: file name for the sitemap. Default: `sitemap.xml`.
- * * `output`: directory where the sitemap is stored, relative to the project root. Default: the `output` directory.
- * * `stripQuery`: remove query strings so `/posts?page=1` and `/posts?page=2` become one `/posts` entry. Default: false.
+ * * `file`: path to the sitemap file, relative to the output directory. Default: `sitemap.xml`, saved as `output/sitemap.xml`.
+ * * `stripQuery`: remove query strings so `/posts?page=1` and `/posts?page=2` become one `/posts` entry. Set to `false` to keep them. Default: true.
  *
  * CLI examples:
  *
  * ```
  * npx codeceptjs run -p sitemap
- * npx codeceptjs run -p sitemap:outputName=visited.xml
+ * npx codeceptjs run -p sitemap:file=visited.xml
+ * npx codeceptjs run -p sitemap:stripQuery=false
  * ```
  *
  * Works with `run-workers`: URLs from all workers are merged into a single sitemap.
  *
  * @param {*} config
  */
 export default function (config = {}) {
-  config = Object.assign({}, defaultConfig, config)
-  if (config.stripQuery === 'true') config.stripQuery = true
+  config = Object.assign({}, defaultConfig, config, parsePluginArgs(config._args))
 
   const urls = new Set()
 
-  const outputDir = () => {
-    if (config.output) return path.resolve(store.codeceptDir || process.cwd(), config.output)
-    return store.outputDir || process.cwd()
-  }
+  const outputDir = () => store.outputDir || process.cwd()
 
   const addUrl = url => {
     if (!url) return
@@ -84,9 +80,8 @@ export default function (config = {}) {
   const writeSitemap = list => {
     if (!list.length) return
 
-    const dir = outputDir()
-    mkdirp.sync(dir)
-    const file = path.join(dir, config.outputName)
+    const file = path.resolve(outputDir(), config.file)
+    mkdirp.sync(path.dirname(file))
     fs.writeFileSync(file, buildXml(list.sort()))
     output.plugin('sitemap', `Sitemap with ${list.length} pages saved to ${file}`)
   }

test/unit/plugin/sitemap_test.js

@@ -58,7 +58,7 @@ describe('sitemap plugin', () => {
   })
 
   it('writes unique visited pages to sitemap.xml', async () => {
-    sitemap({})
+    sitemap({ stripQuery: false })
     await startTest()
     await visit('http://localhost:8000/')
     await visit('http://localhost:8000/form/field#top')
@@ -159,18 +159,29 @@ describe('sitemap plugin', () => {
     expect(xml).not.to.include('/frame')
   })
 
-  it('strips query strings when configured', async () => {
-    sitemap({ stripQuery: true, outputName: 'pages.xml' })
+  it('strips query strings by default and saves to custom file', async () => {
+    sitemap({ file: 'reports/pages.xml' })
     await startTest()
     await visit('http://localhost:8000/posts?page=1')
     await visit('http://localhost:8000/posts?page=2')
     event.dispatcher.emit(event.all.result, {})
 
-    const xml = fs.readFileSync(path.join(outputDir, 'pages.xml'), 'utf8')
+    const xml = fs.readFileSync(path.join(outputDir, 'reports', 'pages.xml'), 'utf8')
     expect(xml.match(/<loc>/g).length).to.equal(1)
     expect(xml).to.include('<loc>http://localhost:8000/posts</loc>')
   })
 
+  it('keeps query strings when stripQuery=false is passed from CLI', async () => {
+    sitemap({ _args: ['stripQuery=false'] })
+    await startTest()
+    await visit('http://localhost:8000/posts?page=1')
+    await visit('http://localhost:8000/posts?page=2')
+    event.dispatcher.emit(event.all.result, {})
+
+    const xml = fs.readFileSync(path.join(outputDir, 'sitemap.xml'), 'utf8')
+    expect(xml.match(/<loc>/g).length).to.equal(2)
+  })
+
   it('merges worker partials on workers.result', async () => {
     sitemap({})
     fs.writeFileSync(path.join(outputDir, '.sitemap.1.1.json'), JSON.stringify(['http://localhost:8000/a']))