Publish fixes (#217)

* move lib folder to src. * fix publishing * export types * move nem-fs to dependencies. mem-fs is now required due to types and conflicts with v2 types. Since peerDependencies overrides dependencies, we cannot have peerDependencies safeguard anymore if we allow mem-fs-editor to run with mem-fs v2.
SBoudrias · Apr 18, 2023 · b32fd69 · b32fd69
1 parent 75eabea
commit b32fd69
Show file tree

Hide file tree

Showing 43 changed files with 31 additions and 40 deletions.
diff --git a/__tests__/append-tpl.spec.ts b/__tests__/append-tpl.spec.ts
@@ -1,6 +1,6 @@
 import { describe, beforeEach, it, expect } from 'vitest';
 import os from 'os';
-import { type MemFsEditor, create } from '../lib/index.js';
+import { type MemFsEditor, create } from '../src/index.js';
 import { create as createMemFs } from 'mem-fs';
 import { getFixture } from './fixtures.js';
 

diff --git a/__tests__/append.spec.ts b/__tests__/append.spec.ts
@@ -1,6 +1,6 @@
 import { describe, beforeEach, it, expect } from 'vitest';
 import os from 'os';
-import { MemFsEditor, create } from '../lib/index.js';
+import { MemFsEditor, create } from '../src/index.js';
 import { create as createMemFs } from 'mem-fs';
 
 describe('#write()', () => {

diff --git a/__tests__/commit-file-async.spec.ts b/__tests__/commit-file-async.spec.ts
@@ -4,7 +4,7 @@ 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';
+import { type MemFsEditor, type MemFsEditorFile, create } from '../src/index.js';
 
 const rmSync = filesystem.rmSync || filesystem.rmdirSync;
 

diff --git a/__tests__/commit.spec.ts b/__tests__/commit.spec.ts
@@ -4,8 +4,8 @@ import os from 'os';
 import path from 'path';
 import { create as createMemFs } from 'mem-fs';
 import sinon from 'sinon';
-import { MemFsEditor, create } from '../lib/index.js';
-import { createTransform } from '../lib/transform.js';
+import { MemFsEditor, create } from '../src/index.js';
+import { createTransform } from '../src/transform.js';
 import { getFixture } from './fixtures.js';
 
 const rmSync = filesystem.rmSync || filesystem.rmdirSync;

diff --git a/__tests__/copy-async.spec.ts b/__tests__/copy-async.spec.ts
@@ -3,7 +3,7 @@ import filesystem from 'fs';
 import os from 'os';
 import path from 'path';
 import sinon from 'sinon';
-import { MemFsEditor, create } from '../lib/index.js';
+import { MemFsEditor, create } from '../src/index.js';
 import { create as createMemFs } from 'mem-fs';
 import { getFixture } from './fixtures.js';
 

diff --git a/__tests__/copy-tpl-async.spec.ts b/__tests__/copy-tpl-async.spec.ts
@@ -1,7 +1,7 @@
 import { describe, beforeEach, it, expect } from 'vitest';
 import os from 'os';
 import path from 'path';
-import { type MemFsEditor, create } from '../lib/index.js';
+import { type MemFsEditor, create } from '../src/index.js';
 import { create as createMemFs } from 'mem-fs';
 import normalize from 'normalize-path';
 import { getFixture } from './fixtures.js';

diff --git a/__tests__/copy-tpl.spec.ts b/__tests__/copy-tpl.spec.ts
@@ -1,11 +1,11 @@
 import { describe, beforeEach, it, expect } from 'vitest';
 import os from 'os';
 import path from 'path';
-import { type MemFsEditor, create } from '../lib/index.js';
+import { type MemFsEditor, create } from '../src/index.js';
 import { create as createMemFs } from 'mem-fs';
 import normalize from 'normalize-path';
 import { getFixture } from './fixtures.js';
-import { CopyOptions } from '../lib/actions/copy.js';
+import { CopyOptions } from '../src/actions/copy.js';
 
 describe('#copyTpl()', () => {
   let store;

diff --git a/__tests__/copy.spec.ts b/__tests__/copy.spec.ts
@@ -3,7 +3,7 @@ import filesystem from 'fs';
 import os from 'os';
 import path, { dirname } from 'path';
 import sinon from 'sinon';
-import { type MemFsEditor, create } from '../lib/index.js';
+import { type MemFsEditor, create } from '../src/index.js';
 import { create as createMemFs } from 'mem-fs';
 import { getFixture } from './fixtures.js';
 import { fileURLToPath } from 'url';

diff --git a/__tests__/delete.spec.ts b/__tests__/delete.spec.ts
@@ -1,6 +1,6 @@
 import { describe, beforeEach, it, expect } from 'vitest';
 import path from 'path';
-import { type MemFsEditor, create } from '../lib/index.js';
+import { type MemFsEditor, create } from '../src/index.js';
 import { create as createMemFs } from 'mem-fs';
 import { getFixture } from './fixtures.js';
 

diff --git a/__tests__/dump.spec.ts b/__tests__/dump.spec.ts
@@ -3,7 +3,7 @@ import filesystem from 'fs';
 import os from 'os';
 import path from 'path';
 import { create as createMemFs } from 'mem-fs';
-import { type MemFsEditor, create } from '../lib/index.js';
+import { type MemFsEditor, create } from '../src/index.js';
 
 const rmSync = filesystem.rmSync || filesystem.rmdirSync;
 

diff --git a/__tests__/exists.spec.ts b/__tests__/exists.spec.ts
@@ -1,5 +1,5 @@
 import { describe, beforeEach, it, expect } from 'vitest';
-import { type MemFsEditor, create } from '../lib/index.js';
+import { type MemFsEditor, create } from '../src/index.js';
 import { create as createMemFs } from 'mem-fs';
 import { getFixture } from './fixtures.js';
 

diff --git a/__tests__/extend-json.spec.ts b/__tests__/extend-json.spec.ts
@@ -1,6 +1,6 @@
 import { describe, beforeEach, it } from 'vitest';
 import sinon from 'sinon';
-import { type MemFsEditor, create } from '../lib/index.js';
+import { type MemFsEditor, create } from '../src/index.js';
 import { create as createMemFs } from 'mem-fs';
 import { getFixture } from './fixtures.js';
 

diff --git a/__tests__/move.spec.ts b/__tests__/move.spec.ts
@@ -1,7 +1,7 @@
 import { describe, beforeEach, it, expect } from 'vitest';
 import os from 'os';
 import path from 'path';
-import { type MemFsEditor, create } from '../lib/index.js';
+import { type MemFsEditor, create } from '../src/index.js';
 import { create as createMemFs } from 'mem-fs';
 import { getFixture } from './fixtures.js';
 

diff --git a/__tests__/read-json.spec.ts b/__tests__/read-json.spec.ts
@@ -1,6 +1,6 @@
 import { describe, beforeEach, it, expect } from 'vitest';
 import sinon from 'sinon';
-import { type MemFsEditor, create } from '../lib/index.js';
+import { type MemFsEditor, create } from '../src/index.js';
 import { create as createMemFs } from 'mem-fs';
 import escape from 'escape-regexp';
 import { getFixture } from './fixtures.js';

diff --git a/__tests__/read.spec.ts b/__tests__/read.spec.ts
@@ -1,6 +1,6 @@
 import { describe, beforeEach, it, expect } from 'vitest';
 import os from 'os';
-import { type MemFsEditor, create } from '../lib/index.js';
+import { type MemFsEditor, create } from '../src/index.js';
 import { create as createMemFs } from 'mem-fs';
 import { getFixture } from './fixtures.js';
 

diff --git a/__tests__/state.spec.ts b/__tests__/state.spec.ts
@@ -14,7 +14,7 @@ import {
   setCommittedFile,
   setDeletedFileState,
   setModifiedFileState,
-} from '../lib/state.js';
+} from '../src/state.js';
 
 describe('state', () => {
   let file;

diff --git a/__tests__/util.spec.ts b/__tests__/util.spec.ts
@@ -2,7 +2,7 @@ import { describe, it, expect } from 'vitest';
 import filesystem from 'fs';
 import path from 'path';
 import sinon from 'sinon';
-import { getCommonPath, globify } from '../lib/util.js';
+import { getCommonPath, globify } from '../src/util.js';
 import normalize from 'normalize-path';
 import { getFixture } from './fixtures.js';
 

diff --git a/__tests__/write-json.spec.ts b/__tests__/write-json.spec.ts
@@ -1,6 +1,6 @@
 import { describe, beforeEach, it, expect } from 'vitest';
 import sinon from 'sinon';
-import { type MemFsEditor, create } from '../lib/index.js';
+import { type MemFsEditor, create } from '../src/index.js';
 import { create as createMemFs } from 'mem-fs';
 import { getFixture } from './fixtures.js';
 

diff --git a/__tests__/write.spec.ts b/__tests__/write.spec.ts
@@ -1,6 +1,6 @@
 import { describe, beforeEach, it, expect } from 'vitest';
 import sinon from 'sinon';
-import { type MemFsEditor, create } from '../lib/index.js';
+import { type MemFsEditor, create } from '../src/index.js';
 import { create as createMemFs } from 'mem-fs';
 import { getFixture } from './fixtures.js';
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -30,7 +30,7 @@
     }
   },
   "files": [
-    "lib"
+    "dist"
   ],
   "dependencies": {
     "@types/ejs": "^3.1.2",
@@ -40,20 +40,13 @@
     "ejs": "^3.1.9",
     "globby": "^13.1.4",
     "isbinaryfile": "^5.0.0",
+    "mem-fs": "^3.0.0",
     "minimatch": "^9.0.0",
     "multimatch": "^6.0.0",
     "normalize-path": "^3.0.0",
     "textextensions": "^5.13.0",
     "vinyl": "^3.0.0"
   },
-  "peerDependencies": {
-    "mem-fs": "^2.1.0"
-  },
-  "peerDependenciesMeta": {
-    "mem-fs": {
-      "optional": true
-    }
-  },
   "devDependencies": {
     "coveralls": "^3.0.3",
     "escape-regexp": "0.0.1",

diff --git a/lib/actions/append-tpl.ts → src/actions/append-tpl.ts b/lib/actions/append-tpl.ts → src/actions/append-tpl.ts
diff --git a/lib/actions/append.ts → src/actions/append.ts b/lib/actions/append.ts → src/actions/append.ts
diff --git a/lib/actions/commit-file-async.ts → src/actions/commit-file-async.ts b/lib/actions/commit-file-async.ts → src/actions/commit-file-async.ts
diff --git a/lib/actions/commit.ts → src/actions/commit.ts b/lib/actions/commit.ts → src/actions/commit.ts
diff --git a/lib/actions/copy-async.ts → src/actions/copy-async.ts b/lib/actions/copy-async.ts → src/actions/copy-async.ts
diff --git a/lib/actions/copy-tpl-async.ts → src/actions/copy-tpl-async.ts b/lib/actions/copy-tpl-async.ts → src/actions/copy-tpl-async.ts
diff --git a/lib/actions/copy-tpl.ts → src/actions/copy-tpl.ts b/lib/actions/copy-tpl.ts → src/actions/copy-tpl.ts
diff --git a/lib/actions/copy.ts → src/actions/copy.ts b/lib/actions/copy.ts → src/actions/copy.ts
diff --git a/lib/actions/delete.ts → src/actions/delete.ts b/lib/actions/delete.ts → src/actions/delete.ts
diff --git a/lib/actions/dump.ts → src/actions/dump.ts b/lib/actions/dump.ts → src/actions/dump.ts
diff --git a/lib/actions/exists.ts → src/actions/exists.ts b/lib/actions/exists.ts → src/actions/exists.ts
diff --git a/lib/actions/extend-json.ts → src/actions/extend-json.ts b/lib/actions/extend-json.ts → src/actions/extend-json.ts
diff --git a/lib/actions/move.ts → src/actions/move.ts b/lib/actions/move.ts → src/actions/move.ts
diff --git a/lib/actions/read-json.ts → src/actions/read-json.ts b/lib/actions/read-json.ts → src/actions/read-json.ts
diff --git a/lib/actions/read.ts → src/actions/read.ts b/lib/actions/read.ts → src/actions/read.ts
diff --git a/lib/actions/write-json.ts → src/actions/write-json.ts b/lib/actions/write-json.ts → src/actions/write-json.ts
diff --git a/lib/actions/write.ts → src/actions/write.ts b/lib/actions/write.ts → src/actions/write.ts
diff --git a/lib/index.ts → src/index.ts b/lib/index.ts → src/index.ts
@@ -19,6 +19,11 @@ import commit from './actions/commit.js';
 import commitFileAsync from './actions/commit-file-async.js';
 import dump from './actions/dump.js';
 
+export type { AppendOptions } from './actions/append.js';
+export type { CopyOptions } from './actions/copy.js';
+export type { CopyAsyncOptions } from './actions/copy-async.js';
+export type { MemFsEditorFileDump } from './actions/dump.js';
+
 export interface MemFsEditorFile {
   path: string;
   stat?: { mode?: number } | null;

diff --git a/lib/state.ts → src/state.ts b/lib/state.ts → src/state.ts
diff --git a/lib/transform.ts → src/transform.ts b/lib/transform.ts → src/transform.ts
diff --git a/lib/util.ts → src/util.ts b/lib/util.ts → src/util.ts
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "include": ["lib/**/*"],
+  "include": ["src/**/*"],
   "compilerOptions": {
     /* Language and Environment */
     "target": "ES2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
@@ -10,7 +10,7 @@
 
     /* Modules */
     "module": "node16" /* Specify what module code is generated. */,
-    "rootDir": "./lib" /* Specify the root folder within your source files. */,
+    "rootDir": "./src" /* Specify the root folder within your source files. */,
     "resolveJsonModule": true,
 
     /* JavaScript Support */