feat: update file permission on commit

__tests__/commit-file-async.js

@@ -6,14 +6,23 @@ const path = require('path');
 const memFs = require('mem-fs');
 const sinon = require('sinon');
 const editor = require('..');
+const { STATE, STATE_MODIFIED, STATE_DELETED } = require('../lib/state');
 
 const rmSync = filesystem.rmSync || filesystem.rmdirSync;
 
-describe('#commit()', () => {
-  const outputRoot = path.join(os.tmpdir(), 'mem-fs-editor-test');
+// Permission mode are handled differently by windows.
+// More information can be found at Node source https://github.com/nodejs/node/blob/8cf33850bea691d8c53b2d4175c959c8549aa76c/deps/uv/src/win/fs.c#L1743-L1761
+// Windows only changes readonly flag and ignores user/group.
+// Use only the modes that are available at Windows.
+const READ_WRITE_MODE = 0o666;
+const READ_ONLY_MODE = 0o444;
+
+describe('#commitFileAsync()', () => {
+  const outputRoot = path.join(os.tmpdir(), 'mem-fs-editor-test' + Math.random());
   const outputDir = path.join(outputRoot, 'output');
   const filename = path.join(outputDir, 'file.txt');
   const filenameNew = path.join(outputDir, 'file-new.txt');
+  let newFile;
 
   let store;
   let fs;
@@ -25,25 +34,87 @@ describe('#commit()', () => {
     fs = editor.create(store);
     fs.write(filename, 'foo');
 
+    newFile = {
+      path: filenameNew,
+      contents: Buffer.from('bar'),
+      [STATE]: STATE_MODIFIED,
+    };
+
     expect(store.add.callCount).toEqual(1);
   });
 
   afterEach(() => {
-    rmSync(outputRoot, { recursive: true });
+    if (filesystem.existsSync(outputRoot)) {
+      rmSync(outputRoot, { recursive: true });
+    }
   });
 
-  it('triggers callback when done', async () => {
+  it('writes a modified file to disk', async () => {
     await fs.commitFileAsync(store.get(filename));
     expect(filesystem.readFileSync(filename).toString()).toEqual('foo');
   });
 
   it('adds non existing file to store', async () => {
+    await fs.commitFileAsync(newFile);
+    expect(store.add.callCount).toEqual(2);
+  });
+
+  it('writes non existing file to disk', async () => {
+    await fs.commitFileAsync(newFile);
+    expect(filesystem.existsSync(filenameNew)).toBe(true);
+  });
+
+  it("doesn't commit an unmodified file", async () => {
     await fs.commitFileAsync({
-      path: filenameNew,
-      contents: Buffer.from('bar'),
-      state: 'modified',
+      ...newFile,
+      [STATE]: undefined,
     });
-    expect(store.add.callCount).toEqual(2);
+    expect(filesystem.existsSync(filenameNew)).toBe(false);
+  });
+
+  it('throws if the file is a directory', async () => {
+    filesystem.mkdirSync(filenameNew, { recursive: true });
+    await expect(fs.commitFileAsync(newFile)).rejects.toThrow();
+  });
+
+  it('throws if the directory is a file', async () => {
+    filesystem.mkdirSync(outputRoot, { recursive: true });
+    filesystem.writeFileSync(path.dirname(filenameNew), 'foo');
+    await expect(fs.commitFileAsync(newFile)).rejects.toThrow();
+  });
+
+  it('deletes a file', async () => {
+    filesystem.mkdirSync(path.dirname(filenameNew), { recursive: true });
+    filesystem.writeFileSync(filenameNew, 'foo');
+    await fs.commitFileAsync({
+      ...newFile,
+      [STATE]: STATE_DELETED,
+    });
+    expect(filesystem.existsSync(filenameNew)).toBe(false);
+  });
+
+  it('sets file permission', async () => {
+    await fs.commitFileAsync({
+      ...newFile,
+      stat: { mode: READ_ONLY_MODE },
+    });
+    // eslint-disable-next-line no-bitwise
+    expect(filesystem.statSync(filenameNew).mode & 0o777).toEqual(READ_ONLY_MODE);
+  });
+
+  it('updates file permission', async () => {
+    await fs.commitFileAsync({
+      ...newFile,
+      stat: { mode: READ_WRITE_MODE },
+    });
+
+    await fs.commitFileAsync({
+      ...newFile,
+      stat: { mode: READ_ONLY_MODE },
+    });
+
+    // eslint-disable-next-line no-bitwise
+    expect(filesystem.statSync(filenameNew).mode & 0o777).toEqual(READ_ONLY_MODE);
   });
 
   it("doesn't readd same file to store", async () => {

lib/actions/commit-file-async.js

@@ -29,6 +29,14 @@ async function write(file) {
   }
 
   await fs.writeFile(file.path, file.contents, options);
+
+  if (options.mode !== undefined) {
+    const { mode } = await fs.stat(file.path);
+    // eslint-disable-next-line no-bitwise
+    if ((mode & 0o777) !== (options.mode & 0o777)) {
+      await fs.chmod(file.path, options.mode);
+    }
+  }
 }
 
 async function remove(file) {