Disallow string concatenation when using __dirname and __filename (no-path-concat)

当使用 _dirname_filename 时不允许字符串拼接 (no-path-concat)

In Node.js, the __dirname and __filename global variables contain the directory path and the file path of the currently executing script file, respectively. Sometimes, developers try to use these variables to create paths to other files, such as:

在 Node.js 中,全局变量 _dirname_filename 分别代表当前执行脚本的目录路径以及文件路径。有时候开发者尝试使用这些变量去创建路径或者其他的文件,比如:

var fullPath = __dirname + "/foo.js";

However, there are a few problems with this. First, you can’t be sure what type of system the script is running on. Node.js can be run on any computer, including Windows, which uses a different path separator. It’s very easy, therefore, to create an invalid path using string concatenation and assuming Unix-style separators. There’s also the possibility of having double separators, or otherwise ending up with an invalid path.

但是,这样做存在一些问题。首先,不能确定脚本在哪种系统中运行。Node.js 可以在任何电脑,包括windows,它使用不同路径分隔符。这是很容易的事情,然而很可能会使用 Unix 路径分隔符拼接处的路径会创建出一个无效的路径。也有可能有两种分隔符或者拼接出其他无效的路径。

In order to avoid any confusion as to how to create the correct path, Node.js provides the path module. This module uses system-specific information to always return the correct value. So you can rewrite the previous example as:

为了避免混淆并且创建正确的路径,Node.js 提供了 path模块。这个模块使用特殊的系统信息来返回正确的值。可以修改下面的例子,例如:

var fullPath = path.join(__dirname, "foo.js");

This example doesn’t need to include separators as path.join() will do it in the most appropriate manner. Alternately, you can use path.resolve() to retrieve the fully-qualified path:

这个例子不需要引入分隔符因为 path.join() 将会用最合适的方式引入分隔符。或者,你可以使用 path.resolve() 得到有效的完整路径。

var fullPath = path.resolve(__dirname, "foo.js");

Both path.join() and path.resolve() are suitable replacements for string concatenation wherever file or directory paths are being created.

path.jonin()path.reslove() 非常适合替换字符串拼接来创建文件和目录路径。

Rule Details

This rule aims to prevent string concatenation of directory paths in Node.js

该规则旨在阻止在 Node.js 中使用字符串拼接路径。

Examples of incorrect code for this rule:

错误 代码示例:

/*eslint no-path-concat: "error"*/

var fullPath = __dirname + "/foo.js";

var fullPath = __filename + "/foo.js";

Examples of correct code for this rule:

正确 代码示例:

/*eslint no-path-concat: "error"*/

var fullPath = dirname + "/foo.js";

When Not To Use It

If you want to allow string concatenation of path names.

当你想允许字符串拼接路径时,可以关闭此规则。

Version

This rule was introduced in ESLint 0.4.0.

该规则在 ESLint 0.4.0 中引入。

Resources


+