@mirascript/help 0.1.50 → 0.1.51

package/dist/index.js

@@ -28,53 +28,53 @@ export const KEYWORDS = Object.freeze({
   "pub": "`pub` 用于将模块内的声明导出。\n\n```mira\nmod counter {\n  pub let mut value = 0;\n  pub fn inc(){\n    value += 1;\n  }\n}\n\ndebug_print(counter.value); // 0\ncounter.inc();\ndebug_print(counter.value); // 1\n```\n",
   "return": "`return` 用于从函数中返回值。\n\n```mira\nfn abs {\n  if it < 0 { return -it; }\n  return it;\n}\n```\n",
   "true": "`true` 是布尔字面量，表示逻辑真。\n",
-  "type": "`type` 用于获得值的类型名字符串。\n\n```mira\ntype(1);       // \"number\"\nnil::type();   // \"nil\"（扩展调用写法）\n```\n",
+  "type": "`type` 用于获得值的类型名字符串。\n\n```mira\ntype(1)       // \"number\"\n```\n\n```mira\nnil::type()   // \"nil\"（扩展调用写法）\n```\n",
   "_": "`_` 是弃元关键字，用于在模式匹配中匹配并忽略任意值。\n\n```mira\nlet (_, y) = (1, 2); // y == 2\n\nfn head {\n  match it {\n    case [x, ..] { x }\n    case _ { nil }\n  }\n}\n```\n",
   "while": "`while` 循环在条件为 `true` 时重复执行循环体。\n\n```mira\nlet mut i = 0;\nwhile i < 3 {\n  i += 1;\n}\n```\n",
 });
 export const OPERATORS = Object.freeze({
   __proto__: null,
   "=": "`=` 用于赋值。\n\n---\n\n声明时初始化：\n\n```mira\nlet x = 1;\nconst @y = 2;\n```\n\n---\n\n对可变变量/可写字段赋值：\n\n```mira\nlet mut x = 1;\nx = x + 1;\n```\n",
-  "*": "`*` 用于乘法。\n\n```mira\n2 * 3; // 6\n```\n",
+  "*": "`*` 用于乘法。\n\n```mira\n2 * 3 // 6\n```\n",
   "*=": "`*=` 是复合赋值，`x *= y` 等价于 `x = x * y`。\n\n```mira\nlet mut x = 2;\nx *= 3;\n// x == 6\n```\n",
   "{": "`{ }` 用于表达式块或 JSON 风格记录字面量。\n\n---\n\n表达式块：\n\n```mira\nlet x = { 1 + 2 };\n```\n\n---\n\n在 JSON 风格记录字面量中，键名必须使用引号括起来：\n\n```mira\nlet obj = { \"x\": 1, \"y\": 2, \"n\": nil };\n```\n\n注意：\n\n- JSON 风格记录字面量不能为空，要声明一个空记录，请用 `()`；\n- 键和值仍为 MiraScript 表达式，因此需要使用 `nil` 来表示空值，而不是 `null`。\n",
   "}": "`{ }` 用于表达式块或 JSON 风格记录字面量。\n\n---\n\n表达式块：\n\n```mira\nlet x = { 1 + 2 };\n```\n\n---\n\n在 JSON 风格记录字面量中，键名必须使用引号括起来：\n\n```mira\nlet obj = { \"x\": 1, \"y\": 2, \"n\": nil };\n```\n\n注意：\n\n- JSON 风格记录字面量不能为空，要声明一个空记录，请用 `()`；\n- 键和值仍为 MiraScript 表达式，因此需要使用 `nil` 来表示空值，而不是 `null`。\n",
   "[": "`[ ]` 用于数组字面量、索引访问与切片。\n\n---\n\n数组字面量：\n\n```mira\nlet arr = [1, 2, 3];\n```\n\n---\n\n索引访问：\n\n```mira\nlet first = arr[0];\nlet last = arr[-1];\nlet value = record[\"key\"];\n```\n\n---\n\n数组切片：\n\n```mira\nlet subarr1 = arr[0..1];   // 取前两个元素\nlet subarr2 = arr[..<-1];  // 取到倒数第一个元素（不含）\n```\n",
   "]": "`[ ]` 用于数组字面量、索引访问与切片。\n\n---\n\n数组字面量：\n\n```mira\nlet arr = [1, 2, 3];\n```\n\n---\n\n索引访问：\n\n```mira\nlet first = arr[0];\nlet last = arr[-1];\nlet value = record[\"key\"];\n```\n\n---\n\n数组切片：\n\n```mira\nlet subarr1 = arr[0..1];   // 取前两个元素\nlet subarr2 = arr[..<-1];  // 取到倒数第一个元素（不含）\n```\n",
-  "^": "`^` 用于乘方，结合性为从右到左。\n\n```mira\n2 ^ 3;     // 8\n2 ^ 3 ^ 2; // 2^(3^2)\n```\n",
+  "^": "`^` 用于乘方，结合性为从右到左。\n\n```mira\n2^3   // 8\n```\n\n```mira\n2^3^2 // 2^(3^2)\n```\n",
   "^=": "`^=` 是复合赋值，`x ^= y` 等价于 `x = x ^ y`。\n\n```mira\nlet mut x = 2;\nx ^= 3;\n// x == 8\n```\n",
   ":": "`:` 用于记录字面量、条件表达式和插值格式。\n\n---\n\n在记录字面量中，`:` 用于分隔字段名和字段值。\n\n```mira\nlet r = (x: 1, y: 2);\n```\n\n---\n\n在条件表达式中，`:` 用于分隔条件的不同分支。\n\n```mira\nlet status = score >= 60 ? \"及格\" : \"不及格\";\n```\n\n---\n\n在插值格式中，`:` 用于指定格式化选项。在指定格式化选项时，必须使用圆括号 `$(expr:format)`。\n\n```mira\ndebug_print(\"π 的值约为 $(PI:.2)\"); // 输出: π 的值约为 3.14\n```\n",
-  "::": "`::` 用于扩展调用。\n\n```mira\n\"Hello\"::chars()::join(\"\");\n// 相当于 join(chars(\"Hello\"), \"\");\n```\n",
+  "::": "`::` 用于扩展调用。\n\n```mira\n\"Hello\"::chars()::join(\"|\")\n// 相当于 join(chars(\"Hello\"), \"\");\n```\n",
   ",": "`,` 用于分隔参数、数组元素、记录字段等。\n\n```mira\nlet arr = [1, 2, 3];\nlet r = (a: 1, b: 2);\n\nfn f(a, b, c) { a + b + c }\nf(1, 2, 3);\n```\n",
   ".": "`.` 用于成员访问。\n\n```mira\nlet r = (a: 1);\nr.a; // 1\nr.b; // nil\n\nlet arr = [10, 20];\narr.0; // 10\narr.2; // nil\n```\n",
-  "==": "使用 `==` 运算符可以比较两个值是否严格相等。\n\n---\n\n对于原始值，如果它们的类型和值都相同，则认为它们相等。\n\n```mira\n5 == 5;            // true\n\"hello\" == \"hello\"; // true\ntrue == true;      // true\n5 == \"5\";         // false\n```\n\n特别地，对于 `number` 类型的值 `nan`，它与任何值都不相等，包括它自己。\n\n```mira\nnan == nan; // false\n```\n\n---\n\n对于 `array` 和 `record`，只有他们的元素和属性都相等时，才认为它们相等。\n\n```mira\n[1, 2, 3] == [1, 2, 3]; // true\n(a: 1, b: 2) == (a: 1, b: 2); // true\n[1, 2, 3] == [1, 2, 4]; // false\n```\n\n---\n\n对于 `function` `module` 和 `extern`，只有它们引用的是同一个对象时，才认为它们相等。\n\n```mira\nlet fn1 = fn() { return 1; };\nlet fn2 = fn() { return 1; };\nfn1 == fn1; // true\nfn1 == fn2; // false\n```\n",
+  "==": "使用 `==` 运算符可以比较两个值是否严格相等。\n\n---\n\n对于原始值，如果它们的类型和值都相同，则认为它们相等。\n\n```mira\n5 == 5             // true\n```\n\n```mira\n\"hello\" == \"hello\" // true\n```\n\n```mira\ntrue == true       // true\n```\n\n```mira\n5 == \"5\"           // false\n```\n\n特别地，对于 `number` 类型的值 `nan`，它与任何值都不相等，包括它自己。\n\n```mira\nnan == nan // false\n```\n\n---\n\n对于 `array` 和 `record`，只有他们的元素和属性都相等时，才认为它们相等。\n\n```mira\n[1, 2, 3] == [1, 2, 3]       // true\n```\n\n```mira\n(a: 1, b: 2) == (a: 1, b: 2) // true\n```\n\n```mira\n[1, 2, 3] == [1, 2, 4]       // false\n```\n\n---\n\n对于 `function` `module` 和 `extern`，只有它们引用的是同一个对象时，才认为它们相等。\n\n```mira\nlet fn1 = fn() { return 1; };\nlet fn2 = fn() { return 1; };\n(fn1 == fn1, fn1 == fn2) // (true, false)\n```\n",
   "!": "`!` 既可以作为前缀逻辑非，也可以作为后缀非空断言。\n\n---\n\n逻辑非：\n\n```mira\n!x; // x 必须是 boolean\n```\n\n---\n\n非空断言：\n\n```mira\nlet x = nil;\nx!; // panic\n```\n",
-  ">": "`>` 用于“大于”比较。\n\n```mira\n2 > 1;     // true\n\"b\" > \"a\"; // true\n```\n",
-  ">=": "`>=` 用于“大于等于”比较。\n\n```mira\n2 >= 2; // true\n```\n",
-  "..<": "`..<` 表示右开区间范围，包含起点，不包含终点。\n\n```mira\n[1..<3]; // [1, 2]\n\nlet arr = [10, 20, 30, 40];\narr[1..<3]; // [20, 30]\n```\n",
-  "<": "`<` 用于“小于”比较。\n\n```mira\n1 < 2; // true\n```\n",
-  "<=": "`<=` 用于“小于等于”比较。\n\n```mira\n2 <= 2; // true\n```\n",
-  "&&": "`&&` 是短路逻辑与，操作数必须是 `boolean`。\n\n```mira\nfalse && (1 / 0); // 右侧不会被求值\n```\n",
+  ">": "`>` 用于“大于”比较。\n\n```mira\n2 > 1     // true\n```\n\n```mira\n\"b\" > \"a\" // true\n```\n",
+  ">=": "`>=` 用于“大于等于”比较。\n\n```mira\n2 >= 2 // true\n```\n",
+  "..<": "`..<` 表示右开区间范围，包含起点，不包含终点。\n\n```mira\n[1..<3] // [1, 2]\n```\n\n```mira\nlet arr = [10, 20, 30, 40];\narr[1..<3] // [20, 30]\n```\n",
+  "<": "`<` 用于“小于”比较。\n\n```mira\n1 < 2 // true\n```\n",
+  "<=": "`<=` 用于“小于等于”比较。\n\n```mira\n2 <= 2 // true\n```\n",
+  "&&": "`&&` 是短路逻辑与，操作数必须是 `boolean`。\n\n```mira\nfalse && (1 / 0) // 右侧不会被求值\n```\n",
   "&&=": "`&&=` 是短路复合赋值，只有当左侧为 `true` 时才会计算并赋值右侧。\n\n```mira\nlet mut b = true;\nb &&= false;\n// b == false\n```\n",
-  "||": "`||` 是短路逻辑或，操作数必须是 `boolean`。\n\n```mira\ntrue || (1 / 0); // 右侧不会被求值\n```\n",
+  "||": "`||` 是短路逻辑或，操作数必须是 `boolean`。\n\n```mira\ntrue || (1 / 0) // 右侧不会被求值\n```\n",
   "||=": "`||=` 是短路复合赋值，只有当左侧为 `false` 时才会计算并赋值右侧。\n\n```mira\nlet mut b = false;\nb ||= true;\n// b == true\n```\n",
-  "-": "`-` 用于减法（中缀）或一元负号（前缀）。\n\n```mira\n5 - 2; // 3\n-1;    // -1\n```\n",
+  "-": "`-` 用于减法（中缀）或一元负号（前缀）。\n\n```mira\n5 - 2 // 3\n```\n\n```mira\n-1    // -1\n```\n",
   "-=": "`-=` 是复合赋值，`x -= y` 等价于 `x = x - y`。\n\n```mira\nlet mut x = 3;\nx -= 1;\n// x == 2\n```\n",
-  "!=": "`!=` 判断两个值是否不相等，等价于 `!(x == y)`。\n\n```mira\n1 != 2; // true\n1 != 1; // false\n```\n",
-  "??": "`??` 是空合并，当左侧为 `nil` 时返回右侧，否则返回左侧。\n\n```mira\nnil ?? 1; // 1\n0 ?? 1;   // 0\n```\n",
+  "!=": "`!=` 判断两个值是否不相等，等价于 `!(x == y)`。\n\n```mira\n1 != 2 // true\n```\n\n```mira\n1 != 1 // false\n```\n",
+  "??": "`??` 是空合并，当左侧为 `nil` 时返回右侧，否则返回左侧。\n\n```mira\nnil ?? 1 // 1\n```\n\n```mira\n0 ?? 1   // 0\n```\n",
   "??=": "`??=` 是空合并复合赋值，仅当左侧为 `nil` 时才会赋值右侧。\n\n```mira\nlet mut n = nil;\nn ??= 5;\n// n == 5\n\nn ??= 10;\n// n 仍然是 5\n```\n",
-  "(": "`( )` 用于分组表达式、函数调用参数列表，以及记录字面量。\n\n---\n\n分组表达式，控制计算顺序：\n\n```mira\nlet result = (1 + 2) * 3; // 先计算 1 + 2，然后乘以 3\n```\n\n---\n\n函数声明和调用：\n\n```mira\nfn add(a, b) { a + b }\nlet sum = add(1, 2);\n```\n\n---\n\n记录字面量：\n\n```mira\nlet record = (a: 1, b: 2);\nlet empty = (); // 空记录\n```\n\n---\n\n对于省略键名的单元素记录，必须添加逗号以区别于分组表达式。\n\n```mira\nlet single = (1,);\n```\n",
-  ")": "`( )` 用于分组表达式、函数调用参数列表，以及记录字面量。\n\n---\n\n分组表达式，控制计算顺序：\n\n```mira\nlet result = (1 + 2) * 3; // 先计算 1 + 2，然后乘以 3\n```\n\n---\n\n函数声明和调用：\n\n```mira\nfn add(a, b) { a + b }\nlet sum = add(1, 2);\n```\n\n---\n\n记录字面量：\n\n```mira\nlet record = (a: 1, b: 2);\nlet empty = (); // 空记录\n```\n\n---\n\n对于省略键名的单元素记录，必须添加逗号以区别于分组表达式。\n\n```mira\nlet single = (1,);\n```\n",
-  "%": "`%` 用于取余。\n\n```mira\n5 % 2; // 1\n```\n",
+  "(": "`( )` 用于分组表达式、函数调用参数列表，以及记录字面量。\n\n---\n\n分组表达式，控制计算顺序：\n\n```mira\n(1 + 2) * 3 // 先计算 1 + 2，然后乘以 3\n```\n\n---\n\n函数声明和调用：\n\n```mira\nfn add(a, b) { a + b }\nadd(1, 2)\n```\n\n---\n\n记录字面量：\n\n```mira\nlet record = (a: 1, b: 2);\nlet empty = (); // 空记录\n```\n\n---\n\n对于省略键名的单元素记录，必须添加逗号以区别于分组表达式。\n\n```mira\nlet single = (1,);\n```\n",
+  ")": "`( )` 用于分组表达式、函数调用参数列表，以及记录字面量。\n\n---\n\n分组表达式，控制计算顺序：\n\n```mira\n(1 + 2) * 3 // 先计算 1 + 2，然后乘以 3\n```\n\n---\n\n函数声明和调用：\n\n```mira\nfn add(a, b) { a + b }\nadd(1, 2)\n```\n\n---\n\n记录字面量：\n\n```mira\nlet record = (a: 1, b: 2);\nlet empty = (); // 空记录\n```\n\n---\n\n对于省略键名的单元素记录，必须添加逗号以区别于分组表达式。\n\n```mira\nlet single = (1,);\n```\n",
+  "%": "`%` 用于取余。\n\n```mira\n5 % 2 // 1\n```\n",
   "%=": "`%=` 是复合赋值：`x %= y` 等价于 `x = x % y`。\n\n```mira\nlet mut x = 5;\nx %= 2;\n// x == 1\n```\n",
-  "+": "`+` 用于加法（中缀）或一元正号（前缀）。\n\n```mira\n1 + 2; // 3\n+1;    // 1\n```\n",
+  "+": "`+` 用于加法（中缀）或一元正号（前缀）。\n\n```mira\n1 + 2 // 3\n```\n\n```mira\n+1    // 1\n```\n",
   "+=": "`+=` 是复合赋值，`x += y` 等价于 `x = x + y`。\n\n```mira\nlet mut x = 1;\nx += 2;\n// x == 3\n```\n",
   "?": "`?` 用于条件表达式（三元表达式）：`cond ? thenExpr : elseExpr`。\n\n```mira\nfn sign { it > 0 ? 1 : it < 0 ? -1 : 0 }\n```\n",
-  "?:": "`?:` 用于记录字面量的“可选字段”，当值为 `nil` 时省略该字段。\n\n```mira\n(a?: 1, b?: nil); // (a: 1)\n\n// 省略不会删除已经通过展开引入的同名字段\n(..(a: 1), a?: nil); // (a: 1)\n```\n",
+  "?:": "`?:` 用于记录字面量的“可选字段”，当值为 `nil` 时省略该字段。\n\n```mira\n(a?: 1, b?: nil) // (a: 1)\n```\n\n```mira\n// 省略不会删除已经通过展开引入的同名字段\n(..(a: 1), a?: nil) // (a: 1)\n```\n",
   ";": "`;` 用于结束语句。MiraScript 以表达式为主，但在多语句块中使用 `;` 分隔。\n\n```mira\nlet sum = {\n  let x = 1;\n  let y = 2;\n  x + y\n};\n```\n",
-  "/": "`/` 用于除法。\n\n```mira\n6 / 3; // 2\n```\n",
+  "/": "`/` 用于除法。\n\n```mira\n6 / 3 // 2\n```\n",
   "/=": "`/=` 是复合赋值，`x /= y` 等价于 `x = x / y`。\n\n```mira\nlet mut x = 6;\nx /= 3;\n// x == 2\n```\n",
-  "..": "`..` 表示闭区间范围，或在数组/记录字面量及函数调用中表示展开。\n\n---\n\n表示数组字面量、切片和循环的范围：\n\n```mira\nlet arr = [1..3]; // arr = [1, 2, 3]\nlet slice = arr[0..1]; // slice = [1, 2]\n\nfor i in 1..3 {\n  // i 依次为 1, 2, 3\n}\n```\n\n---\n\n展开数组/记录或函数调用：\n\n```mira\nlet arr = [1, ..[2, 3]]; // arr = [1, 2, 3]\nlet rec1 = (a: 1, ..(b: 2, c: 3)); // rec1 = (a: 1, b: 2, c: 3)\n// 同名键以最后一个为准\nlet rec2 = (..(1, 2), ..(3, 4, 5)); // rec2 = (0: 3, 1: 4, 2: 5)\n\nlet result = sum(..[1, 2, 3]); // 等同于 sum(1, 2, 3)\n```\n",
-  "=~": "`=~` 是“近似相等”，用于数值容差比较和字符串归一化比较。\n\n---\n\n对于 `number` 类型，当两个操作数的相对误差**或**绝对误差小于 `1e-15` 时，返回 `true`，否则返回 `false`。\n\n如果其中一个操作数为 `number` 类型，另一个操作数在比较前也会自动转换为 `number` 类型。\n\n```mira\n0.1 + 0.2 =~ 0.3; // true\n1 =~ \"1\";        // true\n```\n\n---\n\n对于 `string` 类型，`=~` 运算符进行大小写不敏感的[正规化（NFC）](https://unicode.org/reports/tr15/)比较。\n\n```mira\n\"café\" =~ \"CAFÉ\"; // true\n```\n",
-  "!~": "`!~` 是 `=~` 的否定形式（不近似相等）。\n\n```mira\n1 !~ 2;     // true\n\"a\" !~ \"A\"; // false\n```\n",
+  "..": "`..` 表示闭区间范围，或在数组/记录字面量及函数调用中表示展开。\n\n---\n\n表示数组字面量、切片和循环的范围：\n\n```mira\nlet arr = [1..3]; // arr = [1, 2, 3]\narr[0..1]         // [1, 2]\n```\n\n```mira\nfor i in 1..3 {\n  // i 依次为 1, 2, 3\n  debug_print(i);\n}\n```\n\n---\n\n展开数组/记录或函数调用：\n\n```mira\n[1, ..[2, 3]] // [1, 2, 3]\n```\n\n```mira\n(a: 1, ..(b: 2, c: 3)) // (a: 1, b: 2, c: 3)\n```\n\n```mira\n// 同名键以最后一个为准\n(..(1, 2), ..(3, 4, 5)) // (0: 3, 1: 4, 2: 5)\n```\n\n```mira\nsum(..[1, 2, 3]) // 等同于 sum(1, 2, 3)\n```\n",
+  "=~": "`=~` 是“近似相等”，用于数值容差比较和字符串归一化比较。\n\n---\n\n对于 `number` 类型，当两个操作数的相对误差**或**绝对误差小于 `1e-15` 时，返回 `true`，否则返回 `false`。\n\n如果其中一个操作数为 `number` 类型，另一个操作数在比较前也会自动转换为 `number` 类型。\n\n```mira\n0.1 + 0.2 =~ 0.3 // true\n```\n\n```mira\n1 =~ \"1\"         // true\n```\n\n---\n\n对于 `string` 类型，`=~` 运算符进行大小写不敏感的[正规化（NFC）](https://unicode.org/reports/tr15/)比较。\n\n```mira\n\"café\" =~ \"CAFÉ\" // true\n```\n",
+  "!~": "`!~` 是 `=~` 的否定形式（不近似相等）。\n\n```mira\n1 !~ 2     // true\n```\n\n```mira\n\"a\" !~ \"A\" // false\n```\n",
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mirascript/help",
-  "version": "0.1.50",
+  "version": "0.1.51",
   "author": "CloudPSS",
   "license": "MIT",
   "description": "Help documentation for Mirascript core language.",