feat: add option to generate other sitemaps links (#90)

* feat: add option to generate other sitemaps links * feat: allow urls
jbaubree · Nov 17, 2023 · e98bc94 · e98bc94
1 parent 56875a2
commit e98bc94
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -49,6 +49,18 @@ generateSitemap({
 })
 ```
 
+### externalSitemaps
+
+- **Type:** `string[]`
+- **Default:** `[]`
+
+Array of strings with other sitemaps paths or urls.
+```js
+generateSitemap({
+  externalSitemaps: ['sitemap_1', 'sitemap_2', 'subpath/sitemap_3', 'https://site.com/sitemap.xml']
+})
+```
+
 ### base path
 
 - **Type:** `string`

diff --git a/src/index.ts b/src/index.ts
@@ -14,7 +14,7 @@ export function generateSitemap(options: UserOptions = {}) {
   // robots.txt
   if (resolvedOptions.generateRobotsTxt) {
     const robotRules = getRules(resolvedOptions.robots)
-    const robotContent = getContent(robotRules, resolvedOptions.hostname)
+    const robotContent = getContent(robotRules, resolvedOptions.hostname, resolvedOptions.externalSitemaps)
     writeFileSync(getResolvedPath('robots.txt', resolvedOptions), robotContent)
   }
 

diff --git a/src/options.ts b/src/options.ts
@@ -4,6 +4,7 @@ export const defaultOptions = {
   hostname: 'http://localhost/',
   dynamicRoutes: [],
   exclude: [],
+  externalSitemaps: [],
   basePath: '',
   outDir: 'dist',
   extensions: 'html',

diff --git a/src/robots.ts b/src/robots.ts
@@ -1,6 +1,7 @@
-import { ensureSuffix } from '@antfu/utils'
+import { ensurePrefix, ensureSuffix } from '@antfu/utils'
 
 import type { RobotOption } from './types'
+import { removeMaybeSuffix } from './utils'
 
 enum RobotCorrespondences {
   userAgent = 'User-agent',
@@ -39,11 +40,14 @@ export function getRules(options: RobotOption[]) {
   return rules
 }
 
-export function getContent(rules: RobotRuleInterface[], hostname: string) {
+export function getContent(rules: RobotRuleInterface[], hostname: string, externalSitemaps: string[]) {
   return rules.map(rule => `${rule.key}: ${String(rule.value).trim()}`).join('\n')
     .concat(`\n\nSitemap: ${getFinalSitemapPath(hostname)}`)
+    .concat(externalSitemaps.map(s => `\nSitemap: ${
+        s.startsWith('http') ? s : getFinalSitemapPath(hostname, s)
+      }`).join(''))
 }
 
-export function getFinalSitemapPath(hostname: string) {
-  return `${ensureSuffix('/', hostname)}sitemap.xml`
+export function getFinalSitemapPath(hostname: string, file = '/sitemap.xml') {
+  return `${removeMaybeSuffix('/', hostname)}${ensurePrefix('/', file)}`
 }
diff --git a/src/types.ts b/src/types.ts
@@ -49,6 +49,12 @@ interface Options {
    * @default []
    */
   exclude: string[]
+  /**
+   * Other sitemaps paths
+   * Example: ['sitemap_1.xml', 'path/sitemap_2.xml', 'https://site.com/sitemap.xml']
+   * @default []
+   */
+  externalSitemaps: string[]
   /**
    * String with base path.
    * Example: '/mysubpath'

diff --git a/test/options.test.ts b/test/options.test.ts
@@ -12,6 +12,7 @@ describe('Options', () => {
         "dynamicRoutes": [],
         "exclude": [],
         "extensions": "html",
+        "externalSitemaps": [],
         "generateRobotsTxt": true,
         "hostname": "http://localhost/",
         "lastmod": Any<Date>,
@@ -43,6 +44,7 @@ describe('Options', () => {
           "/route2/sub-route",
         ],
         "extensions": "html",
+        "externalSitemaps": [],
         "generateRobotsTxt": true,
         "hostname": "http://localhost/",
         "lastmod": Any<Date>,
@@ -74,6 +76,7 @@ describe('Options', () => {
           "html",
           "md",
         ],
+        "externalSitemaps": [],
         "generateRobotsTxt": true,
         "hostname": "http://localhost/",
         "lastmod": Any<Date>,
@@ -113,6 +116,7 @@ describe('Options', () => {
         "dynamicRoutes": [],
         "exclude": [],
         "extensions": "html",
+        "externalSitemaps": [],
         "generateRobotsTxt": true,
         "hostname": "http://localhost/",
         "lastmod": Any<Date>,
@@ -155,6 +159,7 @@ describe('Options', () => {
         "dynamicRoutes": [],
         "exclude": [],
         "extensions": "html",
+        "externalSitemaps": [],
         "generateRobotsTxt": false,
         "hostname": "http://localhost/",
         "lastmod": Any<Date>,

diff --git a/test/robots.test.ts b/test/robots.test.ts
@@ -11,9 +11,12 @@ describe('Robots', () => {
   })
 
   test('Get content', async () => {
-    expect(getContent([], 'http//localhost/')).toEqual('\n\nSitemap: http//localhost/sitemap.xml')
-    expect(getContent(TEST_RULES_1, 'http//localhost/')).toEqual('User-agent: *\nAllow: /\n\nSitemap: http//localhost/sitemap.xml')
-    expect(getContent(TEST_RULES_2, 'http//localhost/')).toEqual('User-agent: *\nAllow: /\nUser-agent: Googlebot\nAllow: /admin\nDisallow: /disallow\nDisallow: /test\nCrawl-delay: 10\n\nSitemap: http//localhost/sitemap.xml')
+    expect(getContent([], 'http//localhost/', [])).toEqual('\n\nSitemap: http//localhost/sitemap.xml')
+    expect(getContent(TEST_RULES_1, 'http//localhost/', [])).toEqual('User-agent: *\nAllow: /\n\nSitemap: http//localhost/sitemap.xml')
+    expect(getContent(TEST_RULES_2, 'http//localhost/', [])).toEqual('User-agent: *\nAllow: /\nUser-agent: Googlebot\nAllow: /admin\nDisallow: /disallow\nDisallow: /test\nCrawl-delay: 10\n\nSitemap: http//localhost/sitemap.xml')
+    expect(getContent([], 'http//localhost/', ['sitemap_1.xml', 'subpath/sitemap_2.xml'])).toEqual('\n\nSitemap: http//localhost/sitemap.xml\nSitemap: http//localhost/sitemap_1.xml\nSitemap: http//localhost/subpath/sitemap_2.xml')
+    expect(getContent([], 'http//localhost/', ['/sitemap_1.xml', '/subpath/sitemap_2.xml'])).toEqual('\n\nSitemap: http//localhost/sitemap.xml\nSitemap: http//localhost/sitemap_1.xml\nSitemap: http//localhost/subpath/sitemap_2.xml')
+    expect(getContent([], 'http//localhost/', ['/sitemap_1.xml', 'https://test.com/subpath/sitemap_2.xml'])).toEqual('\n\nSitemap: http//localhost/sitemap.xml\nSitemap: http//localhost/sitemap_1.xml\nSitemap: https://test.com/subpath/sitemap_2.xml')
   })
 
   test('Get final sitemap path', async () => {