Merge pull request #331 from gosukiwi/master

Allow to save hidden files in Windows

Author: sadick254

package.json

@@ -55,7 +55,8 @@
     "pathwatcher": "^8.1.0",
     "serializable": "^1.0.3",
     "superstring": "^2.4.2",
-    "underscore-plus": "^1.0.0"
+    "underscore-plus": "^1.0.0",
+    "winattr": "^3.0.0"
   },
   "standard": {
     "env": {

spec/text-buffer-io-spec.js

@@ -9,6 +9,7 @@ const TextBuffer = require('../src/text-buffer')
 const {TextBuffer: NativeTextBuffer} = require('superstring')
 const fsAdmin = require('fs-admin')
 const pathwatcher = require('pathwatcher')
+const winattr = require('winattr')
 
 process.on('unhandledRejection', console.error)
 
@@ -447,7 +448,7 @@ describe('TextBuffer IO', () => {
       })
     })
 
-    describe('when a permission error occurs', () => {
+    describe('when a permission error occurs (not Windows)', () => {
       if (process.platform === 'win32') return
 
       beforeEach(() => {
@@ -493,6 +494,21 @@ describe('TextBuffer IO', () => {
         })
       })
     })
+
+    describe('when a permission error occurs (Windows)', () => {
+      if (process.platform !== 'win32') return
+
+      it('can bypass hidden files', async done => {
+        winattr.setSync(filePath, { hidden: true })
+
+        buffer.setText('I just wrote to a hidden file in Windows!')
+        await buffer.save()
+
+        expect(fs.readFileSync(filePath, 'utf8')).toBe('I just wrote to a hidden file in Windows!')
+        expect(winattr.getSync(filePath).hidden).toBe(true)
+        done()
+      })
+    })
   })
 
   describe('.saveAs', () => {

src/text-buffer.js

@@ -1927,16 +1927,28 @@ class TextBuffer {
       try {
         await this.buffer.save(destination, this.getEncoding())
       } catch (error) {
-        const canEscalate = process.platform === 'darwin' || process.platform === 'linux'
-        if (error.code === 'EACCES' && destination === filePath && canEscalate) {
+        if (error.code !== 'EACCES' || destination !== filePath) throw error
+
+        const isWindows = process.platform === 'win32'
+        if (isWindows) {
+          const winattr = getPromisifiedWinattr()
+          const attrs = await winattr.get(filePath)
+          if (!attrs.hidden) throw error
+
+          try {
+            await winattr.set(filePath, { hidden: false })
+            await this.buffer.save(filePath, this.getEncoding())
+            await winattr.set(filePath, { hidden: true })
+          } catch (_) {
+            throw error
+          }
+        } else {
           const fsAdmin = require('fs-admin')
           try {
             await this.buffer.save(fsAdmin.createWriteStream(filePath), this.getEncoding())
           } catch (_) {
             throw error
           }
-        } else {
-          throw error
         }
       }
     } finally {
@@ -2601,4 +2613,18 @@ class SearchCallbackArgument {
   }
 }
 
+let _winattr = null
+const getPromisifiedWinattr = function () {
+  if (_winattr === null) {
+    const { promisify } = require('util')
+    const winattr = require('winattr')
+    _winattr = {
+      set: promisify(winattr.set),
+      get: promisify(winattr.get)
+    }
+  }
+
+  return _winattr
+}
+
 module.exports = TextBuffer