Local variable name shadows variable in outer scope JS-0123
Bug risk
Minor
10 days ago
—
a year old
'nextConfig' is already declared in the upper scope on line 31 column 7
136 * @param {T} nextConfig
137 * @returns {T}
138 */
139const defineSentryConfig = (nextConfig) =>140 withSentryConfig(
141 nextConfig,
142 {'path' is already declared in the upper scope on line 11 column 8
25 * @param {string} path
26 * @returns Full URL or relative path
27 */
28const getUrl = (path) => { 29 if (typeof path !== 'string') throw new Error('Path must be a string')
30 const parsedPath = path.startsWith('/') ? path : `/${path}`
31 if (typeof window !== 'undefined') return parsedPath // browser should use relative url
Description
Two variables can have the same name if they're declared in different scopes.
In the example below, the parameter x is said to "shadow" the variable x declared above it.
The outer x can no longer be accessed inside the sum function.
const x = 1
function add(x, y) {
return x + y
}
While shadowing does not cause any problems most of the time, it does make the code harder to read and understand. We highly recommend against shadowing. However, if you want to shadow some variable name and don't want DeepSource to flag it, add a skipcq comment alongside an explanation:
const x = 1
function add(x, y) { // skipcq: JS-0123 - `x` can be safely shadowed
return x + y
}
If you want to disable this issue project-wide, you can add it to the list of disabled issues in the project dashboard.
Bad Practice
const file = "data.txt"
function readFile(file) {
// The parameter `file` shadows the toplevel variable `file`.
if (fs.existsSync(file)) {
return fs.readFileSync(file)
}
return null
}
Recommended
// Prefer variable names that are distinct and convey as much
// meaning as possible.
const dataFile = "data.txt"
function readFile(filePath) {
if (fs.existsSync(filePath)) {
return fs.readFileSync(filePath)
}
return null
}
Alternatively:
const file = "data.txt"
function readFile(file) { // skipcq: JS-0123 - Shadowing is safe here
// ...
}