Merge branch 'main' into npm

.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE_1.md

@@ -0,0 +1,20 @@
+---
+name: BUG 反馈
+about: 很遗憾工具使用得没有很顺利
+---
+
+## 设备信息
+
+如：win11 64位
+
+## 操作步骤
+
+简要描述即可
+
+### 实际发生的
+
+--
+
+### 期望的
+
+--

.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE_2.md

@@ -0,0 +1,16 @@
+---
+name: 建议Or其它
+about: 你想要的功能｜觉得可以优化的体验｜其它
+---
+
+## 使用的工具
+
+> 在以下`[]`中输入`x`即可
+
+- [] Node.js环境的CLI
+- [] 浏览器插件
+- [] 可执行程序
+
+## 建议
+
+> 例如：希望浏览器端可以有更好的给文章打标签的功能，因为语雀做的操作步骤太麻烦了

.github/workflows/npm-publish.yml

@@ -22,17 +22,45 @@ jobs:
   #         node-version: 16
   #     - run: npm i
 
-  publish-npm:
-    # needs: install
-    runs-on: ubuntu-latest
+  # publish-npm:
+  #   # needs: install
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v3
+  #     - uses: pnpm/action-setup@v2
+  #       with:
+  #         node-version: 16
+  #         registry-url: https://registry.npmjs.org/
+  #     - run: pnpm install
+  #     - run: pnpm run tsc
+  #     - run: pnpm publish -r --dry-run
+  #       env:
+  #         NODE_AUTH_TOKEN: ${{secrets.NPM_PUBLISH_WORKFLOW}}
+
+
+
+  publish-task:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        node-version: [18]
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          registry-url: https://registry.npmjs.org/
-      - run: npm i
-      - run: npm run tsc
-      - run: npm publish
-        env:
+    - uses: actions/checkout@v3
+    - uses: pnpm/action-setup@v2
+      with:
+        version: 8
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'pnpm'
+        registry-url: https://registry.npmjs.org/
+    - name: Install dependencies
+      run: pnpm install 
+    - name: Build 
+      run: pnpm run tsc
+    - name: Publish
+      # run: pnpm publish -r --dry-run
+      run: pnpm publish -r
+      env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_PUBLISH_WORKFLOW}}

.gitignore

@@ -1,13 +1,15 @@
 .DS_Store
 node_modules
-/dist
+dist/
 /bak
 /directories
 .vscode/
-/docs/*
+docs/
+build/
 yuque.config.json
-pnpm-lock.yaml
+# pnpm-lock.yaml
 
+storage/
 
 # local env files
 .env.local

.npmrc

@@ -0,0 +1,5 @@
+git-checks=false
+publish-branch=production
+link-workspace-packages=false
+# 本地私服地址
+# registry=http://localhost:4873/

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023-present, vannvan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,146 +1,53 @@
-# 语雀知识库批量导出和再处理工具(非TOKEN方式,非官方)  
+# 朴实无华的语雀工具集合
+
+## 知识库批量导出CLI工具
 
 ![](https://badgen.net/npm/dm/yuque-tools)
 ![](https://badgen.net/npm/v/yuque-tools)
 ![](https://badgen.net/npm/node/next)
 
-[🎉可执行程序版v1.0.0——无需Node环境](https://github.com/vannvan/yuque-tools/releases)
+[🎉可执行程序版(无需Node环境，下载即用)](https://github.com/vannvan/rust-explore/releases)  
 
-## 样例
+### 样例
 
 [![example.gif](https://www.z4a.net/images/2023/05/01/example.gif)](https://www.z4a.net/image/VmUHiO)
 
-## 支持
+### 支持
 
 - 个人知识库
 - 空间(团队)知识库
 - 协作知识库
-- 小记
+- 小记 (由[jialuohu](https://github.com/jialuohu)提供)
 
 > 自 2.1.0 版本开始，交互式列表中 👤 前缀表示个人知识库，其它则为 👥
 
-[了解实现过程-与其它工具有什么不一样](https://github.com/vannvan/yuque-tools/blob/main/ABOUT.md)
-
-## 使用方式
-
-### 整体步骤
-
-pull -> 登录 -> 交互式选择知识库(命令行参数完整不会进入交互式环节) -> 等待下载完成
-
-目前登录完成后会设置一天的有效时间，也就是说在24小时之内重复导出只有第一次需要登录。
-
-### 安装 install
->
-> npm i yuque-tools -g 安装到全局  
-> npm i yuque-tools 安装到局部  
-> 安装到全局以下方法使用`ytool xx`，安装到局部以下方法使用`npx ytool xx`
-
-### 导出 pull
-
-创建目录`yuque-docs`并进入目录
-
-> ytool pull
-
-#### 参数说明
-
-|参数|说明|必填|
-|--|--|--|
-|userName password | 语雀账号和密码|是/交互|
-|tocRange|例如: `test-book/测试目录 test-book2`，多个知识库之间空格隔开|是/交互|
-|all | 导出所有知识库，与`tocRange`互斥|是/交互|
-|skip/skipDoc | 导出时是否跳过本地同名文件|否/交互|
-|lb/linebreak | 导出时是否保留语雀换行标签，即`<br/>`标签|否/交互|
-|host |指定`空间`域名，例如: `https://van.yuque.com`，后面不要有斜杠(`/`)|否|
-|output|导出目录，例如: `./mydocs`，默认为`docs`|否|
-|only_note|导出小记|否|
-
-注意:
-
-- 命令行认为前两个参数为帐号和密码；
-- 当以上**必填**参数全都存在时不会进入交互式环节，反之则会进入交互环节；
-- 对于`skip`和`lb`，为了命令行使用便捷，采用`skip`表示，而为了含义明确，在配置中采用`skipDoc`表示,`lb`同理；
-- 为降低命令行使用时的复杂度，`host`及`output`(特定场景需要)仅支持配置形式使用且不会进入问询环节，具体配置方式见以下[TIPS](#tips)⬇️
-- 由于小记与知识库归属不同，当使用`only_note`时，将只会进入导出小记的环节，知识库的配置将会忽略
-
-#### 应用示例
-
-以 [我的测试知识库](https://www.yuque.com/vannvan/dd67e4) 为例
-
-采用一行命令直接导出的形式：  
-
-参数生效的前提是`userName`和`password`同时存在，且在所有参数最前面，其它参数顺序均无具体要求
-
-> ytool pull 18989XXX xxxx all 表示导出**所有**知识库，**不跳过**本地同名文件，**不保持语雀换行标签**
-
-> ytool pull 18989XXX xxxx test-book 表示导出`test-book`知识库，**不跳过**本地同名文件，**不保持语雀换行标签**
-
-> ytool pull 18989XXX xxxx test-book skip  表示导出`test-book`知识库，**跳过**本地同名文件
-
-> ytool pull 18989XXX xxxx test-book/测试目录 skip  表示导出`test-book`知识库下`测试目录`下的文档，**跳过**本地同名文件
-
-> ytool pull 18989XXX xxxx test-book other-book skip 表示导出`test-book`和`other-book`两个知识库，**跳过**本地同名文件
-
-> ytool pull 18989XXX xxxx all skip lb 表示导出**所有**知识库，**跳过**本地同名文件，**保持语雀换行标签**
-
-> ytool pull 18989XXX xxxx only_note 表示**只导出小记**
-
-采用完全交互式的形式：  
-
-> ytool pull 即什么都没有传的情况下，以上所有可选的信息都会进入交互式问询环节
-
-### 清除缓存 clear
-
-工具可能存在因`yuque`接口的不稳定性产生的无法规避的错误(概率较低)，从而导致导出操作失败/异常，此时可以`clear`之后再重试导出操作。
-
-> ytool clear  
-
-### TIPS
-
-导出参数支持配置化形式，适合长期使用，采用`yuque-docs/yuque.config.json`进行配置，具体含义与上述[参数说明]一致
-
-> 以下配置模版可通过`ytool init`直接生成(仅支持2.0版本及以上)
-
-```json
-{
-  "userName": "XXX",
-  "password": "XXX",
-  "tocRange":["xxx知识库", "yyy知识库/zzz目录"],
-  "skipDoc": false,
-  "linebreak": false,
-  "host":"",
-  "output":"./docs",
-  "only_note": false
-}
+### 使用说明
 
-```
+[使用说明-传送门](https://github.com/vannvan/yuque-tools/blob/main/packages/yuque-tools-cli/README.md#使用方式)
 
-### 更新插件 upgrade
+## 浏览器插件
 
-考虑后期此工具(外挂)还会支持更多工具，从2.0版本开始支持便捷的升级操作，采用如下命令即可方便的完成升级
+## 功能
 
-> ytool upgrade
+### 更好用的文章标签
 
-目前具体实践已应用至我个人的 [knowledge-garden](https://github.com/vannvan/knowledge-garden) 中，感兴趣的朋友可以了解其具体实现。
+![](https://p.ipic.vip/miv63r.gif)
 
-## 最佳实践
+#### Why?
 
-此工具开发的初心是将其作为一个将语雀知识库与其它平台数据共享的**介质**，因此也具备很多实践的可能性，
-通过语雀作为文字的载体，你可以通过`yuque-tools`实现以下几种可能性：
+现状⬇️及[一个悲惨的故事](https://www.yuque.com/yuque/thyzgp/icl7ey)
 
-1. 你有自己的个人博客，通过定制脚本将语雀知识库的内容同步至自己的服务器；
-2. 你在多个社区有自己的内容创作，通过定制脚本将语雀知识库的内容同步至内容平台；
-3. 你有更灵活的私域/公域的文字记录，通过`yuque-tools`灵活的导出能力，将内容分发至不同的平台；
-4. ...
+![](https://p.ipic.vip/te8gij.gif)
 
-## 推荐
+<!-- > [如何使用标签-语雀官方说明](https://www.yuque.com/yuque/thyzgp/icl7ey) -->
 
-在跨平台文档同步/博客方案方面[elog](https://github.com/LetTTGACO/elog)有着更强大的能力，有需要的朋友可以了解一下这个项目
+### 浏览器插件-TODO
 
-<img width="1674" alt="image" src="https://github.com/vannvan/yuque-tools/assets/43501134/8876287c-c80d-420d-82af-ade2586970d6">
+- [ ] 网页端批量导出Markdown
+- [ ] 一些可以改进的功能
 
-## Issues
+## 关于
 
-[反馈意见](https://github.com/vannvan/yuque-tools/issues) |
-[更新记录及计划](https://github.com/vannvan/yuque-tools/blob/main/CHANGELOG.md)
+以上工具均产生于个人实际需求，旨在更好的利用一个知识管理工具，欢迎提供更好的idea或参与共创，如有帮助到您，欢迎点个鼓励的⭐️
 
-欢迎提供更好的意见，如果有帮助欢迎点个鼓励的⭐️
+[反馈意见](https://github.com/vannvan/yuque-tools/issues) | [CLI工具更新记录](https://github.com/vannvan/yuque-tools/blob/main/packages/yuque-tools-cli/CHANGELOG.md) | [浏览器插件更新记录](https://github.com/vannvan/yuque-tools/blob/main/packages/yuque-tools-chrome-extension/CHANGELOG.md)