前言
周末逛github的时候,发现我们只需要在github域名上加上1s他就能够打开一个vscode窗口来阅读代码,比起在github仓库中查看更加方便
图片
然后我就想网页端vscode能不能打开我本地的项目呢,带着这个疑惑我打开了网页版vscode,它居然真的可以打开我本地的项目代码!
图片
难道又出了新的API让前端的能力更进一步了?打开MDN查了一下相关文档,发现了几个新的API
showOpenFilePicker
用来选择文件
图片
语法
showOpenFilePicker()
参数
- 「options」:(可选)包含以下属性
multiple:布尔值,默认为false。为true表示允许用户选择多个文件
excludeAcceptAllOption:布尔值,默认为false。默认情况下,文件选择器带有一个允许用户选择所有类型文件的过滤选项(展开于文件类型选项中)。设置此选项为 true 以使该过滤选项不可用。
types:表示允许选择的文件类型的数组
返回值
返回一个promise对象,会兑现一个包含 FileSystemFileHandle 对象的 Array 数组。
体验
打开文件
const openFile = async () => {
const res = await window.showOpenFilePicker();
console.log(res);
};
默认只能打开一个文件,可以传入multiple:true打开多个文件
图片
showDirectoryPicker
用来选择目录
图片
语法
属于浏览器全局方法,直接调用即可
showDirectoryPicker()
参数
- 「options」:(可选)包含以下属性
multiple:布尔值,默认为false。为true表示允许用户选择多个文件
excludeAcceptAllOption:布尔值,默认为false。默认情况下,文件选择器带有一个允许用户选择所有类型文件的过滤选项(展开于文件类型选项中)。设置此选项为 true 以使该过滤选项不可用。
types:表示允许选择的文件类型的数组
返回值
返回一个promise对象,会兑现一个包含 FileSystemFileHandle 对象的 Array 数组。
体验
打开文件
打开文件夹
const openFile = async () => {
const res = await window.showOpenFilePicker({
// multiple: true,
});
console.log(res.length);
};
const openDir = async () => {
const res = await window.showDirectoryPicker();
console.log(res);
};
图片
扩展
FileSystemFileHandle
FileSystemFileHandle提供了一些方法可以用来获取和操作文件
- getFile:返回一个Promise对象,用于获取文件;
- createSyncAccessHandle:返回一个FileSystemSyncAccessHandle对象,用于同步访问文件;
- createWritable:返回一个Promise对象,用于创建一个可写流,用于写入文件;
FileSystemDirectoryHandle
FileSystemDirectoryHandle对象是一个代表文件系统中的目录的对象,它同样提供了方法来获取和操作目录
- entries:返回一个AsyncIterable对象,用于获取目录中的所有文件和目录;
- keys:返回一个AsyncIterable对象,用于获取目录中的所有文件和目录的名称;
- values:返回一个AsyncIterable对象,用于获取目录中的所有文件和目录的FileSystemHandle对象;
- getFileHandle:返回一个Promise对象,用于获取目录中的文件;
- getDirectoryHandle:返回一个Promise对象,用于获取目录中的目录;
- removeEntry:返回一个Promise对象,用于删除目录中的文件或目录;
- resolve:返回一个Promise对象,用于获取目录中的文件或目录;
entries、keys、values这三个方法都是用来获取目录中的所有文件和目录的,它们返回的都是一个AsyncIterable对象,我们可以通过for await...of语法来遍历它。
开发编辑器
了解完这些知识点,我们就可以来开发一个简陋网页版编辑器了,初期只包含打开文件、打开文件夹、查看文件、切换文件
编辑器大概长这样:
图片
打开文件夹
const openDir = async () => {
const res = await window.showDirectoryPicker({});
const detalAction = async (obj: any) => {
if (obj.entries) {
const dirs = obj.entries();
for await (const entry of dirs) {
if (entry[1].entries) {
// 文件夹,递归处理
detalAction(entry[1]);
} else {
// 文件
fileList.value.push({
name: entry[0],
path: obj.name,
fileHandle: entry[1],
});
}
}
}
};
await detalAction(res);
showCode(fileList.value[0], 0);
console.log("--fileList--", fileList);
};
这里主要是递归处理文件夹,返回一个文件列表
读取文件内容
const showCode = async (item: any, index: number) => {
const file = await item.fileHandle.getFile();
const text = await file.text();
codeText.value = text;
currentIndex.value = index;
};
展示文件内容
使用highlight.js来高亮展示代码
{{ codeText }}
最终效果如下:
图片
想不到吧,这种功能现在纯前端就能够实现了,当然还可以做的更复杂一点,包括修改保存等功能,保存可以使用showSaveFilePickerAPI,它可以写入文件,同样是返回一个promise。感兴趣的可以试着完善编辑器的功能。