Node.js でのフォルダの操作

Node.js の `fs` コアモジュールには、フォルダを操作するために使用できる多くの便利なメソッドが用意されています。

フォルダの存在確認

`fs.access()`(およびその Promise ベースの対応物 `fsPromises.access()`)を使用して、フォルダが存在し、Node.js がその権限でアクセスできるかどうかを確認します。

新しいフォルダの作成

`fs.mkdir()`、`fs.mkdirSync()`、または `fsPromises.mkdir()` を使用して新しいフォルダを作成します。

const fs = require('node:fs');

const folderName = '/Users/joe/test';

try {
  if (!fs.existsSync(folderName)) {
    fs.mkdirSync(folderName);
  }
} catch (err) {
  console.error(err);
}

ディレクトリの内容の読み取り

`fs.readdir()`、`fs.readdirSync()`、または `fsPromises.readdir()` を使用して、ディレクトリの内容を読み取ります。

このコードは、ファイルとサブフォルダの両方を含むフォルダの内容を読み取り、それらの相対パスを返します。

const fs = require('node:fs');

const folderPath = '/Users/joe';

fs.readdirSync(folderPath);

フルパスを取得できます。

fs.readdirSync(folderPath).map(fileName => {
  return path.join(folderPath, fileName);
});

結果をフィルタリングして、ファイルのみを返し、フォルダを除外することもできます。

const fs = require('node:fs');

const isFile = fileName => {
  return fs.lstatSync(fileName).isFile();
};

fs.readdirSync(folderPath)
  .map(fileName => {
    return path.join(folderPath, fileName);
  })
  .filter(isFile);

フォルダの名前変更

`fs.rename()`、`fs.renameSync()`、または `fsPromises.rename()` を使用してフォルダの名前を変更します。最初の引数は現在のパス、2 番目の引数は新しいパスです。

const fs = require('node:fs');

fs.rename('/Users/joe', '/Users/roger', err => {
  if (err) {
    console.error(err);
  }
  // done
});

`fs.renameSync()` は同期バージョンです。

const fs = require('node:fs');

try {
  fs.renameSync('/Users/joe', '/Users/roger');
} catch (err) {
  console.error(err);
}

`fsPromises.rename()` は Promise ベースのバージョンです。

const fs = require('node:fs/promises');

async function example() {
  try {
    await fs.rename('/Users/joe', '/Users/roger');
  } catch (err) {
    console.log(err);
  }
}
example();

フォルダの削除

`fs.rmdir()`、`fs.rmdirSync()`、または `fsPromises.rmdir()` を使用してフォルダを削除します。

const fs = require('node:fs');

fs.rmdir(dir, err => {
  if (err) {
    throw err;
  }

  console.log(`${dir} is deleted!`);
});

内容を含むフォルダを削除するには、`{ recursive: true }` オプションを使用して `fs.rm()` を使用して、内容を再帰的に削除します。

`{ recursive: true, force: true }` にすると、フォルダが存在しない場合でも例外が無視されます。

const fs = require('node:fs');

fs.rm(dir, { recursive: true, force: true }, err => {
  if (err) {
    throw err;
  }

  console.log(`${dir} is deleted!`);
});