path: the dot will be added(path.format) if it is not specified in ext

PR-URL: #44349 Fixes: #44343 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]>
nodejs · Oct 10, 2022 · 22c39b1 · 22c39b1
1 parent 76229fc
commit 22c39b1
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/doc/api/path.md b/doc/api/path.md
@@ -206,6 +206,10 @@ A [`TypeError`][] is thrown if `path` is not a string.
 
 <!-- YAML
 added: v0.11.15
+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/44349
+    description: The dot will be added if it is not specified in `ext`.
 -->
 
 * `pathObject` {Object} Any JavaScript object having the following properties:
@@ -255,6 +259,14 @@ path.format({
   ext: '.txt'
 });
 // Returns: '/file.txt'
+
+// The dot will be added if it is not specified in `ext`.
+path.format({
+  root: '/',
+  name: 'file',
+  ext: 'txt'
+});
+// Returns: '/file.txt'
 ```
 
 On Windows:

diff --git a/lib/path.js b/lib/path.js
@@ -127,6 +127,10 @@ function normalizeString(path, allowAboveRoot, separator, isPathSeparator) {
   return res;
 }
 
+function formatExt(ext) {
+  return ext ? `${ext[0] === '.' ? '' : '.'}${ext}` : '';
+}
+
 /**
  * @param {string} sep
  * @param {{
@@ -142,7 +146,7 @@ function _format(sep, pathObject) {
   validateObject(pathObject, 'pathObject');
   const dir = pathObject.dir || pathObject.root;
   const base = pathObject.base ||
-    `${pathObject.name || ''}${pathObject.ext || ''}`;
+    `${pathObject.name || ''}${formatExt(pathObject.ext)}`;
   if (!dir) {
     return base;
   }

diff --git a/test/parallel/test-path-parse-format.js b/test/parallel/test-path-parse-format.js
@@ -224,3 +224,7 @@ function checkFormat(path, testCases) {
     });
   });
 }
+
+// See https://github.com/nodejs/node/issues/44343
+assert.strictEqual(path.format({ name: 'x', ext: 'png' }), 'x.png');
+assert.strictEqual(path.format({ name: 'x', ext: '.png' }), 'x.png');