Module path Node.js: path.join vs path.resolve

path.join() menggabungkan segmen path dengan separator yang benar dan merapikan .. serta slash ganda, tetapi tetap membiarkan hasilnya relatif kalau kamu mulai dengan segmen relatif. path.resolve() melakukan pekerjaan yang sama dari kanan ke kiri dan selalu mengembalikan path absolut: ia mulai dari current working directory, dan segmen absolut mana pun di tengah jalan memulai ulang path-nya. Pakai join untuk menyusun path, dan resolve saat kamu butuh path absolut.

const path = require('path');

console.log(path.join('users', 'ada', 'notes.txt'));
console.log(path.join('users', 'ada', '..', 'grace', 'todo.txt'));
console.log(path.join('/srv/app/', '/public/', 'index.html'));
console.log(path.join('src', '', 'lib//utils.js'));

Hasilnya users/ada/notes.txt, lalu users/grace/todo.txt (.. menghapus ada), lalu /srv/app/public/index.html dan src/lib/utils.js: slash berlebih dan segmen kosong hilang. join tidak pernah menganggap /public/ sebagai awal yang baru; itu hanya segmen berikutnya.

path.join vs path.resolve

Perbedaannya terlihat saat sebuah segmen diawali / atau saat segmen pertama relatif:

const path = require('path');

console.log('join:   ', path.join('/srv/app', '/public', 'img'));
console.log('resolve:', path.resolve('/srv/app', '/public', 'img'));

console.log('join:   ', path.join('/srv/app', '../logs'));
console.log('resolve:', path.resolve('/srv/app', '../logs'));

const rel = path.join('public', 'index.html');
const abs = path.resolve('public', 'index.html');
console.log(rel, path.isAbsolute(rel));
console.log(path.isAbsolute(abs), path.relative(process.cwd(), abs));

Dengan /public di tengah, join menghasilkan /srv/app/public/img, sedangkan resolve membuang semua yang ada sebelumnya dan menghasilkan /public/img; keduanya menangani .. dengan cara yang sama. Dua baris terakhir menunjukkan bahwa join membiarkan public/index.html tetap relatif, sedangkan resolve membuatnya absolut dengan menaruh folder saat ini di depannya.

basename, dirname, extname dan parse

Fungsi-fungsi ini membongkar sebuah path. Mereka hanya melihat string-nya: file-nya tidak harus ada.

const path = require('path');

const file = '/home/ada/photos/cat.final.jpg';

console.log(path.basename(file));
console.log(path.basename(file, '.jpg'));
console.log(path.dirname(file));
console.log(path.extname(file));
console.log(JSON.stringify(path.parse(file)));

Hasilnya cat.final.jpg, cat.final, /home/ada/photos, dan .jpg: extname hanya mengambil bagian setelah titik terakhir. path.parse mengembalikan semuanya sekaligus (root, dir, base, ext, name), dan path.format mengubah object seperti itu kembali menjadi string.

__dirname dan __filename

Di file CommonJS, __dirname adalah path absolut dari folder yang berisi file itu, dan __filename adalah file itu sendiri. Path relatif seperti 'data.json' relatif terhadap tempat user menjalankan node, dan langsung rusak begitu ada yang menjalankan script-mu dari folder lain. Susun path dari __dirname saja:

const fs = require('fs');
const path = require('path');

const configPath = path.join(__dirname, 'config.json');

fs.writeFileSync(configPath, '{ "theme": "dark" }'); // setup
const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));

console.log(path.basename(configPath), config.theme);
console.log(path.relative(__dirname, __filename));

Hasilnya config.json dark dan index.js. Path lengkapnya berbeda di setiap mesin, dan justru karena itu kamu menyusunnya dengan path.join(__dirname, ...), bukan mengetiknya.

__dirname di ES module: import.meta.dirname

ES module tidak punya __dirname; memakainya melempar ReferenceError: __dirname is not defined in ES module scope. Sejak Node.js 20.11, import.meta.dirname dan import.meta.filename menggantikannya:

import path from 'node:path';

const dataFile = path.join(import.meta.dirname, 'data', 'users.json');

console.log(path.basename(import.meta.filename));
console.log(path.relative(import.meta.dirname, dataFile));

Hasilnya index.js dan data/users.json. Di versi Node.js sebelum 20.11, ambil foldernya dari URL module: path.dirname(fileURLToPath(import.meta.url)), dengan fileURLToPath dari node:url.

Kenapa tidak menggabungkan path dengan string

'data' + '/' + file bekerja di macOS dan Linux, lalu gagal di Windows, yang separator-nya \, dan tidak menangani .., slash ganda, atau slash yang hilang. path memakai aturan sistem tempat ia berjalan. Kamu bisa melihat hasil versi Windows dari mesin mana pun dengan path.win32:

const path = require('path');

path.posix.join('users', 'ada', 'notes.txt'); // 'users/ada/notes.txt'
path.win32.join('users', 'ada', 'notes.txt'); // 'users\\ada\\notes.txt'
path.sep;                                     // '/' on macOS and Linux, '\\' on Windows

Berikan hasil path.join ke fs.readFile dan kode yang sama membaca file-nya di setiap sistem.

Kesalahan umum

Mengira extname paham ekstensi ganda. path.extname('archive.tar.gz') bernilai '.gz', dan dotfile seperti .env tidak punya ekstensi sama sekali: path.extname('.env') bernilai ''. Cek sendiri akhiran namanya saat seluruh akhiran itu penting.

Mengandalkan join untuk menjaga user tetap di dalam folder. path.join('/srv/app', '../../etc/passwd') bernilai '/etc/passwd'. Sebelum membaca file yang namanya berasal dari request, resolve path-nya dan cek bahwa path itu masih diawali folder milikmu.