本文將深入探討Deno，並創(chuàng)建一個(gè)命令行工具，用於在文件和文件夾中搜索文本。我們將使用Deno提供的各種API方法來(lái)讀取和寫入文件系統(tǒng)。

上一篇文章中，我們使用Deno構(gòu)建了一個(gè)命令行工具，用於向第三方API發(fā)出請(qǐng)求。本文中，我們將暫時(shí)忽略網(wǎng)絡(luò)操作，構(gòu)建一個(gè)工具，允許您在當(dāng)前目錄內(nèi)的文件和文件夾中搜索文本——類似於grep之類的工具。

注意：我們構(gòu)建的工具不會(huì)像grep那樣優(yōu)化和高效，我們也並非旨在取代它！構(gòu)建這樣一個(gè)工具的目的是為了熟悉Deno的文件系統(tǒng)API。

關(guān)鍵要點(diǎn)

• Deno的文件系統(tǒng)API有助於創(chuàng)建用於在文件和目錄中搜索文本的命令行工具，類似於grep工具，但沒(méi)有那麼優(yōu)化。
• 在Deno中使用Yargs，開(kāi)發(fā)人員可以為命令行應(yīng)用程序構(gòu)建用戶界面，從而能夠在指定的目錄中進(jìn)行文本搜索。
• Deno提供內(nèi)置函數(shù)，如Deno.readDir用於列出文件和Deno.readTextFile用於讀取文件內(nèi)容，從而簡(jiǎn)化文件系統(tǒng)交互，無(wú)需額外導(dǎo)入。
• 可以使用Deno的path模塊高效地管理文件路徑，該模塊包括path.join等函數(shù)，用於連接文件路徑。
• Deno腳本需要顯式的權(quán)限標(biāo)誌，如–allow-read或–allow-write才能執(zhí)行文件系統(tǒng)操作，通過(guò)控制腳本功能來(lái)增強(qiáng)安全性。
• 開(kāi)發(fā)人員可以使用deno compile將Deno腳本編譯成獨(dú)立的可執(zhí)行文件，通過(guò)封裝必要的權(quán)限來(lái)簡(jiǎn)化分發(fā)和執(zhí)行。

安裝Deno

我們假設(shè)您已經(jīng)在本地機(jī)器上運(yùn)行了Deno。您可以查看Deno網(wǎng)站或上一篇文章，以獲取更詳細(xì)的安裝說(shuō)明，以及如何為您的編輯器添加Deno支持的信息。

在撰寫本文時(shí)，Deno的最新穩(wěn)定版本是1.10.2，這就是我在本文中使用的版本。

作為參考，您可以在GitHub上找到本文的完整代碼。

使用Yargs設(shè)置新的命令

與上一篇文章一樣，我們將使用Yargs來(lái)構(gòu)建用戶可以用來(lái)執(zhí)行我們工具的界面。讓我們創(chuàng)建index.ts並用以下內(nèi)容填充它：

import yargs from "https://deno.land/x/yargs@v17.0.1-deno/deno.ts";

interface Yargs<argvreturntype></argvreturntype> {
  describe: (param: string, description: string) => Yargs<argvreturntype>;
</argvreturntype>  demandOption: (required: string[]) => Yargs<argvreturntype>;
</argvreturntype>  argv: ArgvReturnType;
}

interface UserArguments {
  text: string;
}

const userArguments: UserArguments =
  (yargs(Deno.args) as unknown as Yargs<userarguments>)
</userarguments>    .describe("text", "the text to search for within the current directory")
    .demandOption(["text"])
    .argv;

console.log(userArguments);

這裡有很多值得指出的內(nèi)容：

• 我們通過(guò)指向Deno存儲(chǔ)庫(kù)中的路徑來(lái)安裝Yargs。我明確使用精確的版本號(hào)來(lái)確保我們始終獲得該版本，這樣我們就不會(huì)在腳本運(yùn)行時(shí)使用任何最新的版本。
• 在撰寫本文時(shí)，Deno TypeScript對(duì)Yargs的體驗(yàn)並不好，所以我創(chuàng)建了自己的接口並使用它來(lái)提供一些類型安全性。
• UserArguments包含我們將向用戶索取的所有輸入。目前，我們只要求輸入文本，但將來(lái)我們可以將其擴(kuò)展為提供要搜索的文件列表，而不是假設(shè)當(dāng)前目錄。

我們可以使用deno run index.ts運(yùn)行它並查看我們的Yargs輸出：

import yargs from "https://deno.land/x/yargs@v17.0.1-deno/deno.ts";

interface Yargs<argvreturntype></argvreturntype> {
  describe: (param: string, description: string) => Yargs<argvreturntype>;
</argvreturntype>  demandOption: (required: string[]) => Yargs<argvreturntype>;
</argvreturntype>  argv: ArgvReturnType;
}

interface UserArguments {
  text: string;
}

const userArguments: UserArguments =
  (yargs(Deno.args) as unknown as Yargs<userarguments>)
</userarguments>    .describe("text", "the text to search for within the current directory")
    .demandOption(["text"])
    .argv;

console.log(userArguments);

現(xiàn)在是時(shí)候開(kāi)始實(shí)現(xiàn)了！

列出文件

在我們開(kāi)始搜索給定文件中的文本之前，我們需要生成一個(gè)要搜索的目錄和文件列表。 Deno提供Deno.readdir，它是“內(nèi)置”庫(kù)的一部分，這意味著您不必導(dǎo)入它。它在全局命名空間中可用。

Deno.readdir是異步的，並返回當(dāng)前目錄中文件和文件夾的列表。它將這些項(xiàng)目作為AsyncIterator返回，這意味著我們必須使用for await ... of循環(huán)來(lái)獲取結(jié)果：

$ deno run index.ts
Check file:///home/jack/git/deno-file-search/index.ts
Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]
  --text     the text to search for within the current directory      [required]

Missing required argument: text

這段代碼將從當(dāng)前工作目錄（Deno.cwd()提供）讀取並記錄每個(gè)結(jié)果。但是，如果您現(xiàn)在嘗試運(yùn)行腳本，您將收到錯(cuò)誤：

for await (const fileOrFolder of Deno.readDir(Deno.cwd())) {
  console.log(fileOrFolder);
}

請(qǐng)記住，Deno要求所有腳本都明確地獲得從文件系統(tǒng)讀取的權(quán)限。在我們的例子中，--allow-read標(biāo)誌將使我們的代碼能夠運(yùn)行：

$ deno run index.ts --text='foo'
error: Uncaught PermissionDenied: Requires read access to <cwd>, run again with the --allow-read flag
</cwd>for await (const fileOrFolder of Deno.readDir(Deno.cwd())) {
                                                   ^
    at deno:core/core.js:86:46
    at unwrapOpResult (deno:core/core.js:106:13)
    at Object.opSync (deno:core/core.js:120:12)
    at Object.cwd (deno:runtime/js/30_fs.js:57:17)
    at file:///home/jack/git/deno-file-search/index.ts:19:52

在本例中，我在構(gòu)建工具的目錄中運(yùn)行腳本，因此它找到了TS源代碼、.git存儲(chǔ)庫(kù)和.vscode文件夾。讓我們開(kāi)始編寫一些函數(shù)來(lái)遞歸地導(dǎo)航此結(jié)構(gòu)，因?yàn)槲覀冃枰业侥夸浿械乃形募粌H僅是頂級(jí)文件。此外，我們可以添加一些常見(jiàn)的忽略項(xiàng)。我認(rèn)為沒(méi)有人會(huì)希望腳本搜索整個(gè).git文件夾！

在下面的代碼中，我們創(chuàng)建了getFilesList函數(shù)，它接受一個(gè)目錄並返回該目錄中的所有文件。如果遇到目錄，它將遞歸調(diào)用自身以查找任何嵌套的文件，並返回結(jié)果：

~/$ deno run --allow-read index.ts --text='foo'
{ name: ".git", isFile: false, isDirectory: true, isSymlink: false }
{ name: ".vscode", isFile: false, isDirectory: true, isSymlink: false }
{ name: "index.ts", isFile: true, isDirectory: false, isSymlink: false }

然後我們可以像這樣使用它：

const IGNORED_DIRECTORIES = new Set([".git"]);

async function getFilesList(
  directory: string,
): Promise<string[]> {
  const foundFiles: string[] = [];
  for await (const fileOrFolder of Deno.readDir(directory)) {
    if (fileOrFolder.isDirectory) {
      if (IGNORED_DIRECTORIES.has(fileOrFolder.name)) {
        // Skip this folder, it's in the ignore list.
        continue;
      }
      // If it's not ignored, recurse and search this folder for files.
      const nestedFiles = await getFilesList(
        path.join(directory, fileOrFolder.name),
      );
      foundFiles.push(...nestedFiles);
    } else {
      // We found a file, so store it.
      foundFiles.push(path.join(directory, fileOrFolder.name));
    }
  }
  return foundFiles;
}

我們還得到一些看起來(lái)不錯(cuò)的輸出：

const files = await getFilesList(Deno.cwd());
console.log(files);

使用path模塊

我們現(xiàn)在可以使用模板字符串組合文件路徑，如下所示：

$ deno run --allow-read index.ts --text='foo'
[
  "/home/jack/git/deno-file-search/.vscode/settings.json",
  "/home/jack/git/deno-file-search/index.ts"
]

但這使用Deno的path模塊會(huì)更好。此模塊是Deno作為其標(biāo)準(zhǔn)庫(kù)一部分提供的模塊之一（與Node使用其path模塊非常相似），如果您使用過(guò)Node的path模塊，則代碼看起來(lái)非常相似。在撰寫本文時(shí)，Deno提供的最新標(biāo)準(zhǔn)庫(kù)版本是0.97.0，我們從mod.ts文件導(dǎo)入path模塊：

import yargs from "https://deno.land/x/yargs@v17.0.1-deno/deno.ts";

interface Yargs<argvreturntype></argvreturntype> {
  describe: (param: string, description: string) => Yargs<argvreturntype>;
</argvreturntype>  demandOption: (required: string[]) => Yargs<argvreturntype>;
</argvreturntype>  argv: ArgvReturnType;
}

interface UserArguments {
  text: string;
}

const userArguments: UserArguments =
  (yargs(Deno.args) as unknown as Yargs<userarguments>)
</userarguments>    .describe("text", "the text to search for within the current directory")
    .demandOption(["text"])
    .argv;

console.log(userArguments);

mod.ts在導(dǎo)入Deno的標(biāo)準(zhǔn)模塊時(shí)始終是入口點(diǎn)。此模塊的文檔位於Deno網(wǎng)站上，並列出了path.join，它將接受多個(gè)路徑並將它們連接成一個(gè)路徑。讓我們導(dǎo)入並使用該函數(shù)，而不是手動(dòng)組合它們：

...(此處省略了其餘代碼，因?yàn)榕c原文重複，並且已經(jīng)在上一個(gè)輸出中進(jìn)行了修改和優(yōu)化。)

...(The rest of the code is omitted because it's repetitive from the original and has already been modified and optimized in the previous output.)

以上是在DENO中使用文件系統(tǒng)的詳細(xì)內(nèi)容。更多資訊請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！