rsshub / scripts /workflow /build-routes.ts
asemxin
Initial commit for HF Spaces
bf48b89
import fs from 'node:fs';
import path from 'node:path';
import { parse } from 'tldts';
import toSource from 'tosource';
import type { RadarItem } from '../../lib/types';
import { getCurrentPath } from '../../lib/utils/helpers';
const __dirname = getCurrentPath(import.meta.url);
// Check if building for Worker environment
const isWorkerBuild = process.env.WORKER_BUILD === 'true';
// Ignore Redis and remote config in route generation to avoid side effects.
process.env.REDIS_URL = '';
process.env.CACHE_TYPE = '';
process.env.REMOTE_CONFIG = '';
const { namespaces } = await import('../../lib/registry');
const maintainers: Record<string, string[]> = {};
const radar: {
[domain: string]: {
_name: string;
[subdomain: string]: RadarItem[] | string;
};
} = {};
// Generate route paths type
const allRoutePaths = new Set<string>();
// Use all namespaces for both regular and Worker builds
const namespacesToProcess = namespaces;
for (const namespace in namespacesToProcess) {
const namespaceData = namespacesToProcess[namespace];
let defaultCategory = namespaceData.categories?.[0];
if (!defaultCategory) {
for (const path in namespaceData.routes) {
if (namespaceData.routes[path].categories) {
defaultCategory = namespaceData.routes[path].categories[0];
break;
}
}
}
if (!defaultCategory) {
defaultCategory = 'other';
}
for (const path in namespaceData.routes) {
const realPath = `/${namespace}${path}`;
allRoutePaths.add(realPath);
const data = namespaceData.routes[path];
const categories = data.categories || namespaceData.categories || [defaultCategory];
// maintainers
if (data.maintainers) {
maintainers[realPath] = data.maintainers;
}
// radar
if (data.radar?.length) {
for (const radarItem of data.radar) {
const parsedDomain = parse(new URL('https://' + radarItem.source[0]).hostname);
const subdomain = parsedDomain.subdomain || '.';
const domain = parsedDomain.domain;
if (domain) {
if (!radar[domain]) {
radar[domain] = {
_name: namespaceData.name,
};
}
if (!radar[domain][subdomain]) {
radar[domain][subdomain] = [];
}
radar[domain][subdomain].push({
title: radarItem.title || data.name,
docs: `https://docs.rsshub.app/routes/${categories[0]}`,
source: radarItem.source.map((source) => {
const sourceURL = new URL('https://' + source);
return sourceURL.pathname + sourceURL.search + sourceURL.hash;
}),
target: radarItem.target ? `/${namespace}${radarItem.target}` : realPath,
});
}
}
}
data.module = `() => import('@/routes/${namespace}/${data.location}')`;
}
for (const path in namespaceData.apiRoutes) {
const data = namespaceData.apiRoutes[path];
data.module = `() => import('@/routes/${namespace}/${data.location}')`;
}
}
// Remove duplicates and sort
const uniquePaths = [...allRoutePaths].toSorted();
const routePathsType = `// This file is auto-generated by scripts/workflow/build-routes.ts
// Do not edit manually
export type RoutePath =
${uniquePaths.map((path) => ` | \`${path}\``).join('\n')};
`;
// Ensure output directory exists
const buildDir = path.join(__dirname, '../../assets/build');
fs.mkdirSync(buildDir, { recursive: true });
// For Worker build, only output routes-worker.js with filtered namespaces
// For regular build, output all files
if (isWorkerBuild) {
fs.writeFileSync(path.join(__dirname, '../../assets/build/routes-worker.js'), `export default ${JSON.stringify(namespacesToProcess, null, 2)}`.replaceAll(/"module": "(.*)"\n/g, `"module": $1\n`));
} else {
fs.writeFileSync(path.join(__dirname, '../../assets/build/radar-rules.json'), JSON.stringify(radar, null, 2));
fs.writeFileSync(path.join(__dirname, '../../assets/build/radar-rules.js'), `(${toSource(radar)})`);
fs.writeFileSync(path.join(__dirname, '../../assets/build/maintainers.json'), JSON.stringify(maintainers, null, 2));
fs.writeFileSync(path.join(__dirname, '../../assets/build/routes.json'), JSON.stringify(namespaces, null, 2));
fs.writeFileSync(path.join(__dirname, '../../assets/build/routes.js'), `export default ${JSON.stringify(namespaces, null, 2)}`.replaceAll(/"module": "(.*)"\n/g, `"module": $1\n`));
fs.writeFileSync(path.join(__dirname, '../../assets/build/route-paths.ts'), routePathsType);
}