Merge pull request #144 from raszi/gh-143

prepend opts.dir || tmpDir to template if no path is given
raszi · Nov 27, 2017 · 31e3d70 · 31e3d70
2 parents 0f40c3e + 86f6ad4
commit 31e3d70
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -237,10 +237,14 @@ console.log('Dir: ', tmpobj.name);
 
 Creates a new temporary directory with mode `0700` and filename like `/tmp/tmp-nk2J1u`.
 
+IMPORTANT NOTE: template no longer accepts a path. Use the dir option instead if you
+require tmp to create your temporary filesystem object in a different place than the
+default `tmp.tmpdir`.
+
 ```javascript
 var tmp = require('tmp');
 
-tmp.dir({ template: '/tmp/tmp-XXXXXX' }, function _tempDirCreated(err, path) {
+tmp.dir({ template: 'tmp-XXXXXX' }, function _tempDirCreated(err, path) {
   if (err) throw err;
 
   console.log('Dir: ', path);
@@ -254,7 +258,7 @@ This will behave similarly to the asynchronous version.
 ```javascript
 var tmp = require('tmp');
 
-var tmpobj = tmp.dirSync({ template: '/tmp/tmp-XXXXXX' });
+var tmpobj = tmp.dirSync({ template: 'tmp-XXXXXX' });
 console.log('Dir: ', tmpobj.name);
 ```
 

diff --git a/lib/tmp.js b/lib/tmp.js
@@ -121,7 +121,11 @@ function _generateTmpName(opts) {
 
   // mkstemps like template
   if (opts.template) {
-    return opts.template.replace(TEMPLATE_PATTERN, _randomChars(6));
+    var template = opts.template;
+    // make sure that we prepend the tmp path if none was given
+    if (path.basename(template) == template)
+      template = path.join(opts.dir || tmpDir, template);
+    return template.replace(TEMPLATE_PATTERN, _randomChars(6));
   }
 
   // prefix and postfix

diff --git a/test/dir-sync-test.js b/test/dir-sync-test.js
@@ -56,7 +56,7 @@ vows.describe('Synchronous directory creation').addBatch({
 
   'when using template': {
     topic: function () {
-      return tmp.dirSync({ template: path.join(tmp.tmpdir, 'clike-XXXXXX-postfix') });
+      return tmp.dirSync({ template: 'clike-XXXXXX-postfix' });
     },
 
     'should return with a name': Test.assertNameSync,

diff --git a/test/dir-test.js b/test/dir-test.js
@@ -57,7 +57,7 @@ vows.describe('Directory creation').addBatch({
 
   'when using template': {
     topic: function () {
-      tmp.dir({ template: path.join(tmp.tmpdir, 'clike-XXXXXX-postfix') }, this.callback);
+      tmp.dir({ template: 'clike-XXXXXX-postfix' }, this.callback);
     },
 
     'should not return with error': assert.isNull,

diff --git a/test/file-sync-test.js b/test/file-sync-test.js
@@ -97,7 +97,7 @@ vows.describe('Synchronous file creation').addBatch({
 
   'when using template': {
     topic: function () {
-      return tmp.fileSync({ template: path.join(tmp.tmpdir, 'clike-XXXXXX-postfix') });
+      return tmp.fileSync({ template: 'clike-XXXXXX-postfix' });
     },
 
     'should return with a name': Test.assertNameSync,

diff --git a/test/file-test.js b/test/file-test.js
@@ -100,7 +100,7 @@ vows.describe('File creation').addBatch({
 
   'when using template': {
     topic: function () {
-      tmp.file({ template: path.join(tmp.tmpdir, 'clike-XXXXXX-postfix') }, this.callback);
+      tmp.file({ template: 'clike-XXXXXX-postfix' }, this.callback);
     },
 
     'should not return with an error': assert.isNull,

diff --git a/test/name-test.js b/test/name-test.js
@@ -40,7 +40,7 @@ vows.describe('Name creation').addBatch({
 
   'when using template': {
     topic: function () {
-      tmp.tmpName({ template: path.join(tmp.tmpdir, 'clike-XXXXXX-postfix') }, this.callback);
+      tmp.tmpName({ template: 'clike-XXXXXX-postfix' }, this.callback);
     },
 
     'should not return with error': assert.isNull,