## 3、获取项目
使用```git clone```获取本项目后，不需要任何依赖的安装，也不需多余的安装步骤
## 4、使用方式
### (1) 在代码中使用
如果有在代码中使用```lexer```的需求（如网页中的代码编辑器：高亮、代码提示等），只引入一个```/package/{lang}-lexer.min.js```文件即可
然后直接访问```lexer```变量即可获取到词法分析器对象，其中```tokens```数据可以通过访问```lexer.DFA.result.tokens```获取
```js
// 1. 需要词法分析的代码
let stream = "int a = 10;";
// 2. 开始词法分析
lexer.start(strem);
// 3. 词法分析结束后, 获取生成的tokens
let parsedTokens = lexer.DFA.result.tokens;
// 4. 做你想做的
parsedTokens.forEach((token) => {
// ... ...
});
```
功能介绍中所描述的[记录状态流转信息](#23)，通过访问```flowModel.result.paths```即可获取到```lexer```内部状态机在每次状态流转时的详细信息，数据格式如下所示
```js
[
{
state: 0, // 当前状态
ch: "a", // 当前读入的字符
nextSstate: 2, // 下一个状态
match: true, // 是否匹配
end: false, // 是否是最后一个字符
},
// ... ...
]
```
### (2) 可视化预览与测试
为了实时查看```lexer```的工作效果，也方便对其进行开发测试，在项目根目录下有一个```index.html```文件，直接在浏览器中打开，输入代码后会自动输出经过```lexer```分析后生成的```Token```，如下图所演示
```c
int a = 10;
int b =20;
int c = 20;
float f = 928.2332;
char b = 'b';
if(a == b){
printf("Hello, World!");
}else if(b!=c){
printf("Hello, World! Hello, World!");
}else{
printf("Hello!");
}
```
或者请查看[线上网站](https://wgrape.github.io/lexer/)
## 5、参与贡献
### (1) 项目统计
> 了解帮助过项目此项目的平台或用户，请查看[特别鸣谢](#7)
截至2021年10月01日，此项目在1个月内获得的Clone操作共计约80次，访客量100人，访问量400次（数据会不断更新）。其中Star数量的增长过程如下：
### (2) 源码讲解
关于项目设计、单元测试、自动化测试、开发规范、以及如何接入不同语言的扩展等与源码开发相关的文档，请阅读[源码讲解](/doc/explain.md)部分
### (3) 贡献范围
- 提供更多新功能
- 提供更多语言的 ```/src/lang/{lang}-define.js```
此外，一切帮助项目变得更好的建议都欢迎讨论，交流渠道参考[问题交流](#55)部分
### (4) 版本发布
项目以版本号为```大更新-小更新-修复完善```的规则发布，关于版本的更新记录可以查看项目的[CHANGELOG](./CHANGELOG.md)，或查看[Release记录](https://github.com/WGrape/lexer/releases)
### (5) 问题交流
如果有使用问题或疑问需要反馈，可以加入群聊，或[提交issue](https://github.com/WGrape/lexer/issues/new) ，欢迎大家的加入
## 6、协议说明
## 7、特别鸣谢
- [Hello github](https://github.com/521xueweihan/HelloGitHub/issues/1868): 感谢把此项目收录在 [第67期](https://github.com/521xueweihan/HelloGitHub/blob/master/content/67/HelloGitHub67.md#JavaScript-%E9%A1%B9%E7%9B%AE) 周刊中，并在```2021年10月28日```进行发布后，获得了大量用户的关注和点赞喜欢。