Script Standard

Code Style

General Guidelines

• Be consistent!
• Avoid using deprecated features.
• Avoid modifying yarn.lock and package.json, unless you are adding a new dependency.
• Conbine repetitive code into functions.
• Prefer higher ECMAScript Standard features over lower ones.
• Sort the entries alphabetically (uppercase first) to make it easier to find an entry.
• Use HTTPS instead of HTTP whenever possible.
• Use WebP format instead of JPG whenever possible since it offers better compression.

Formatting

Indentation

• Use 4 spaces for indentation for consistent and easy-to-read code.

Semicolons

• Add a semicolon at the end of each statement for improved readability and consistency.

String

• Use single quotes instead of double quotes whenever possible for consistency and readability.
• Use template literals over complex string concatenation.
• Use template literals for GraphQL queries as they make the code more concise and easy to read.

Whitespace

• Add an empty line at the end of each file.
• Avoid trailing whitespace for a clean and readable codebase.

Language Features

Casting

• Avoid re-casting the same type.

Functions

• Prefer arrow functions over the function keyword.

Loops

• Use for-of instead of for for arrays (javascript:S4138).

Variables

• Use const and let instead of var.
• Declare one variable per declaration.

Naming

• Use lowerCamelCase for variables and functions to adhere to standard naming conventions.
• Use kebab-case for files and folders.
• Use CONSTANT_CASE for constants.

v2 Route Standard

DANGER

The v2 Route Standard is deprecated. All new routes should be following the Create Route.

When creating a new route in RSSHub, you need to organize your files in a specific way. Your namespace folder should be stored in the lib/routes directory and should include three mandatory files:

• router.ts Registers the routes
• maintainer.ts Provides information about the route maintainer
• radar.ts Provide a RSSHub Radar rule for each route

Your namespace folder structure should look like this:

├───lib/routes
│   ├───furstar
│       ├─── templates
│           ├─── description.art
│       ├─── router.ts
│       ├─── maintainer.ts
│       ├─── radar.ts
│       ├─── someOtherJs.ts
│   └───test
│   └───someOtherNamespaces
...

All eligible routes under the lib/routes path will be automatically loaded without the need for updating the lib/router.ts.

Namespace

RSSHub appends the name of all route namespace folders in front of the actual route. Route maintainers should think of the namespace as the root.

Naming Standard

• Use the second-level domain (SLD) as your namespace. You can find more information about URL structure here.
• Do not create variations of the same namespace. For more information, see this page

Registering a Route

To register a route, the router.ts file should export a method that provides a Hoho route handler.

Maintainer List

The maintainer.ts file should export an object that provides maintainer information related to the route, including:

• Key: Corresponding route path
• Value: Array of string, including all maintainers' GitHub ID.

To generate a list of maintainers, use the following command: pnpm run build, which will create the list under assets/build/.

DANGER

The path should be the same as the path in the corresponding documentation before the namespace appended in front of it.

Radar Rules

All routes are required to include the radar.ts file, which includes the corresponding domain name. The minimum requirement for a successful match is for the rule to show up on the corresponding site which requires filling in the title and docs fields.

To generate a complete radar-rules.ts file, use the following command: yarn build, which will create the file under assets/build/.

TIP

Remember to remove all build artifacts in assets/build/ before committing.

Rendering Templates

When rendering custom content with HTML, such as item.description, using art-template for layout is mandatory.

All templates should be placed in the namespace's templates folder with the .art file extension.

Example

Here's an example taken from the furstar namespace:

<div>
    <img src="{{ avatar }}" />
    {{ if link !== null }}
    <a href="{{ link }}">{{name}}</a>
    {{ else }}
    <a href="#">{{name}}</a>
    {{ /if }}
</div>

import path from 'node:path';
import { art } from '@/utils/render';
const renderAuthor = (author) => art(path.join(__dirname, 'templates/author.art'), author);

v1 Route Standard

DANGER

The v1 Route Standard is deprecated. All new routes should be following the Create Route.