Convert to esm/typescript. (#216)

* add typescript configuration

* drop 'use strict' from tests

* convert tests to esm

* migrate tests to vitest

* convert implementation to typescript

* drop node 14 support

* Update README.md

* Update package.json

* Update lockfile

---------

Co-authored-by: Simon Boudrias <admin@simonboudrias.com>

.eslintignore

@@ -0,0 +1,2 @@
+dist
+coverage

.github/workflows/test.yml

@@ -10,20 +10,20 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [18.x, 16.x, 14.x]
+        node-version: [18.x, 16.x]
         os: [ubuntu-latest, windows-latest, macos-latest]
 
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-node@v2
-      with:
-        node-version: ${{ matrix.node-version }}
-    - name: Install and test
-      run: |
-        node --version
-        npm ci
-        npm test
-    - name: Upload code coverage
-      uses: codecov/codecov-action@v3
-      with:
-        file: ./coverage/coverage-final.json
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install and test
+        run: |
+          node --version
+          npm ci
+          npm test
+      - name: Upload code coverage
+        uses: codecov/codecov-action@v3
+        with:
+          file: ./coverage/coverage-final.json

.gitignore

@@ -1,4 +1,5 @@
 node_modules/
 coverage/
+dist/
 .settings
 .project

.prettierignore

@@ -0,0 +1,2 @@
+dist
+coverage

.prettierrc

@@ -1,5 +1,5 @@
 {
   "endOfLine": "auto",
   "singleQuote": true,
-  "printWidth": 90
+  "printWidth": 120
 }

README.md

@@ -9,10 +9,10 @@ File edition helpers working on top of [mem-fs](https://github.com/SBoudrias/mem
 ## Usage
 
 ```js
-import memFs from 'mem-fs';
+import { create as createMemFs } from 'mem-fs';
 import editor from 'mem-fs-editor';
 
-const store = memFs.create();
+const store = createMemFs();
 const fs = editor.create(store);
 
 fs.write('somefile.js', 'var a = 1;');

__tests__/__snapshots__/commit.js.snap → __tests__/__snapshots__/commit.spec.ts.snap

@@ -1,6 +1,6 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`#commit() should match snapshot 1`] = `
+exports[`#commit() > should match snapshot 1`] = `
 {
   "file-0.txt": {
     "contents": "foo",
@@ -405,7 +405,7 @@ exports[`#commit() should match snapshot 1`] = `
 }
 `;
 
-exports[`#copy() and #commit() should match snapshot 1`] = `
+exports[`#copy() and #commit() > should match snapshot 1`] = `
 {
   "[file].txt": {
     "contents": "foo
@@ -461,7 +461,7 @@ exports[`#copy() and #commit() should match snapshot 1`] = `
   },
   "file.json": {
     "contents": "{
-  "foo": "bar"
+  \\"foo\\": \\"bar\\"
 }
 ",
     "stateCleared": "modified",
@@ -474,7 +474,7 @@ exports[`#copy() and #commit() should match snapshot 1`] = `
 }
 `;
 
-exports[`#copyTpl() and #commit() should match snapshot 1`] = `
+exports[`#copyTpl() and #commit() > should match snapshot 1`] = `
 {
   "[file].txt": {
     "contents": "foo
@@ -531,7 +531,7 @@ exports[`#copyTpl() and #commit() should match snapshot 1`] = `
   },
   "file.json": {
     "contents": "{
-  "foo": "bar"
+  \\"foo\\": \\"bar\\"
 }
 ",
     "stateCleared": "modified",

__tests__/__snapshots__/dump.js.snap → __tests__/__snapshots__/dump.spec.ts.snap

@@ -1,6 +1,6 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`#dump() should match snapshot 1`] = `
+exports[`#dump() > should match snapshot 1`] = `
 {
   "foo/committed": {
     "contents": "committed",
@@ -31,7 +31,7 @@ exports[`#dump() should match snapshot 1`] = `
 }
 `;
 
-exports[`#dump() with a glob pattern should return files that matches the pattern and have state or stateCleared 1`] = `
+exports[`#dump() > with a glob pattern > should return files that matches the pattern and have state or stateCleared 1`] = `
 {
   "foo/committed": {
     "contents": "committed",

__tests__/append-tpl.spec.ts

@@ -0,0 +1,44 @@
+import { describe, beforeEach, it, expect } from 'vitest';
+import os from 'os';
+import { type MemFsEditor, create } from '../lib/index.js';
+import { create as createMemFs } from 'mem-fs';
+import { getFixture } from './fixtures.js';
+
+describe('#appendTpl()', () => {
+  let fs: MemFsEditor;
+
+  beforeEach(() => {
+    fs = create(createMemFs());
+  });
+
+  it('appends to file and processes contents as underscore template', () => {
+    const filepath = getFixture('file-a.txt');
+    const orginalContent = fs.read(filepath)!.toString();
+    const contentPath = getFixture('file-tpl.txt');
+    const contents = fs.read(contentPath)!;
+    fs.appendTpl(filepath, contents, {
+      name: 'bar',
+    });
+    expect(fs.read(filepath)).toBe(orginalContent + 'bar' + os.EOL);
+  });
+
+  it('allows setting custom template delimiters', () => {
+    const filepath = getFixture('file-a.txt');
+    const orginalContent = fs.read(filepath)!.toString();
+    const contentPath = getFixture('file-tpl-custom-delimiter.txt');
+    const contents = fs.read(contentPath)!;
+    fs.appendTpl(filepath, contents, { name: 'bar' }, { delimiter: '?' });
+    expect(fs.read(filepath)).toBe(orginalContent + 'bar' + os.EOL);
+  });
+
+  it('throws an exception when no template data passed', () => {
+    const f = () => {
+      const filepath = getFixture('file-a.txt');
+      const contentPath = getFixture('file-tpl.txt');
+      const contents = fs.read(contentPath)!;
+      fs.appendTpl(filepath, contents);
+    };
+
+    expect(f).toThrow(ReferenceError);
+  });
+});

__tests__/append.js → __tests__/append.spec.ts

@@ -1,16 +1,15 @@
-'use strict';
-
-const os = require('os');
-const editor = require('..');
-const memFs = require('mem-fs');
+import { describe, beforeEach, it, expect } from 'vitest';
+import os from 'os';
+import { MemFsEditor, create } from '../lib/index.js';
+import { create as createMemFs } from 'mem-fs';
 
 describe('#write()', () => {
   let store;
-  let fs;
+  let fs: MemFsEditor;
 
   beforeEach(() => {
-    store = memFs.create();
-    fs = editor.create(store);
+    store = createMemFs();
+    fs = create(store);
   });
 
   it('appends new content to new file', () => {

__tests__/commit-file-async.js → __tests__/commit-file-async.spec.ts

@@ -1,12 +1,10 @@
-'use strict';
-
-const filesystem = require('fs');
-const os = require('os');
-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');
+import { describe, beforeEach, it, expect, afterEach } from 'vitest';
+import filesystem from 'fs';
+import os from 'os';
+import path from 'path';
+import { create as createMemFs } from 'mem-fs';
+import sinon from 'sinon';
+import { type MemFsEditor, type MemFsEditorFile, create } from '../lib/index.js';
 
 const rmSync = filesystem.rmSync || filesystem.rmdirSync;
 
@@ -22,22 +20,22 @@ describe('#commitFileAsync()', () => {
   const outputDir = path.join(outputRoot, 'output');
   const filename = path.join(outputDir, 'file.txt');
   const filenameNew = path.join(outputDir, 'file-new.txt');
-  let newFile;
+  let newFile: MemFsEditorFile;
 
   let store;
-  let fs;
+  let fs: MemFsEditor;
 
   beforeEach(() => {
-    store = memFs.create();
+    store = createMemFs();
     sinon.spy(store, 'add');
 
-    fs = editor.create(store);
+    fs = create(store);
     fs.write(filename, 'foo');
 
     newFile = {
       path: filenameNew,
       contents: Buffer.from('bar'),
-      [STATE]: STATE_MODIFIED,
+      state: 'modified',
     };
 
     expect(store.add.callCount).toEqual(1);
@@ -67,7 +65,7 @@ describe('#commitFileAsync()', () => {
   it("doesn't commit an unmodified file", async () => {
     await fs.commitFileAsync({
       ...newFile,
-      [STATE]: undefined,
+      state: undefined,
     });
     expect(filesystem.existsSync(filenameNew)).toBe(false);
   });
@@ -88,7 +86,7 @@ describe('#commitFileAsync()', () => {
     filesystem.writeFileSync(filenameNew, 'foo');
     await fs.commitFileAsync({
       ...newFile,
-      [STATE]: STATE_DELETED,
+      state: 'deleted',
     });
     expect(filesystem.existsSync(filenameNew)).toBe(false);
   });