Node.jsでのフォルダ操作

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

フォルダの存在確認

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

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

try {
  await fs.promises.access('/Users/joe');
} catch (err) {
  throw err;
}

新しいフォルダの作成

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

const fs = require('node:fs');
const folderName = '/Users/joe/test';

try {
  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).map(fileName => {
  return path.join(folderPath, fileName);
});

完全なパスを取得することもできます。

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

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

const fs = require('node:fs');
const isFile = fileName => !fileName.includes(path.sep);

fs.readdirSync(folderPath)
  .map(fileName => 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);
  }
});

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!`);
});