# 克隆本仓库
git clone https://github.com/XYShaoKang/sk-js-aigorithm.git
# 在 VSCode 中打开
code sk-js-aigorithm安装 LeetCode 插件,并根据插件文档,自行进行设置
我使用的配置,替换其中<本仓库的绝对路径>为你实际中的路径
{
'leetcode.endpoint': 'leetcode-cn',
'leetcode.workspaceFolder': '<本仓库的绝对路径>',
'leetcode.defaultLanguage': 'typescript',
'leetcode.showDescription': 'In Webview',
'leetcode.editor.shortcuts': ['submit', 'test', 'description'],
'leetcode.hint.configWebviewMarkdown': false,
'leetcode.hint.commentDescription': false,
'leetcode.hint.commandShortcut': false,
'leetcode.filePath': {
default: {
folder: 'problem',
filename: '${id}.${kebab-case-name}.${ext}',
},
},
}本仓库主要使用 TypeScript 编写,如果是使用 JavaScript 的话,有些地方需要自己调一下,比如在有些代码包含类型注解,需要将类型注解去掉,才能在 JavaScript 的环境下运行,如果有需要的话,可以提 Issue 告诉我,我可以考虑另外做一个纯 JavaScript 环境的仓库.
内置了自动获取和添加测试用例的脚本,已经设置为任务Add test,可以绑定到快捷键中方便使用,绑定的方式是在keybindings.json中添加下面的语句:
我这里绑定的是
cmd+ctrl+c,可以换成任意其他自定义快捷键
{
"key": "cmd+ctrl+c",
"command": "workbench.action.tasks.runTask",
"args": "LeetCode: Add test"
}脚本源码: create-test.ts, leetcode-parse.ts
目前是用代码片段的方式实现,之后考虑使用脚本自动获取的方式,可以更加方便
通过 VSCode 代码片段的方式添加测试用例,复制题目示例中包含输入和输出行的内容(网页中或者使用 VSCode 插件显示的示例均可),然后通过输入代码片段的前缀lc-test(一般输入lct就会是第一个),再按 Tab 键即可,代码片段通过解析复制文本中的信息来生成使用 Jest 测试的代码,如下演示:
另外可以用快捷键绑定代码片段,用快捷键来快速生成测试用例,快捷键需要自己去设置,按 Cmd+Shift+P (Windows 下按 Ctrl+Shift+P)打开命令面板,然后输入keyboard有一个首选项: 打开键盘快件方式(JSON)选择之后,就会跳出快捷方式的配置文件keybindings.json,粘贴以下代码,将key中的这里替换成想要设置的快捷键修改为自己需要的快捷键即可,后面的注释是我设置的快捷键,仅供参考.
[
{
key: '这里替换成想要设置的快捷键', // cmd+ctrl+c
command: 'editor.action.insertSnippet',
when: 'editorTextFocus',
args: {
langId: 'typescript',
name: 'leetcode test',
},
},
{
key: '这里替换成想要设置的快捷键', // cmd+ctrl+x
command: 'editor.action.insertSnippet',
when: 'editorTextFocus',
args: {
langId: 'typescript',
name: 'leetcode test add example',
},
},
]
代码片段是通过脚本生成的,可以在 tools/create-snippet.ts 查看脚本源码,以及 .vscode/typescript.code-snippets 查看生成的代码片段.
运行pnpm build:snippet(或者 yarn build:snippet 或者 npm run build:snippet)可以重新生成代码片段,如果只有自己改过 .vscode/typescript.code-snippets 这个文件的,记得备份自己修改过的部分
目前已知有两类题目无法通过这个方法直接一键生成完美的测试,需要自行添加部分代码
链表,二叉树等特殊数据结构的题目(比如 206.反转链表,94.二叉树的中序遍历),这类题目官方给出的输入条件是进过序列化之后的(一般是数组),所以没法直接当作输入用,需要进行反序列化才行,这里可以参考后面的测试辅助类的说明,查看如何使用项目中内置的一些方法添加反序列化的代码.
实现类的题目(208. 实现 Trie (前缀树),304. 二维区域和检索 - 矩阵不可变),这类题的测试用例的输入一般会给两个数组,一个数组中包含对类的操作,另外一个数组包含这些操作对应输入的参数,这就需要根据题目去自定义测试了,目前没有很好的解决办法,对于我遇到过的题目都会在这个项目中记录对应的测试,大家可以到对应的文件中复制,如果我没遇到过的,就只能靠自己自定义了,或者可以提 Issue 给我,我看到的话也会写上.
项目内置了自定义的任务,用于对当前文件进行测试,可以通过按 Cmd+Shift+P (Windows 下按 Ctrl+Shift+P) 打开命令面板,输入 tasks 选到任务: 运行任务回车,然后输入run test(自定义任务的 Label),然后回车既会以监视模式对当前文件运行测试.
另外我将这个任务设置了默认的构建任务(这个项目没多少需要构建的任务,所以不会有什么影响),而默认的构建任务可以通过 Cmd+Shift+B (Windows 下按 Ctrl+Shift+B) 来触发,所以可以通过按快捷键来触发任务更方便
当然也可以设置自定义要绑定的快捷键.
..vscode/tasks.json可以查看自定义任务设置.
项目中内置了测试用的辅助类,主要是集成了一些特殊数据结构的反序列化和序列化方法.可以使用这些方法对题目中的测试用例进行反序列化得到想要的输入,并将结果进行序列化用以跟用例中的输出进行比对.
这些辅助类会在运行测试时,由 Jest 自动设置到全局,所以可以直接在测试直接使用.
jest/setupTests.ts这里可以查看辅助类的源码.以及类型定义types/global.d.ts
用于二叉树的反序列化,相关题目:
declare var BinaryTree: {
// 序列化二叉树
serialize(root: TreeNode | null): Array<number | null>
// 反序列化二叉树
deserialize(data: Array<number | null> | string): TreeNode | null
// 对二叉树进行搜索,返回指定值对应的节点
search(root: TreeNode | null, value: number): TreeNode | null
}
const input = [1, 2, 3, null, null, 4, 5]
const root = BinaryTree.deserialize(input)
// {
// val: 1,
// left: { val: 2, left: null, right: null },
// right: {
// val: 3,
// left: { val: 4, left: null, right: null },
// right: { val: 5, left: null, right: null },
// },
// }
BinaryTree.serialize(root)
// [1, 2, 3, null, null, 4, 5]
BinaryTree.search(root, 2)
// { val: 2, left: null, right: null }用于 N 叉树的反序列化,相关题目:
declare var NaryTree: {
// 反序列化 N 叉树
deserialize(data: string | Array<number | null>): Node | null
}
const input = [1, 2, 3, null, null, 4, 5]
const root = BinaryTree.deserialize(input)
// {
// val: 1,
// children: [
// {
// val: 3,
// children: [
// {
// val: 5,
// children: [],
// },
// {
// val: 6,
// children: [],
// },
// ],
// },
// {
// val: 2,
// children: [],
// },
// {
// val: 4,
// children: [],
// },
// ],
// }用于链表的序列化和反序列化,相关题目:
declare var LinkedList: {
// 反序列化链表
deserialize(data: Array<number>): ListNode | null
// 序列化链表
serialize(root: ListNode | null): Array<number>
// 搜索链表
search(root: ListNode | null, val: number): ListNode | null
}
const input = [3, 2, 0, -4]
const root = LinkedList.deserialize(input)
// { val: 3, next: { val: 2, next: { val: 0, next: { val: -4, next: null } } } }
LinkedList.serialize(root)
// [3, 2, 0, -4]
LinkedList.search(root, 2)
// { val: 2, next: { val: 0, next: { val: -4, next: null } } }Jest 中使用 toBe 匹配器来进行基本的相等比较,toBe 使用 Object.is 来比较值是否相等,Object.is跟===的区别只有以下两点:
- 正零和负零不相等
Object.is(0,-0) // false NaN会相等Object.is(NaN,NaN) // true
我记得之前有一题(忘了具体是哪一题),力扣在进行测试时,0 和 -0 就不相等.
const [a, b] = [1, 1]
expect(a).toBe(0) // 不通过
expect(a).toBe(b) // 通过我们知道 JavaScript 中的两个对象就算里面的数据一模一样,但也是不相等的,所以如果我们只是像判断对象的结构是否一样,就不能使用 toBe 去判断.Jest 提供了另外一个匹配器 toEqual 来对对象进行比较,判断两个对象是否结构相同(拥有相同属性,并且属性值相同),toEqual 会进行深度比较.
const [obj1, obj2] = [{ a: 1 }, { a: 1 }]
expect(obj1).toBe(obj2) // 不通过
expect(obj1).toEqual(obj2) // 通过对数组进行比较判断时,有时候我们不在乎数组内部元素的顺序,这时候如果使用 toEqual 去判断,对于拥有一样的成员,但顺序不同的用例会测试失败,这个功能可以通过 jest-extended 库中的 toIncludeSameMembers 匹配器来实现.
toIncludeSameMembers 只要元素相等,并且元素的个数也需要相等,可以以任何顺序.比如下面例子中的 arr1 和 arr3 虽然都有元素 1,2,但 1,2 元素的个数不相等,所以不通过测试.
另外对于数组中如果包含了对象,也会对对象进行结构比较
const arr1 = [1, 1, 2, 2]
const arr2 = [1, 2, 1, 2]
const arr3 = [1, 2, 1, 1]
expect(arr1).toIncludeSameMembers(arr2) // 通过
expect(arr1).toIncludeSameMembers(arr3) // 不通过不过如果是一个二维数组,或者多维数组,需要检查子元素是否具有相同元素而忽略顺序的话,
toIncludeSameMembers也无能为力,只能先对要判断的数据进行预处理,比如先把两者的子元素先进行排序.
项目中配置了一键调试的功能,在文件中打好断点,按 F5 会直接对当前文件进行调试,不过有时候断点的映射好像有点问题,打的断点在启动调试后会往上移,之后在调整看看.
