本发明涉及计算机软件，具体来说，涉及一种基于node.js的文档整理方法。
背景技术：
1、随着软件技术的发展，软件开发的节奏逐渐加快，软件的功能也是越来越多，有些功能可能也会变得越来越复杂，每次的版本更迭需要整理说明文档用来指引用户如何快速的上手软件并使用软件内部的功能。
2、以上这些文档的整理有放在文档服务器的，但是这种的弊端就是需要同时在由前端开发人员再去根据以上的内容整理出来一份数据文件，用来给到前端页面展示，每次文档的更新都需要前端开发人员再去修改这些数据，效率比较低；也有单独去开发前端页面用来展示的，这种的弊端就是每次文档的修改都需要重新开发一个新的数据页面，内容的修改也是如此，效率相对也是比较低。
3、因此，如何统一文档的存放和整理地址，提高文档的更新效率成为了人们急需解决的技术问题。
技术实现思路
1、针对相关技术中的上述技术问题，本发明提出一种基于node.js的文档整理方法，使用node服务获取gitlab托管项目文件，并整理成所需要的数据结构，能够克服现有技术的上述不足。
2、为实现上述技术目的，本发明的技术方案是这样实现的：
3、一种基于node.js的文档整理方法，包括脚本运行,所述脚本运行的具体步骤如下：
4、s1在项目中安装并引入第三方依赖：fs、path、axios、chalk分别用来和文件系统进行交互、发起http请求、面板交互信息提示；
5、s2捕获用户输入并执行的指令，区分本地开发环境和正式发布环境，用来设置文件存储的路径；
6、s3定义全局变量用来定义存储程序后续的数据,包含gitlab的配置对象；
7、s4创建基础的axios请求封装；
8、s5创建文件/文件夹的创建函数以及删除函数；
9、s6根据s3中设置的gitlab配置文件调用gitlab api；
10、s7首先获取项目存在的分支列表和主分支的分支名称，记录到gitlab配置中；
11、s8获取该项目主分支下的目录文件列表数据；
12、s9脚本自动整理获取的目录信息并归纳到一个数组集合中，使用for循环遍历这个数组，识别文件夹和文件；
13、s10针对非文档的文件，脚本会根据这个文件的文件夹路径使用s5中描述的函数，在本地创建出文件目录，发起请求从gitlab中获取文件的元数据，并在目录下创建文件写入流复制出一个文件；
14、s11针对属于文档的文件，脚本会自动发起请求，获取文档中的内容，并提取文档中的标题生成一个object对象；
15、s12添加s11中生成数据对象到s3中定义的用于存放文档数据的数组对象中；
16、s13文件遍历完成，s3中定义的存放文档数据的数组对象转换成json字符串，创建一个js文件，将json字符串写入到js文件中。
17、进一步地，步骤s8中列表数据通过接口默认一次返回20条，如存在一次请求无法获取所有的数据，脚本自动识别是否有数据未加载，如有则自动发起新的请求直到获取完整的目录信息数据。
18、进一步地，步骤s11中object对象包括键值id、标题title以及内容value字段。
19、进一步地，步骤s13中的js文件存储路径为s2中的存储路径。
20、进一步地，fs为file system的简称，在node.js中用来和文件系统交互。
21、进一步地，gitlab为基于git的开源代码管理平台，用于对在软件开发过程中产生的代码和文档进行管理。
22、进一步地，node.js为一个基于chrome v8引擎的javascript运行环境，即使用了一个事件驱动、非阻塞式i/o模型，让javascript运行在服务端的开发平台。
23、本发明的有益效果：本发明通过使用node服务获取gitlab托管项目文件，并整理成所需要的数据结构来实现脚本的运行，文档可以被统一的整理和收纳；变更访问地址、令牌和项目id便可以使用该脚本，简单易用；运行一行指令便可以更新文档，更新快捷；可以单独修改或拓展某一部分逻辑，可扩展性高；不再需要同时更新文档和前端内容，效率大大地提高；交互信息清晰，每个阶段的部分都会有界面提示信息，成功或失败均有反馈。
1.一种基于node.js的文档整理方法，其特征在于，包括脚本运行,所述脚本运行的具体步骤如下：
2.根据权利要求1所述的基于node.js的文档整理方法，其特征在于，步骤s8中列表数据通过接口默认一次返回20条，如存在一次请求无法获取所有的数据，脚本自动识别是否有数据未加载，如有则自动发起新的请求直到获取完整的目录信息数据。
3.根据权利要求1所述的基于node.js的文档整理方法，其特征在于，步骤s11中object对象包括键值id、标题title以及内容value字段。
4.根据权利要求1所述的基于node.js的文档整理方法，其特征在于，步骤s13中的js文件存储路径为s2中的存储路径。
5.根据权利要求1所述的基于node.js的文档整理方法，其特征在于，fs为file system的 简称，在node.js中用来和文件系统交互。
6.根据权利要求1所述的基于node.js的文档整理方法，其特征在于，gitlab为基于git的开源代码管理平台，用于对在软件开发过程中产生的代码和文档进行管理。
7.根据权利要求1所述的基于node.js的文档整理方法，其特征在于，node.js为一个基于chrome v8引擎的javascript运行环境，即使用了一个事件驱动、非阻塞式i/o模型，让javascript 运行在服务端的开发平台。