hello" }} />;
19 | ```
20 |
--------------------------------------------------------------------------------
/lint/rules/react-no-danger.md:
--------------------------------------------------------------------------------
1 | ---
2 | tags: [react, fresh]
3 | ---
4 |
5 | 防止使用 `dangerouslySetInnerHTML`，如果使用不当可能导致 XSS 漏洞。
6 |
7 | **无效示例：**
8 |
9 | ```tsx
10 | const hello =
;
11 | ```
12 |
13 | **有效示例：**
14 |
15 | ```tsx
16 | const hello =
Hello World!
;
17 | ```
18 |
--------------------------------------------------------------------------------
/lint/rules/react-rules-of-hooks.md:
--------------------------------------------------------------------------------
1 | ---
2 | tags: [react, fresh]
3 | ---
4 |
5 | 确保在 React/Preact 组件中正确调用
6 | hooks。它们必须在组件的顶层调用，而不是在条件语句或循环内部。
7 |
8 | **无效示例：**
9 |
10 | ```tsx
11 | // 错误：在条件内部调用
12 | function MyComponent() {
13 | if (condition) {
14 | const [count, setCount] = useState(0);
15 | }
16 | }
17 |
18 | // 错误：在 for 循环内部调用
19 | function MyComponent() {
20 | for (const item of items) {
21 | const [count, setCount] = useState(0);
22 | }
23 | }
24 |
25 | // 错误：在 while 循环内部调用
26 | function MyComponent() {
27 | while (condition) {
28 | const [count, setCount] = useState(0);
29 | }
30 | }
31 |
32 | // 错误：在条件之后调用
33 | function MyComponent() {
34 | if (condition) {
35 | // ...
36 | }
37 |
38 | const [count, setCount] = useState(0);
39 | }
40 | ```
41 |
42 | **有效示例：**
43 |
44 | ```tsx
45 | function MyComponent() {
46 | const [count, setCount] = useState(0);
47 | }
48 | ```
49 |
--------------------------------------------------------------------------------
/lint/rules/require-yield.md:
--------------------------------------------------------------------------------
1 | ---
2 | tags: [recommended]
3 | ---
4 |
5 | 禁止使用没有 `yield` 的生成器函数。
6 |
7 | JavaScript 提供了通过 `function*`
8 | 表示的生成器函数，我们可以在其中暂停并在稍后恢复函数的执行。在这些暂停点，我们使用
9 | `yield` 关键字。换句话说，创建不包含 `yield`
10 | 关键字的生成器函数毫无意义，因为这样的函数可以写成普通函数。
11 |
12 | **无效示例：**
13 |
14 | ```typescript
15 | function* f1() {
16 | return "f1";
17 | }
18 | ```
19 |
20 | **有效示例：**
21 |
22 | ```typescript
23 | function* f1() {
24 | yield "f1";
25 | }
26 |
27 | // 允许空的生成器函数
28 | function* f2() {}
29 |
30 | function f3() {
31 | return "f3";
32 | }
33 | ```
34 |
--------------------------------------------------------------------------------
/lint/rules/single-var-declarator.md:
--------------------------------------------------------------------------------
1 | ---
2 | tags: []
3 | ---
4 |
5 | 禁止在同一声明语句中定义多个变量。
6 |
7 | **无效示例：**
8 |
9 | ```typescript
10 | const foo = 1, bar = "2";
11 | ```
12 |
13 | **有效示例：**
14 |
15 | ```typescript
16 | const foo = 1;
17 | const bar = "2";
18 | ```
19 |
--------------------------------------------------------------------------------
/lint/rules/triple-slash-reference.md:
--------------------------------------------------------------------------------
1 | ---
2 | tags: []
3 | ---
4 |
5 | 禁止使用某些三斜杠指令，推荐使用 ES6 风格的 import 声明。
6 |
7 | TypeScript 的 `///`
8 | 三斜杠引用是一种指示文件中可以使用另一个模块的类型的方式。通常不推荐使用三斜杠引用类型指令，而是推荐使用
9 | ECMAScript 模块导入。此规则报告
10 | `///
`、`///
` 或
11 | `///
` 指令的使用。
12 |
13 | **无效：**
14 |
15 | ```typescript
16 | ///
17 | import * as foo from "foo";
18 | ```
19 |
20 | **有效：**
21 |
22 | ```typescript
23 | import * as foo from "foo";
24 | ```
25 |
--------------------------------------------------------------------------------
/lint/rules/use-isnan.md:
--------------------------------------------------------------------------------
1 | ---
2 | tags: [recommended]
3 | ---
4 |
5 | 禁止与 `NaN` 进行比较。
6 |
7 | 由于 `NaN` 在 JavaScript 中是独一无二的，它不等于任何值，包括它自己，因此与
8 | `NaN` 进行比较的结果会令人困惑：
9 |
10 | - `NaN === NaN` 或 `NaN == NaN` 的值为 `false`
11 | - `NaN !== NaN` 或 `NaN != NaN` 的值为 `true`
12 |
13 | 因此，该规则要求你使用 `isNaN()` 或 `Number.isNaN()` 来判断某个值是否为 `NaN`。
14 |
15 | **无效示例：**
16 |
17 | ```typescript
18 | if (foo == NaN) {
19 | // ...
20 | }
21 |
22 | if (foo != NaN) {
23 | // ...
24 | }
25 |
26 | switch (NaN) {
27 | case foo:
28 | // ...
29 | }
30 |
31 | switch (foo) {
32 | case NaN:
33 | // ...
34 | }
35 | ```
36 |
37 | **有效示例：**
38 |
39 | ```typescript
40 | if (isNaN(foo)) {
41 | // ...
42 | }
43 |
44 | if (!isNaN(foo)) {
45 | // ...
46 | }
47 | ```
48 |
--------------------------------------------------------------------------------
/lint/rules/verbatim-module-syntax.md:
--------------------------------------------------------------------------------
1 | ---
2 | tags: [jsr]
3 | ---
4 |
5 | 强制将类型导入声明为类型导入。
6 |
7 | 此规则确保在启用 `verbatimModuleSyntax` TypeScript
8 | 编译器选项时代码能够正常工作。这对于分发 TypeScript
9 | 代码的库非常有用，以便在更多场景中工作。
10 |
11 | **无效示例：**
12 |
13 | ```typescript
14 | import { Person } from "./person.ts";
15 |
16 | const person: Person = {
17 | name: "David",
18 | };
19 | console.log(person);
20 | ```
21 |
22 | ```typescript
23 | import { output, Person } from "./person.ts";
24 |
25 | const person: Person = {
26 | name: "David",
27 | };
28 | output(person);
29 | ```
30 |
31 | **有效示例：**
32 |
33 | ```typescript
34 | import type { Person } from "./person.ts";
35 |
36 | const person: Person = {
37 | name: "David",
38 | };
39 | console.log(person);
40 | ```
41 |
42 | ```typescript
43 | import { output, type Person } from "./person.ts";
44 |
45 | const person: Person = {
46 | name: "David",
47 | };
48 | output(person);
49 | ```
50 |
--------------------------------------------------------------------------------
/lint_rules.client.ts:
--------------------------------------------------------------------------------
1 | const searchbar = document.getElementById("lint-rule-search");
2 |
3 | if (searchbar) {
4 | searchbar.addEventListener("input", (e) => {
5 | const query = e.currentTarget?.value;
6 |
7 | const allBoxes = document.querySelectorAll(".lint-rule-box");
8 |
9 | for (const box of allBoxes) {
10 | if (!box.id.includes(query)) {
11 | box.style.display = "none";
12 | } else {
13 | box.style.display = "block";
14 | }
15 | }
16 | });
17 | }
18 |
--------------------------------------------------------------------------------
/lume.ts:
--------------------------------------------------------------------------------
1 | import "lume/cli.ts";
2 |
--------------------------------------------------------------------------------
/markdown-it/codeblock-title.ts:
--------------------------------------------------------------------------------
1 | // deno-lint-ignore-file no-explicit-any
2 |
3 | export default function codeblockTitlePlugin(md: any) {
4 | const defaultRender = md.renderer.rules.fence;
5 |
6 | md.renderer.rules.fence = function (
7 | tokens: any[],
8 | idx: number,
9 | options,
10 | env,
11 | self,
12 | ) {
13 | const render = defaultRender(tokens, idx, options, env, self);
14 |
15 | const maybeTitle = (tokens[idx].info ?? "").match(/title="(.+?)"/)?.[1];
16 | if (maybeTitle) {
17 | return `
`;
18 | }
19 |
20 | return render;
21 | };
22 | }
23 |
--------------------------------------------------------------------------------
/markdown-it/replacer.ts:
--------------------------------------------------------------------------------
1 | // deno-lint-ignore-file no-explicit-any
2 | import REPLACEMENTS from "../replacements.json" with { type: "json" };
3 |
4 | export default function replacerPlugin(md: any) {
5 | md.core.ruler.before("inline", "replacer", (state) => {
6 | state.tokens.forEach((token) => {
7 | Object.entries(REPLACEMENTS).forEach(([key, value]) => {
8 | token.content = token.content.replace(
9 | new RegExp(`\\$${key}`, "g"),
10 | value,
11 | );
12 | });
13 | });
14 | });
15 | }
16 |
--------------------------------------------------------------------------------
/middleware/functionRoutes.ts:
--------------------------------------------------------------------------------
1 | import type { RequestHandler } from "lume/core/server.ts";
2 | import defaultRoutes from "./functions/routes.ts";
3 |
4 | export default function createRoutingMiddleware(
5 | routeObject: Record
= defaultRoutes,
6 | ) {
7 | return function functionRoutesMiddleware(
8 | req: Request,
9 | next: RequestHandler,
10 | ): Promise {
11 | const url = new URL(req.url);
12 | const route = routeObject[url.pathname];
13 | return route ? route(req) : next(req);
14 | };
15 | }
16 |
--------------------------------------------------------------------------------
/middleware/functions/feedback_test.ts:
--------------------------------------------------------------------------------
1 | import { loadSync } from "@std/dotenv";
2 | loadSync({ export: true });
3 |
4 | import { assertEquals } from "@std/assert";
5 | import feedbackRequestHandler from "./feedback.ts";
6 |
7 | Deno.test("integration: can insert record into feedback google sheet", async () => {
8 | const request = new Request("http://localhost:8000/_api/send-feedback");
9 |
10 | const result = await feedbackRequestHandler(request);
11 |
12 | assertEquals(result.status, 200);
13 | });
14 |
--------------------------------------------------------------------------------
/middleware/functions/health.ts:
--------------------------------------------------------------------------------
1 | export default async function healthRequestHandler(
2 | _: Request,
3 | ): Promise {
4 | return new Response("OK", { status: 200 });
5 | }
6 |
--------------------------------------------------------------------------------
/middleware/functions/routes.ts:
--------------------------------------------------------------------------------
1 | import type { RequestHandler } from "lume/core/server.ts";
2 | import healthRequestHandler from "./health.ts";
3 | import feedbackRequestHandler from "./feedback.ts";
4 |
5 | export default {
6 | "/_api/health": healthRequestHandler,
7 | "/_api/send-feedback": feedbackRequestHandler,
8 | } satisfies Record;
9 |
--------------------------------------------------------------------------------
/middleware/null.ts:
--------------------------------------------------------------------------------
1 | import type { RequestHandler } from "lume/core/server.ts";
2 |
3 | export default function nullMiddleware(
4 | req: Request,
5 | next: RequestHandler,
6 | ): Promise {
7 | return next(req);
8 | }
9 |
--------------------------------------------------------------------------------
/prism.ts:
--------------------------------------------------------------------------------
1 | import Prism from "npm:prismjs@1.29.0";
2 | import "npm:prismjs@1.29.0/components/prism-typescript.js";
3 | import "npm:prismjs@1.29.0/components/prism-diff.js";
4 | import "npm:prismjs@1.29.0/components/prism-json.js";
5 | import "npm:prismjs@1.29.0/components/prism-bash.js";
6 | import "npm:prismjs@1.29.0/components/prism-json5.js";
7 | import "npm:prismjs@1.29.0/components/prism-jsx.js";
8 | import "npm:prismjs@1.29.0/components/prism-tsx.js";
9 |
10 | Prism.languages.jsonc = Prism.languages.json5;
11 |
12 | export default Prism;
13 |
--------------------------------------------------------------------------------
/reference/_components/Anchor.tsx:
--------------------------------------------------------------------------------
1 | import type { AnchorCtx } from "@deno/doc";
2 |
3 | export default function ({ anchor }: { anchor: AnchorCtx }) {
4 | return (
5 |
11 | #
12 |
13 | );
14 | }
15 |
--------------------------------------------------------------------------------
/reference/_components/Arrow.tsx:
--------------------------------------------------------------------------------
1 | export default function () {
2 | return (
3 |
17 | );
18 | }
19 |
--------------------------------------------------------------------------------
/reference/_components/Check.tsx:
--------------------------------------------------------------------------------
1 | export default function () {
2 | return (
3 |
18 | );
19 | }
20 |
--------------------------------------------------------------------------------
/reference/_components/Copy.tsx:
--------------------------------------------------------------------------------
1 | export default function () {
2 | return (
3 |
18 | );
19 | }
20 |
--------------------------------------------------------------------------------
/reference/_components/Deprecated.tsx:
--------------------------------------------------------------------------------
1 | export default function ({ markdownContent }) {
2 | if (markdownContent === null) {
3 | return null;
4 | }
5 |
6 | return (
7 |
8 |
9 | 已弃用
10 |
11 |
12 | {/*markdown rendering*/}
13 | {markdownContent && (
14 |
15 | )}
16 |
8 | extends{" "}
9 | {subtitle.extends.map((item, i) => (
10 | <>
11 |
12 | {/*typedef rendering*/}
13 | {i > 1 && ,{" "}}
14 |
15 | ))}
16 |
17 | );
18 | }
19 |
--------------------------------------------------------------------------------
/reference/_components/DocNodeKindIcon.tsx:
--------------------------------------------------------------------------------
1 | import type { DocNodeKindCtx } from "@deno/doc";
2 |
3 | export default function ({ kinds }: { kinds: DocNodeKindCtx[] }) {
4 | return (
5 |
6 | {kinds.map((item, index) => (
7 |
12 | {item.char}
13 |
14 | ))}
15 |
8 |
9 |
10 | {/*markdown rendering; usually not markdown but just a string, but some cases might be markdown (ie the title contains inline-code)*/}
11 |
12 | {/*markdown rendering*/}
13 |
14 |
8 |
9 | {indexSignature.readonly && readonly}
10 | {/* param rendering */}
11 | [
12 | ]
13 | {/* typedef rendering */}
14 |
15 |
16 | );
17 | }
18 |
--------------------------------------------------------------------------------
/reference/_components/ModuleDoc.tsx:
--------------------------------------------------------------------------------
1 | import type { ModuleDocCtx } from "@deno/doc";
2 |
3 | export default function (
4 | { comp, moduleDoc }: { comp: any; moduleDoc: ModuleDocCtx },
5 | ) {
6 | return (
7 |
8 |
9 | {moduleDoc.deprecated && (
10 |
11 | )}
12 |
13 |
14 |
15 | );
16 | }
17 |
--------------------------------------------------------------------------------
/reference/_components/RefNav.tsx:
--------------------------------------------------------------------------------
1 | export default function (data: Lume.Data, url: string) {
2 | return (
3 |
32 | );
33 | }
34 |
--------------------------------------------------------------------------------
/reference/_components/Section.css:
--------------------------------------------------------------------------------
1 | h1.ref-h1 {
2 | font-size: 1.6rem;
3 | border: 0;
4 | padding: 0;
5 | }
6 |
7 | code.inline-code-block {
8 | display: inline-block;
9 | margin-bottom: 1rem;
10 | padding: 1rem;
11 | }
12 |
13 | hr.hr {
14 | height: 1px;
15 | }
16 |
17 | .anchorable-heading .context-link {
18 | color: hsl(var(--foreground-primary));
19 | }
20 |
--------------------------------------------------------------------------------
/reference/_components/See.tsx:
--------------------------------------------------------------------------------
1 | export default function ({ sees }: { sees: string[] }) {
2 | return (
3 |
4 | {/*markdown rendering*/}
5 | {sees.map((see) => )}
6 |
7 | );
8 | }
9 |
--------------------------------------------------------------------------------
/reference/_components/SymbolContent.tsx:
--------------------------------------------------------------------------------
1 | import type { SymbolContentCtx } from "@deno/doc";
2 |
3 | export default function (
4 | { symbolContent, comp }: { comp: any; symbolContent: SymbolContentCtx },
5 | ) {
6 | return (
7 |
8 | {/*markdown rendering*/}
9 | {symbolContent.docs && (
10 |
11 | )}
12 |
13 | {symbolContent.sections.map((section) => (
14 |
15 | ))}
16 |
10 |
Usage in Deno
11 |
12 | {/*markdown rendering*/}
13 |
14 |