@mirascript/help 0.1.44 → 0.1.45

package/src/keyword/underscore.md

@@ -1,16 +0,0 @@
----
-token: '_'
----
-
-`_` 是弃元关键字，用于在模式匹配中匹配并忽略任意值。
-
-```mira
-let (_, y) = (1, 2); // y == 2
-
-fn head {
-  match it {
-    case [x, ..] { x }
-    case _ { nil }
-  }
-}
-```

package/src/keyword/use.md

@@ -1,6 +0,0 @@
----
-token: 'use'
-reserved: true
----
-
-`use` 是保留关键字。

package/src/keyword/where.md

@@ -1,6 +0,0 @@
----
-token: 'where'
-reserved: true
----
-
-`where` 是保留关键字。

package/src/keyword/while.md

@@ -1,12 +0,0 @@
----
-token: 'while'
----
-
-`while` 循环在条件为 `true` 时重复执行循环体。
-
-```mira
-let mut i = 0;
-while i < 3 {
-  i += 1;
-}
-```

package/src/operator/arrow.md

@@ -1,6 +0,0 @@
----
-token: '->'
-reserved: true
----
-
-`->` 用于在文档中标记函数的返回值类型，在 MiraScript 代码中不使用。

package/src/operator/assign.md

@@ -1,23 +0,0 @@
----
-token: '='
----
-
-`=` 用于赋值。
-
----
-
-声明时初始化：
-
-```mira
-let x = 1;
-const @y = 2;
-```
-
----
-
-对可变变量/可写字段赋值：
-
-```mira
-let mut x = 1;
-x = x + 1;
-```

package/src/operator/asterisk.md

@@ -1,9 +0,0 @@
----
-token: '*'
----
-
-`*` 用于乘法。
-
-```mira
-2 * 3; // 6
-```

package/src/operator/asterisk_assign.md

@@ -1,11 +0,0 @@
----
-token: '*='
----
-
-`*=` 是复合赋值，`x *= y` 等价于 `x = x * y`。
-
-```mira
-let mut x = 2;
-x *= 3;
-// x == 6
-```

package/src/operator/brace.md

@@ -1,26 +0,0 @@
----
-token: ['{', '}']
----
-
-`{ }` 用于表达式块或 JSON 风格记录字面量。
-
----
-
-表达式块：
-
-```mira
-let x = { 1 + 2 };
-```
-
----
-
-在 JSON 风格记录字面量中，键名必须使用引号括起来：
-
-```mira
-let obj = { "x": 1, "y": 2, "n": nil };
-```
-
-注意：
-
-- JSON 风格记录字面量不能为空，要声明一个空记录，请用 `()`；
-- 键和值仍为 MiraScript 表达式，因此需要使用 `nil` 来表示空值，而不是 `null`。

package/src/operator/bracket.md

@@ -1,32 +0,0 @@
----
-token: ['[', ']']
----
-
-`[ ]` 用于数组字面量、索引访问与切片。
-
----
-
-数组字面量：
-
-```mira
-let arr = [1, 2, 3];
-```
-
----
-
-索引访问：
-
-```mira
-let first = arr[0];
-let last = arr[-1];
-let value = record["key"];
-```
-
----
-
-数组切片：
-
-```mira
-let subarr1 = arr[0..1];   // 取前两个元素
-let subarr2 = arr[..<-1];  // 取到倒数第一个元素（不含）
-```

package/src/operator/caret.md

@@ -1,10 +0,0 @@
----
-token: '^'
----
-
-`^` 用于乘方，结合性为从右到左。
-
-```mira
-2 ^ 3;     // 8
-2 ^ 3 ^ 2; // 2^(3^2)
-```

package/src/operator/caret_assign.md

@@ -1,11 +0,0 @@
----
-token: '^='
----
-
-`^=` 是复合赋值，`x ^= y` 等价于 `x = x ^ y`。
-
-```mira
-let mut x = 2;
-x ^= 3;
-// x == 8
-```

package/src/operator/colon.md

@@ -1,29 +0,0 @@
----
-token: ':'
----
-
-`:` 用于记录字面量、条件表达式和插值格式。
-
----
-
-在记录字面量中，`:` 用于分隔字段名和字段值。
-
-```mira
-let r = (x: 1, y: 2);
-```
-
----
-
-在条件表达式中，`:` 用于分隔条件的不同分支。
-
-```mira
-let status = score >= 60 ? "及格" : "不及格";
-```
-
----
-
-在插值格式中，`:` 用于指定格式化选项。在指定格式化选项时，必须使用圆括号 `$(expr:format)`。
-
-```mira
-debug_print("π 的值约为 $(PI:.2)"); // 输出: π 的值约为 3.14
-```

package/src/operator/colon_colon.md

@@ -1,10 +0,0 @@
----
-token: '::'
----
-
-`::` 用于扩展调用。
-
-```mira
-"Hello"::chars()::join("");
-// 相当于 join(chars("Hello"), "");
-```

package/src/operator/comma.md

@@ -1,13 +0,0 @@
----
-token: ','
----
-
-`,` 用于分隔参数、数组元素、记录字段等。
-
-```mira
-let arr = [1, 2, 3];
-let r = (a: 1, b: 2);
-
-fn f(a, b, c) { a + b + c }
-f(1, 2, 3);
-```

package/src/operator/dot.md

@@ -1,15 +0,0 @@
----
-token: '.'
----
-
-`.` 用于成员访问。
-
-```mira
-let r = (a: 1);
-r.a; // 1
-r.b; // nil
-
-let arr = [10, 20];
-arr.0; // 10
-arr.2; // nil
-```

package/src/operator/equal.md

@@ -1,43 +0,0 @@
----
-token: '=='
----
-
-使用 `==` 运算符可以比较两个值是否严格相等。
-
----
-
-对于原始值，如果它们的类型和值都相同，则认为它们相等。
-
-```mira
-5 == 5;            // true
-"hello" == "hello"; // true
-true == true;      // true
-5 == "5";         // false
-```
-
-特别地，对于 `number` 类型的值 `nan`，它与任何值都不相等，包括它自己。
-
-```mira
-nan == nan; // false
-```
-
----
-
-对于 `array` 和 `record`，只有他们的元素和属性都相等时，才认为它们相等。
-
-```mira
-[1, 2, 3] == [1, 2, 3]; // true
-(a: 1, b: 2) == (a: 1, b: 2); // true
-[1, 2, 3] == [1, 2, 4]; // false
-```
-
----
-
-对于 `function` `module` 和 `extern`，只有它们引用的是同一个对象时，才认为它们相等。
-
-```mira
-let fn1 = fn() { return 1; };
-let fn2 = fn() { return 1; };
-fn1 == fn1; // true
-fn1 == fn2; // false
-```

package/src/operator/exclamation.md

@@ -1,23 +0,0 @@
----
-token: '!'
----
-
-`!` 既可以作为前缀逻辑非，也可以作为后缀非空断言。
-
----
-
-逻辑非：
-
-```mira
-!x // x 必须是 boolean
-```
-
----
-
-非空断言：
-
-```mira
-
-let x = nil;
-x!; // panic
-```

package/src/operator/greater.md

@@ -1,10 +0,0 @@
----
-token: '>'
----
-
-`>` 用于“大于”比较。
-
-```mira
-2 > 1;     // true
-"b" > "a"; // true
-```

package/src/operator/greater_equal.md

@@ -1,9 +0,0 @@
----
-token: '>='
----
-
-`>=` 用于“大于等于”比较。
-
-```mira
-2 >= 2; // true
-```

package/src/operator/half_open_range.md

@@ -1,12 +0,0 @@
----
-token: '..<'
----
-
-`..<` 表示右开区间范围，包含起点，不包含终点。
-
-```mira
-[1..<3]; // [1, 2]
-
-let arr = [10, 20, 30, 40];
-arr[1..<3]; // [20, 30]
-```

package/src/operator/less.md

@@ -1,9 +0,0 @@
----
-token: '<'
----
-
-`<` 用于“小于”比较。
-
-```mira
-1 < 2; // true
-```

package/src/operator/less_equal.md

@@ -1,9 +0,0 @@
----
-token: '<='
----
-
-`<=` 用于“小于等于”比较。
-
-```mira
-2 <= 2; // true
-```

package/src/operator/logical_and.md

@@ -1,9 +0,0 @@
----
-token: '&&'
----
-
-`&&` 是短路逻辑与，操作数必须是 `boolean`。
-
-```mira
-false && (1 / 0); // 右侧不会被求值
-```

package/src/operator/logical_and_assign.md

@@ -1,11 +0,0 @@
----
-token: '&&='
----
-
-`&&=` 是短路复合赋值，只有当左侧为 `true` 时才会计算并赋值右侧。
-
-```mira
-let mut b = true;
-b &&= false;
-// b == false
-```

package/src/operator/logical_or.md

@@ -1,9 +0,0 @@
----
-token: '||'
----
-
-`||` 是短路逻辑或，操作数必须是 `boolean`。
-
-```mira
-true || (1 / 0); // 右侧不会被求值
-```

package/src/operator/logical_or_assign.md

@@ -1,11 +0,0 @@
----
-token: '||='
----
-
-`||=` 是短路复合赋值，只有当左侧为 `false` 时才会计算并赋值右侧。
-
-```mira
-let mut b = false;
-b ||= true;
-// b == true
-```

package/src/operator/minus.md

@@ -1,10 +0,0 @@
----
-token: '-'
----
-
-`-` 用于减法（中缀）或一元负号（前缀）。
-
-```mira
-5 - 2; // 3
--1;    // -1
-```

package/src/operator/minus_assign.md

@@ -1,11 +0,0 @@
----
-token: '-='
----
-
-`-=` 是复合赋值，`x -= y` 等价于 `x = x - y`。
-
-```mira
-let mut x = 3;
-x -= 1;
-// x == 2
-```

package/src/operator/not_equal.md

@@ -1,10 +0,0 @@
----
-token: '!='
----
-
-`!=` 判断两个值是否不相等，等价于 `!(x == y)`。
-
-```mira
-1 != 2; // true
-1 != 1; // false
-```

package/src/operator/null_coalescing.md

@@ -1,10 +0,0 @@
----
-token: '??'
----
-
-`??` 是空合并，当左侧为 `nil` 时返回右侧，否则返回左侧。
-
-```mira
-nil ?? 1; // 1
-0 ?? 1;   // 0
-```

package/src/operator/null_coalescing_assign.md

@@ -1,14 +0,0 @@
----
-token: '??='
----
-
-`??=` 是空合并复合赋值，仅当左侧为 `nil` 时才会赋值右侧。
-
-```mira
-let mut n = nil;
-n ??= 5;
-// n == 5
-
-n ??= 10;
-// n 仍然是 5
-```

package/src/operator/paren.md

@@ -1,39 +0,0 @@
----
-token: ['(', ')']
----
-
-`( )` 用于分组表达式、函数调用参数列表，以及记录字面量。
-
----
-
-分组表达式，控制计算顺序：
-
-```mira
-let result = (1 + 2) * 3; // 先计算 1 + 2，然后乘以 3
-```
-
----
-
-函数声明和调用：
-
-```mira
-fn add(a, b) { a + b }
-let sum = add(1, 2);
-```
-
----
-
-记录字面量：
-
-```mira
-let record = (a: 1, b: 2);
-let empty = (); // 空记录
-```
-
----
-
-对于省略键名的单元素记录，必须添加逗号以区别于分组表达式。
-
-```mira
-let single = (1,)
-```

package/src/operator/percent.md

@@ -1,9 +0,0 @@
----
-token: '%'
----
-
-`%` 用于取余。
-
-```mira
-5 % 2; // 1
-```

package/src/operator/percent_assign.md

@@ -1,11 +0,0 @@
----
-token: '%='
----
-
-`%=` 是复合赋值：`x %= y` 等价于 `x = x % y`。
-
-```mira
-let mut x = 5;
-x %= 2;
-// x == 1
-```

package/src/operator/plus.md

@@ -1,10 +0,0 @@
----
-token: '+'
----
-
-`+` 用于加法（中缀）或一元正号（前缀）。
-
-```mira
-1 + 2; // 3
-+1;    // 1
-```

package/src/operator/plus_assign.md

@@ -1,11 +0,0 @@
----
-token: '+='
----
-
-`+=` 是复合赋值，`x += y` 等价于 `x = x + y`。
-
-```mira
-let mut x = 1;
-x += 2;
-// x == 3
-```

package/src/operator/question.md

@@ -1,9 +0,0 @@
----
-token: '?'
----
-
-`?` 用于条件表达式（三元表达式）：`cond ? thenExpr : elseExpr`。
-
-```mira
-fn sign { it > 0 ? 1 : it < 0 ? -1 : 0 }
-```

package/src/operator/question_colon.md

@@ -1,12 +0,0 @@
----
-token: '?:'
----
-
-`?:` 用于记录字面量的“可选字段”，当值为 `nil` 时省略该字段。
-
-```mira
-(a?: 1, b?: nil); // (a: 1)
-
-// 省略不会删除已经通过展开引入的同名字段
-(..(a: 1), a?: nil); // (a: 1)
-```

package/src/operator/semicolon.md

@@ -1,13 +0,0 @@
----
-token: ';'
----
-
-`;` 用于结束语句。MiraScript 以表达式为主，但在多语句块中常用 `;` 分隔。
-
-```mira
-let sum = {
-  let x = 1;
-  let y = 2;
-  x + y
-};
-```

package/src/operator/slash.md

@@ -1,9 +0,0 @@
----
-token: '/'
----
-
-`/` 用于除法。
-
-```mira
-6 / 3; // 2
-```

package/src/operator/slash_assign.md

@@ -1,11 +0,0 @@
----
-token: '/='
----
-
-`/=` 是复合赋值，`x /= y` 等价于 `x = x / y`。
-
-```mira
-let mut x = 6;
-x /= 3;
-// x == 2
-```

package/src/operator/spread_range.md

@@ -1,31 +0,0 @@
----
-token: '..'
----
-
-`..` 表示闭区间范围，或在数组/记录字面量及函数调用中表示展开。
-
----
-
-表示数组字面量、切片和循环的范围：
-
-```mira
-let arr = [1..3]; // arr = [1, 2, 3]
-let slice = arr[0..1]; // slice = [1, 2]
-
-for i in 1..3 {
-  // i 依次为 1, 2, 3
-}
-```
-
----
-
-展开数组/记录或函数调用：
-
-```mira
-let arr = [1, ..[2, 3]]; // arr = [1, 2, 3]
-let rec1 = (a: 1, ..(b: 2, c: 3)); // rec1 = (a: 1, b: 2, c: 3)
-// 同名键以最后一个为准
-let rec2 = (..(1, 2), ..(3, 4, 5)); // rec2 = (0: 3, 1: 4, 2: 5)
-
-let result = sum(..[1, 2, 3]); // 等同于 sum(1, 2, 3)
-```