path: add dot for path format if absent

nodejs · Aug 23, 2022 · a2d9825 · a2d9825
1 parent 937520a
commit a2d9825
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/doc/api/path.md b/doc/api/path.md
@@ -255,6 +255,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');