Merge pull request #50 from mizdra/add-reset

Add `iff.writeFixtures()` and `iff.reset()`

Author: mizdra

.vscode/settings.json

@@ -3,11 +3,12 @@
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true,
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
+    "source.fixAll.eslint": "always"
   },
   "typescript.preferences.importModuleSpecifier": "relative",
   "javascript.preferences.importModuleSpecifier": "relative",
   "typescript.preferences.importModuleSpecifierEnding": "js",
   "javascript.preferences.importModuleSpecifierEnding": "js",
-  "vitest.commandLine": "npm run test --"
+  "vitest.commandLine": "npm run test --",
+  "typescript.preferences.preferTypeOnlyAutoImports": true
 }

docs/api/inline-fixture-files.createiff.md

@@ -9,7 +9,7 @@ Create fixtures in the specified directory.
 **Signature:**
 
 ```typescript
-export type CreateIFF = <const T extends Directory, const U extends {}>(directory: T, options?: CreateIFFOptions | undefined, __INTERNAL__prevPaths?: U) => Promise<CreateIFFResult<U & FlattenDirectory<T>>>;
+export type CreateIFF = <const T extends Directory, U extends Directory = {}>(directory: T, options?: CreateIFFOptions | undefined, __INTERNAL__prevIFF?: CreateIFFResult<U>) => Promise<CreateIFFResult<MergeDirectory<U, T>>>;
 ```
 **References:** [Directory](./inline-fixture-files.directory.md)<!-- -->, [CreateIFFOptions](./inline-fixture-files.createiffoptions.md)<!-- -->, [CreateIFFResult](./inline-fixture-files.createiffresult.md)
 

docs/api/inline-fixture-files.createiffresult.addfixtures.md

@@ -9,7 +9,7 @@ Add fixtures to the fixture root directory.
 **Signature:**
 
 ```typescript
-addFixtures<const U extends Directory>(additionalDirectory: U): Promise<CreateIFFResult<Paths & FlattenDirectory<U>>>;
+addFixtures<const U extends Directory>(additionalDirectory: U): Promise<CreateIFFResult<MergeDirectory<T, U>>>;
 ```
 
 ## Parameters
@@ -20,7 +20,7 @@ addFixtures<const U extends Directory>(additionalDirectory: U): Promise<CreateIF
 
 **Returns:**
 
-Promise&lt;[CreateIFFResult](./inline-fixture-files.createiffresult.md)<!-- -->&lt;Paths &amp; FlattenDirectory&lt;U&gt;&gt;&gt;
+Promise&lt;[CreateIFFResult](./inline-fixture-files.createiffresult.md)<!-- -->&lt;MergeDirectory&lt;T, U&gt;&gt;&gt;
 
 The [CreateIFFResult](./inline-fixture-files.createiffresult.md) with the paths of the added fixtures to [CreateIFFResult.paths](./inline-fixture-files.createiffresult.paths.md)<!-- -->.
 

docs/api/inline-fixture-files.createiffresult.fork.md

@@ -9,7 +9,7 @@ Change the root directory and take over the fixture you created.
 **Signature:**
 
 ```typescript
-fork<const U extends Directory>(additionalDirectory: U, forkOptions?: ForkOptions | undefined): Promise<CreateIFFResult<Paths & FlattenDirectory<U>>>;
+fork<const U extends Directory>(additionalDirectory: U, forkOptions?: ForkOptions | undefined): Promise<CreateIFFResult<MergeDirectory<T, U>>>;
 ```
 
 ## Parameters
@@ -21,7 +21,7 @@ fork<const U extends Directory>(additionalDirectory: U, forkOptions?: ForkOption
 
 **Returns:**
 
-Promise&lt;[CreateIFFResult](./inline-fixture-files.createiffresult.md)<!-- -->&lt;Paths &amp; FlattenDirectory&lt;U&gt;&gt;&gt;
+Promise&lt;[CreateIFFResult](./inline-fixture-files.createiffresult.md)<!-- -->&lt;MergeDirectory&lt;T, U&gt;&gt;&gt;
 
 ## Remarks
 

docs/api/inline-fixture-files.createiffresult.md

@@ -9,14 +9,14 @@ The return of [CreateIFF](./inline-fixture-files.createiff.md)<!-- -->.
 **Signature:**
 
 ```typescript
-export interface CreateIFFResult<Paths extends {}> 
+export interface CreateIFFResult<T extends Directory> 
 ```
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [paths](./inline-fixture-files.createiffresult.paths.md) |  | Paths | The paths of the fixtures. It is useful to get the path of fixtures in type safety. |
+|  [paths](./inline-fixture-files.createiffresult.paths.md) |  | FlattenDirectory&lt;T&gt; | The paths of the fixtures. It is useful to get the path of fixtures in type safety. |
 |  [rootDir](./inline-fixture-files.createiffresult.rootdir.md) |  | string | The path of the fixture root directory. |
 
 ## Methods
@@ -26,6 +26,8 @@ export interface CreateIFFResult<Paths extends {}>
 |  [addFixtures(additionalDirectory)](./inline-fixture-files.createiffresult.addfixtures.md) | Add fixtures to the fixture root directory. |
 |  [fork(additionalDirectory, forkOptions)](./inline-fixture-files.createiffresult.fork.md) | Change the root directory and take over the fixture you created. |
 |  [join(paths)](./inline-fixture-files.createiffresult.join.md) | Join <code>rootDir</code> and <code>paths</code>. It is equivalent to <code>require('path').join(rootDir, ...paths)</code>. |
+|  [reset()](./inline-fixture-files.createiffresult.reset.md) | Delete the fixture root directory and write the fixtures specified in <code>directory</code> argument again. |
 |  [rmFixtures()](./inline-fixture-files.createiffresult.rmfixtures.md) | Delete files under the fixture root directory. |
 |  [rmRootDir()](./inline-fixture-files.createiffresult.rmrootdir.md) | Delete the fixture root directory. |
+|  [writeFixtures(\_\_INTERNAL\_\_overrideRootDir)](./inline-fixture-files.createiffresult.writefixtures.md) | Write the fixtures specified in <code>directory</code> argument to the fixture root directory. |
 

docs/api/inline-fixture-files.createiffresult.paths.md

@@ -9,7 +9,7 @@ The paths of the fixtures. It is useful to get the path of fixtures in type safe
 **Signature:**
 
 ```typescript
-paths: Paths;
+paths: FlattenDirectory<T>;
 ```
 
 ## Example

docs/api/inline-fixture-files.createiffresult.reset.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@mizdra/inline-fixture-files](./inline-fixture-files.md) &gt; [CreateIFFResult](./inline-fixture-files.createiffresult.md) &gt; [reset](./inline-fixture-files.createiffresult.reset.md)
+
+## CreateIFFResult.reset() method
+
+Delete the fixture root directory and write the fixtures specified in `directory` argument again.
+
+**Signature:**
+
+```typescript
+reset(): Promise<void>;
+```
+**Returns:**
+
+Promise&lt;void&gt;
+

docs/api/inline-fixture-files.createiffresult.writefixtures.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@mizdra/inline-fixture-files](./inline-fixture-files.md) &gt; [CreateIFFResult](./inline-fixture-files.createiffresult.md) &gt; [writeFixtures](./inline-fixture-files.createiffresult.writefixtures.md)
+
+## CreateIFFResult.writeFixtures() method
+
+Write the fixtures specified in `directory` argument to the fixture root directory.
+
+**Signature:**
+
+```typescript
+writeFixtures(__INTERNAL__overrideRootDir?: string): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  \_\_INTERNAL\_\_overrideRootDir | string | _(Optional)_ |
+
+**Returns:**
+
+Promise&lt;void&gt;
+