@mirascript/help 0.1.53 → 0.1.54

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/index.js +2 -2
  2. package/package.json +1 -1
package/dist/index.js CHANGED
@@ -11,7 +11,7 @@ export const KEYWORDS = Object.freeze({
11
11
  "false": "`false` 是布尔字面量,表示逻辑假。\n",
12
12
  "fn": "使用 `fn` 关键字定义一个函数或函数表达式。\n\n---\n\n定义一个简单的函数:\n\n```mira\nfn add(a, b) {\n return a + b;\n}\n```\n\n---\n\n定义一个变量,并使用函数表达式初始化:\n\n```mira\nlet multiply = fn (x, y) {\n return x * y;\n};\n```\n\n---\n\n当函数只有一个参数时,可以省略括号,并用 `it` 引用该参数。\n\n```mira\nfn square {\n return it * it;\n}\n```\n",
13
13
  "for": "`for` 用于遍历可迭代对象。\n\n---\n\n遍历一个范围:\n\n```mira\nlet mut sum = 0;\nfor i in 1..3 { // 或者 1..<4\n sum += i;\n}\n// sum == 6\n```\n\n---\n\n遍历一个数组:\n\n```mira\nlet arr = [10, 20, 30];\nlet mut sum = 0;\nfor value in arr {\n sum += value;\n}\n// sum == 60\n```\n\n---\n\n遍历一个记录:\n\n```mira\nlet record = (a: 1, b: 2, c: 3);\nlet mut sum = 0;\nfor key in record {\n sum += record[key];\n}\n// sum == 6\n```\n",
14
- "global": "`global` 关键字用于读取全局变量或判断某个全局变量是否存在。\n\n---\n\n当变量名与局部变量冲突时,可以使用 `global` 关键字来访问全局变量。\n\n```mira\nlet some_name = 'shadow';\nsome_name; // 访问局部变量 'some_name'\nglobal.some_name; // 访问全局变量 'some_name'\n```\n\n---\n\n动态判断和访问全局变量:\n\n```mira\nfn get_global(name, fallback) {\n if name in global {\n global[name]\n } else {\n fallback\n }\n}\n```\n",
14
+ "global": "`global` 关键字用于读取全局变量或判断某个全局变量是否存在。\n\n---\n\n当变量名与局部变量或关键字冲突时,可以使用 `global` 关键字来访问全局变量。\n\n```mira\nlet some_name = 'shadow';\nsome_name; // 访问局部变量 'some_name'\nglobal.some_name; // 访问全局变量 'some_name'\nglobal.if; // 访问全局变量 'if',而不是关键字 'if'\n```\n\n---\n\n动态判断和访问全局变量:\n\n```mira\nfn get_global(name, fallback) {\n if name in global {\n global[name]\n } else {\n fallback\n }\n}\n```\n",
15
15
  "if": "`if` 用于 `if` 表达式或 `match` 表达式的守卫条件。\n\n---\n\n`if` 表达式根据条件选择分支。条件必须是 `boolean`。\n\n```mira\nlet x = if 1 > 0 { \"pos\" } else { \"neg\" };\n```\n\n---\n\n使用 `else if` 添加多个条件分支:\n\n```mira\nlet x = if 1 > 2 {\n \"greater\"\n} else if 1 == 2 {\n \"equal\"\n} else {\n \"less\"\n};\n```\n\n---\n\n在 `match` 表达式中使用 `if` 作为守卫条件:\n\n```mira\nlet num = 10;\nlet result = match num {\n case n if n % 2 == 0 { \"even\" }\n case n { \"odd\" }\n};\n// result 的值是 \"even\"\n```\n",
16
16
  "in": "`in` 用于“包含/存在”判断,以及 `for` 循环。\n\n---\n\n对于 `array` 类型,`in` 用于判断某个元素是否在数组中存在:\n\n```mira\nfn is_spring(month) {\n month in [3, 4, 5]\n}\n```\n\n---\n\n对于 `record` / `module` / `extern` 类型,`in` 用于判断某个键是否在容器中存在:\n\n```mira\nlet record = (a: 1, b: 2, c: 3);\nlet a_exists = 'a' in record; // true\n```\n\n---\n\n也可与 `global` 关键字结合使用,判断全局变量是否存在:\n\n```mira\nif 'my_global' in global {\n debug_print('my_global exists');\n}\n```\n\n---\n\n同时,`for` 循环也使用 `in`:\n\n```mira\nfor i in 1..3 {\n // i: 1, 2, 3\n}\n```\n",
17
17
  "inf": "`inf` 是正无穷大的 `number` 常量。\n\n```mira\ninf > 1e100; // true\n-inf < 0; // true\n```\n",
@@ -28,7 +28,7 @@ export const KEYWORDS = Object.freeze({
28
28
  "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",
29
29
  "return": "`return` 用于从函数中返回值。\n\n```mira\nfn abs {\n if it < 0 { return -it; }\n return it;\n}\n```\n",
30
30
  "true": "`true` 是布尔字面量,表示逻辑真。\n",
31
- "type": "`type` 用于获得值的类型名字符串。\n\n```mira\ntype(1) // \"number\"\n```\n\n```mira\nnil::type() // \"nil\"(扩展调用写法)\n```\n",
31
+ "type": "`type` 用于获得值的类型名字符串。\n\n```mira\ntype(1) // \"number\"\n```\n\n```mira\nnil::type() // \"nil\"(扩展调用写法)\n```\n\n---\n\n`type` 是非保留关键字,因此可以作为标识符使用。\n\n```mira\nlet type = fn { 1 }; // 不支持 fn type { .. }\ntype!() // 1 (通过添加 ! 避免与 type 关键字混淆)\n```\n",
32
32
  "_": "`_` 是弃元关键字,用于在模式匹配中匹配并忽略任意值。\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",
33
33
  "while": "`while` 循环在条件为 `true` 时重复执行循环体。\n\n```mira\nlet mut i = 0;\nwhile i < 3 {\n i += 1;\n}\n```\n",
34
34
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mirascript/help",
3
- "version": "0.1.53",
3
+ "version": "0.1.54",
4
4
  "author": "CloudPSS",
5
5
  "license": "MIT",
6
6
  "description": "Help documentation for Mirascript core language.",