language-mcfunction 项目教程

language-mcfunction 项目教程

language-mcfunctionSyntax highlighting for mcfunction files.项目地址:https://gitcode.com/gh_mirrors/la/language-mcfunction

1. 项目的目录结构及介绍

language-mcfunction/
├── README.md
├── package.json
├── syntaxes/
│   ├── mcfunction.tmLanguage.json
│   └── mcfunction.YAML-tmLanguage
├── snippets/
│   └── mcfunction.json
└── CHANGELOG.md

• README.md: 项目介绍和使用说明。
• package.json: 项目的元数据文件，包含依赖和脚本。
• syntaxes/: 包含语法高亮的定义文件。
  • mcfunction.tmLanguage.json: JSON格式的语法定义。
  • mcfunction.YAML-tmLanguage: YAML格式的语法定义。
• snippets/: 包含代码片段的定义文件。
  • mcfunction.json: mcfunction 文件的代码片段。
• CHANGELOG.md: 项目更新日志。

2. 项目的启动文件介绍

项目的启动文件主要是 package.json，其中包含了启动和构建项目的脚本。例如：

{
  "name": "language-mcfunction",
  "version": "1.0.0",
  "main": "index.js",
  "scripts": {
    "build": "node build.js",
    "test": "mocha"
  }
}

• name: 项目名称。
• version: 项目版本。
• main: 主入口文件。
• scripts: 包含构建和测试的脚本。

3. 项目的配置文件介绍

项目的配置文件主要位于 syntaxes/ 目录下，其中 mcfunction.tmLanguage.json 和 mcfunction.YAML-tmLanguage 定义了语法高亮的规则。

mcfunction.tmLanguage.json

{
  "name": "mcfunction",
  "scopeName": "source.mcfunction",
  "patterns": [
    {
      "include": "#command"
    },
    {
      "include": "#comment"
    }
  ],
  "repository": {
    "command": {
      "match": "\\b(say|give|kill)\\b",
      "name": "keyword.control.mcfunction"
    },
    "comment": {
      "match": "#.*",
      "name": "comment.line.number-sign.mcfunction"
    }
  }
}

• name: 语法名称。
• scopeName: 作用域名称。
• patterns: 包含命令和注释的匹配规则。
• repository: 包含具体的匹配规则和命名。

mcfunction.YAML-tmLanguage

name: mcfunction
scopeName: source.mcfunction
patterns:
  - include: '#command'
  - include: '#comment'
repository:
  command:
    match: \b(say|give|kill)\b
    name: keyword.control.mcfunction
  comment:
    match: #.*
    name: comment.line.number-sign.mcfunction

• name: 语法名称。
• scopeName: 作用域名称。
• patterns: 包含命令和注释的匹配规则。
• repository: 包含具体的匹配规则和命名。

以上是 language-mcfunction 项目的基本教程，涵盖了目录结构、启动文件和配置文件的介绍。

language-mcfunctionSyntax highlighting for mcfunction files.项目地址:https://gitcode.com/gh_mirrors/la/language-mcfunction