cli finish basically (#5)

* feat(cli): 简化命令 使得命令可以在任何路径下运行

* fix:依赖调整

* fix:cli指令文件修改

* fix:修复路径带空格无法识别的bug

* docs:调整todo

* test(test): 补充测试用例

* test: add parse file path test case

* fix:指令重构

* feat:scripts目录提升

* docs:目录文档

* fix:目录调整

* fix:目录调整

* chore:引入依赖包

* feat: node vm执行index.js脚本

* docs:更新贡献者

* chore:忽略缓存文件

* refactor: directory refactor

BREAKING CHANGE: srcipts即将废弃，视图交互性代码完善1/3

* feat: finish the view create & check

* feat:完成lc&lk指令

* fix: 优化代码

* feat: add getQuestionChineseName function to get chinese name

* chore: del scripts and .vscode files & ignore .vscode

* docs: update todo & achive

* perf: better scripts and easy mode to create question in project

* feat: publish config & build config

* chore: del src

* fix: perfect version for cli install

* fix:指令打包完善

* fix:easy mode script

* docs:todo 拆分成单独文件

* chore:路径调整成全局路径

* docs: add CHANGELOG and TO-DO

---------

Co-authored-by: Hedwig-Fang <706964007@qq.com>

Author: wh131462

.gitignore

@@ -15,6 +15,7 @@ dist-ssr
 *.local
 
 # Editor directories and files
+.vscode
 .vscode/*
 !.vscode/extensions.json
 .idea
@@ -24,4 +25,10 @@ dist-ssr
 *.njsproj
 *.sln
 *.sw?
-coverage/**
+coverage/**
+
+# store file
+resources/stores/*
+
+# cli-dist
+pl-cli

.vscode/launch.json

@@ -0,0 +1,4 @@
+# 1.0.0
+- cli: lk/lf/lc 脚本实现 检测/查找/创建 功能,强而有力地支持了题目的便捷创建.
+- template project: easy mode 实现交互性创建,leet-create和leet-check保持src目录下创建题解.
+- plugin: 插件化的设计完善,进行立项.

CHANGELOG.md

@@ -1,46 +1,13 @@
 # Leetcode practice
 
-力扣练习库!开始你的每日一题!
-在编辑器中编写你的代码,简单有效的执行和计时!
-
-## TO-DO List
-
-### 功能
-
-#### 优先级高
-
-- [ ] 获取更完备的测试用例，增强用户体验
-- [ ] 获取题解和代码
-- [ ] commit到leetcode
-- [ ] 私人项目部署的实现方案
-
-#### 优先级中
-
-- [ ] 创建一个单独指令lc,用于项目的单独指令,忽略npm/yarn/pnpm的执行差异/歧义
+在力扣练习平台!开始你的每日一题!
 
-#### 优先级低
-
-- [ ] 实现在编辑器中预览图片(感觉可以不做)
-
-#### 代码优化及基础建设
-
-- [ ] 优化随机题目的随机方式，减少请求
-- [ ] commonJS -> ES6 Module
-- [ ] 优化src下代码结构
-- [ ] 封装npm包，方便后续做成编辑器插件
-
-### 已完归档
+在编辑器中编写你的代码,简单有效的执行和计时!
 
-- [x] 1.模板:获取js的函数体并替换生成文件中的@function
-- [x] 2.模板:从detail中获取输入用例的数据填充@Testcase
-- [x] 3.模板:获取跳转每日一题的链接替换@url
-- [x] 4.函数:优化时间和资源统计函数
-- [x] 5.优化创建时的体验，添加重复时候的确认覆盖或者添加额外符号
-- [x] 6.特殊数据结构的处理(链表ListNode,树TreeNode,无向连通图Node)的处理
-- [x] 7.创建某一特定编号的题目脚本,以及实现随机题目【随机题目汇集本地题目，然后排除自己本地存在的题目进行随机】
-- [x] 8.加入eslint
+我们的目标就是让所有人:
+> 只用专注于代码的实现,而非繁琐的输入输出!
 
-## How to use for yourself ?
+## Usage
 
 fork分支`template`的内容,其非内容部分会与主分支保持同步,意思是去除部分我的题目代码,然后使用指令创建你自己的题解即可!
 
@@ -69,8 +36,8 @@ yarn leet-create
 
 会通过接口获取今日题目，并会在`src`目录下根据`题目的id`+`题目的英文翻译`创建一个目录，并将今日题目和基础示例代码填充到`index.js`中。
 
-![创建目录](./resources/leet-create-0.png)
-![填充文件](resources/leet-create-1.png)
+![创建目录](resources/images/leet-create-0.png)
+![填充文件](resources/images/leet-create-1.png)
 
 ### 2. 检验今天的题目
 
@@ -79,8 +46,6 @@ yarn leet-check
 ```
 
 此指令会根据今天的题目信息去执行对应的题目文件，输出结果。
-> NOTE:缓存的实现是在`commom/resouces/store.json`,如果只想让内容在本地存在,不上传到个人项目中的话,执行`git update-index --aussume-unchanged common/resources/store.json`来忽略本地的文件变更即可。
->
 
 ```shell
 yarn leet-check 
@@ -100,7 +65,7 @@ Done in 0.18s.
 
 ```
 
-![检测题目](resources/leet-check.png)
+![检测题目](resources/images/leet-check.png)
 
 ### 3. 创建自己想要练习的题目
 
@@ -123,9 +88,9 @@ yarn leet-create -i "LCP 29"
   └── index.js # 模板js文件 可以替换题目
 ```
 
-![1314cmd.png](resources/1314-cmd.png)
-![1314.png](resources/1314.png)
-![1314详情.png](resources/1314-detail.png)
+![1314cmd.png](resources/images/1314-cmd.png)
+![1314.png](resources/images/1314.png)
+![1314详情.png](resources/images/1314-detail.png)
 
 ### 4. 检验自己想要练习的结果
 
@@ -177,7 +142,7 @@ Done in 0.19s.
 
 ```
 
-![1314-check.png](resources/1314-check.png)
+![1314-check.png](resources/images/1314-check.png)
 
 ### 5. 获取随机题目
 
@@ -191,7 +156,6 @@ yarn leet-create -r
  D:\GitHub\leetcode-practice> yarn leet-create -r     
 yarn run v1.22.19
 $ node common/scripts/create.js -r
-[store]数据存储成功[random-question-info]:[[object Object]]
 [fulfillQuestion]题目[43][字符串相乘]已完成填充.
 Done in 1.78s.
 ```
@@ -235,5 +199,6 @@ Done in 0.19s.
 
 ## Contributor
 
-[EternalHeart](https://github.com/wh131462)
-[SmallTeddy](https://github.com/SmallTeddy)
+[<img src="https://avatars.githubusercontent.com/u/48346853" style="border-radius:50%;" width="30" height="30" alt="EternalHeart"/>](https://github.com/wh131462)
+[<img src="https://avatars.githubusercontent.com/u/61453917" style="border-radius:50%;" width="30" height="30" alt="SmartTeddy"/>](https://github.com/SmallTeddy)
+[<img src="https://avatars.githubusercontent.com/u/35305691" style="border-radius:50%;" width="30" height="30" alt="Hedwig-Fang"/>](https://github.com/Hedwig-Fang)

Readme.md

@@ -0,0 +1,38 @@
+## TO-DO List
+
+### 功能
+
+#### 优先级高
+
+- [ ] commit到leetcode
+- [ ] 项目的升级检测以及升级脚本
+- [ ] 插件制作-WS/VS code
+
+#### 优先级中
+
+- [ ] 获取题解和代码
+- [ ] 获取更完备的测试用例，增强用户体验
+
+#### 优先级低
+
+#### 代码优化及基础建设
+
+- [ ] 优化随机题目的随机方式，减少请求
+
+### 已完归档
+
+- [x] 1.模板:获取js的函数体并替换生成文件中的@function
+- [x] 2.模板:从detail中获取输入用例的数据填充@Testcase
+- [x] 3.模板:获取跳转每日一题的链接替换@url
+- [x] 4.函数:优化时间和资源统计函数
+- [x] 5.优化创建时的体验，添加重复时候的确认覆盖或者添加额外符号
+- [x] 6.特殊数据结构的处理(链表ListNode,树TreeNode,无向连通图Node)的处理
+- [x] 7.创建某一特定编号的题目脚本,以及实现随机题目【随机题目汇集本地题目，然后排除自己本地存在的题目进行随机】
+- [x] 8.加入eslint
+- [x] 9.私人项目部署的实现方案
+- [x] 10.commonJS -> ES6 Module
+- [x] 11.实现在编辑器中预览图片(markdown中可以查看)
+- [x] 12.使用realm进行持久化,替换store.json
+- [x] 13.实现lk/lf/lc指令的封装
+- [x] 14.重构工具代码,对UI和logic进行解耦
+- [x] 15.封装npm包，方便后续做成编辑器插件

TO-DO.md

@@ -0,0 +1,89 @@
+#! /usr/bin/env node
+import {program} from "commander";
+import {artFontLogo} from "#resources/text/art-font-logo.js";
+import {examples} from "#resources/text/examples.js";
+import {love} from "#resources/text/love.js";
+import {aim} from "#resources/text/aim.js";
+import {referMode} from "#common/utils/create-check/refer-mode.js";
+import {getArgs} from "#common/utils/create-check/get-args.js";
+import {getQuestionToday} from "#common/utils/question-getter/getQuestionToday.js";
+import {createQuestion} from "#common/utils/question-handler/createQuestion.js";
+import path from "path";
+import {getQuestionFileName} from "#common/utils/question-handler/getQuestionFileName.js";
+import {createQuestionCopy} from "#common/utils/question-handler/createQuestionCopy.js";
+import {getQuestionRandom} from "#common/utils/question-getter/getQuestionRandom.js";
+import {getQuestionById} from "#common/utils/question-getter/getQuestionById.js";
+import {setQuestion} from "#common/utils/store/store-realm.js";
+import {getQuestionChineseName} from "#common/utils/question-handler/getQuestionChineseName.js";
+import {easyCreateView} from "#common/view/create.view.js";
+import {description} from "#resources/text/description.js";
+
+const version = process.env.VERSION??'0.0.0';
+program
+    .version(version)
+    .description(`${description}\n${artFontLogo}\n${aim}`)
+    .addHelpText('after', examples+love)
+    .arguments("[identity]")
+    .option('-t, --today', 'Get a question today.')
+    .option('-i, --identity <identity>', 'Specify a question by identity.')
+    .option('-r, --random', 'Get a question randomly.')
+    .option('-e, --easy', 'Use easy mode.')
+    .option('-d, --directory <directory>', 'Set the question directory.')
+    .parse(process.argv)
+
+const cmdArgs = program.args;
+const cmdOpts = program.opts();
+/**
+ * 执行逻辑:
+ * 目录检测 - 设置基础目录
+ * 模式检测 - 检测是不是easy mode
+ * [参数检测 - 执行对应参数]
+ */
+// 根据dir 参数来设置基本目录
+const baseDir = cmdOpts.directory?path.join(process.cwd(),cmdOpts.directory):process.cwd();
+if(cmdOpts.easy){
+    await easyCreateView();
+    process.exit(0);;
+}
+// 创建
+const create = (mode,question)=>{
+    console.log(`MODE: ${mode}`);
+    return new Promise(resolve=>{
+        setQuestion(mode,question);
+        const questionDir = path.join(baseDir,getQuestionFileName(question))
+        createQuestion(question,questionDir).then(async (path)=>{
+            if(!path)path = await createQuestionCopy(question,questionDir);
+            console.log(`题目[${getQuestionChineseName(question)}]获取成功!\n题目文件地址为:${path}`)
+            resolve(true)
+        })
+    })
+}
+// 模式对应的action
+const callModeAction = {
+    'today': () => {
+        getQuestionToday().then(question=>{
+            create("today",question).then(()=>{
+                process.exit(0)
+            });
+        })
+    },
+    'random': () => {
+        getQuestionRandom().then(question=>{
+            create("random",question).then(()=>{
+                process.exit(0)
+            });
+        })
+    },
+    'identity': (id) => {
+        getQuestionById(id).then(question=>{
+            create("identity",question).then(()=>{
+                process.exit(0)
+            });
+        })
+    },
+}
+// 获取模式和参数
+const mode = referMode(cmdArgs, cmdOpts);
+const args = getArgs(mode,cmdArgs,cmdOpts);
+// 执行指令分发
+await callModeAction[mode](args);

bin/lc.js

@@ -0,0 +1,2 @@
+#! /usr/bin/env node
+const version = process.env.VERSION??'0.0.0';

bin/lf.js

@@ -0,0 +1,83 @@
+#! /usr/bin/env node
+import {program} from "commander";
+import {artFontLogo} from "#resources/text/art-font-logo.js";
+import {examples} from "#resources/text/examples.js";
+import {love} from "#resources/text/love.js";
+import {aim} from "#resources/text/aim.js";
+import {referMode} from "#common/utils/create-check/refer-mode.js";
+import {getArgs} from "#common/utils/create-check/get-args.js";
+import fs from "fs";
+import path from "path";
+import {checkQuestion} from "#common/utils/question-handler/checkQuestion.js";
+import {getQuestionByMode} from "#common/utils/store/store-realm.js";
+import {getQuestionById} from "#common/utils/question-getter/getQuestionById.js";
+import {getQuestionFileName} from "#common/utils/question-handler/getQuestionFileName.js";
+import {getQuestionChineseName} from "#common/utils/question-handler/getQuestionChineseName.js";
+import {easyCheckView} from "#common/view/check.view.js";
+import {description} from "#resources/text/description.js";
+
+const version = process.env.VERSION ?? '0.0.0';
+program
+    .version(version)
+    .description(`${description}\n${artFontLogo}\n${aim}`)
+    .addHelpText('after', examples + love)
+    .arguments("[identity]")
+    .option('-t, --today', 'Check the question today.')
+    .option('-i, --identity <identity>', 'Check the specified question by identity.')
+    .option('-r, --random', 'Check the last random question.')
+    .option('-e, --easy', 'Use easy mode.')
+    .option('-d, --directory <directory>', 'Set the question directory.')
+    .parse(process.argv)
+
+const cmdArgs = program.args;
+const cmdOpts = program.opts();
+/**
+ * 执行逻辑:
+ * 目录检测 - 设置基础目录
+ * 模式检测 - 检测是不是easy mode
+ * [参数检测 - 执行对应参数]
+ */
+
+// 根据dir 参数来设置基本目录
+const baseDir = cmdOpts.directory ? path.join(process.cwd(), cmdOpts.directory) : process.cwd();
+if (cmdOpts.easy) {
+    await easyCheckView();
+    process.exit(0);
+}
+//
+// 检测函数
+const check = async (mode, question) => {
+    const filePath = path.join(baseDir, getQuestionFileName(question), 'index.js');
+    if (!fs.existsSync(filePath)) {
+        console.log(`文件[${filePath}]不存在,请确保已经创建!`)
+    } else {
+        console.log(`MODE: ${mode}\n题目[${getQuestionChineseName(question)}]检测结果:`)
+        await checkQuestion(filePath);
+    }
+    return true;
+}
+// 模式对应的action
+const callModeAction = {
+    'today': async () => {
+        const question = await getQuestionByMode("today");
+        await check('today', question)
+        process.exit(0);
+    },
+    'random': async () => {
+        const question = await getQuestionByMode("random");
+        await check('today', question)
+        process.exit(0);
+    },
+    'identity': async (id) => {
+        const question = !id ?
+            await getQuestionByMode(mode) :
+            await getQuestionById(id);
+        await check('today', question)
+        process.exit(0);
+    },
+}
+// 获取模式和参数
+const mode = referMode(cmdArgs, cmdOpts);
+const args = getArgs(mode, cmdArgs, cmdOpts);
+// 执行指令分发
+callModeAction[mode](args);