Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Adding note about empty strings in path module #2106

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion doc/api/path.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ Example:
// returns
'/foo/bar/baz/asdf'

*Note:* If the path string passed as argument is a zero-length string then `'.'`
will be returned, which represents the current working directory.

## path.join([path1][, path2][, ...])

Join all arguments together and normalize the resulting path.
Expand All @@ -39,6 +42,11 @@ Example:
// throws exception
TypeError: Arguments to path.join must be strings

*Note:* If the arguments to `join` have zero-length strings, unlike other path
module functions, they will be ignored. If the joined path string is a
zero-length string then `'.'` will be returned, which represents the
current working directory.

## path.resolve([from ...], to)

Resolves `to` to an absolute path.
Expand Down Expand Up @@ -78,6 +86,9 @@ Examples:
// if currently in /home/myself/iojs, it returns
'/home/myself/iojs/wwwroot/static_files/gif/image.gif'

*Note:* If the arguments to `resolve` have zero-length strings then the current
working directory will be used instead of them.

## path.isAbsolute(path)

Determines whether `path` is an absolute path. An absolute path will always
Expand All @@ -94,9 +105,13 @@ Windows examples:

path.isAbsolute('//server') // true
path.isAbsolute('C:/foo/..') // true
path.isAbsolute('bar\\baz') // false
path.isAbsolute('bar\\baz') // false
path.isAbsolute('.') // false

*Note:* If the path string passed as parameter is a zero-length string, unlike
other path module functions, it will be used as-is and `false` will be
returned.

## path.relative(from, to)

Solve the relative path from `from` to `to`.
Expand All @@ -117,6 +132,10 @@ Examples:
// returns
'../../impl/bbb'

*Note:* If the arguments to `relative` have zero-length strings then the current
working directory will be used instead of the zero-length strings. If
both the paths are the same then a zero-length string will be returned.

## path.dirname(p)

Return the directory name of a path. Similar to the Unix `dirname` command.
Expand Down
35 changes: 35 additions & 0 deletions test/parallel/test-path-zero-length-strings.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
'use strict';

// These testcases are specific to one uncommon behaviour in path module. Few
// of the functions in path module, treat '' strings as current working
// directory. This test makes sure that the behaviour is intact between commits.
// See: https://github.com/nodejs/io.js/pull/2106

const common = require('../common');
const assert = require('assert');
const path = require('path');
const pwd = process.cwd();

// join will internally ignore all the zero-length strings and it will return
// '.' if the joined string is a zero-length string.
assert.equal(path.join(''), '.');
assert.equal(path.join('', ''), '.');
assert.equal(path.join(pwd), pwd);
assert.equal(path.join(pwd, ''), pwd);

// normalize will return '.' if the input is a zero-length string
assert.equal(path.normalize(''), '.');
assert.equal(path.normalize(pwd), pwd);

// Since '' is not a valid path in any of the common environments, return false
assert.equal(path.isAbsolute(''), false);

// resolve, internally ignores all the zero-length strings and returns the
// current working directory
assert.equal(path.resolve(''), pwd);
assert.equal(path.resolve('', ''), pwd);

// relative, internally calls resolve. So, '' is actually the current directory
assert.equal(path.relative('', pwd), '');
assert.equal(path.relative(pwd, ''), '');
assert.equal(path.relative(pwd, pwd), '');