feat: rename option

Author: mizdra

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

@@ -16,7 +16,7 @@ export interface DefineIFFCreatorOptions
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [useUnixPathSeparator?](./inline-fixture-files.defineiffcreatoroptions.useunixpathseparator.md) |  | boolean \| undefined | _(Optional)_ Use unix-style path separator (<code>/</code>) for paths on windows. |
+|  [unixStylePath?](./inline-fixture-files.defineiffcreatoroptions.unixStylePath.md) |  | boolean \| undefined | _(Optional)_ Use unix-style path separator (<code>/</code>) for paths on windows. |
 
 ## Methods
 

docs/api/inline-fixture-files.defineiffcreatoroptions.useunixpathseparator.md

@@ -1,13 +1,13 @@
 <!-- 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; [DefineIFFCreatorOptions](./inline-fixture-files.defineiffcreatoroptions.md) &gt; [useUnixPathSeparator](./inline-fixture-files.defineiffcreatoroptions.useunixpathseparator.md)
+[Home](./index.md) &gt; [@mizdra/inline-fixture-files](./inline-fixture-files.md) &gt; [DefineIFFCreatorOptions](./inline-fixture-files.defineiffcreatoroptions.md) &gt; [unixStylePath](./inline-fixture-files.defineiffcreatoroptions.unixStylePath.md)
 
-## DefineIFFCreatorOptions.useUnixPathSeparator property
+## DefineIFFCreatorOptions.unixStylePath property
 
 Use unix-style path separator (`/`<!-- -->) for paths on windows.
 
 **Signature:**
 
 ```typescript
-useUnixPathSeparator?: boolean | undefined;
+unixStylePath?: boolean | undefined;
 ```

src/get-paths.ts

@@ -46,7 +46,7 @@ export function getSelfAndUpperPaths(path: string): string[] {
 export function getPaths<T extends Directory>(
   directory: T,
   rootDir: string,
-  useUnixPathSeparator: boolean,
+  unixStylePath: boolean,
   prefix = '',
 ): FlattenDirectory<T> {
   let paths: Record<string, string> = {};
@@ -61,15 +61,15 @@ export function getPaths<T extends Directory>(
       // NOTE: Use `Object.defineProperty(obj, prop, { value })` instead of `obj[prop] = value` to allow `paths['__proto__']`.
       // ref: https://2ality.com/2015/09/proto-es6.html#defining-__proto__
       Object.defineProperty(paths, joinForPosix(prefix, n), {
-        value: useUnixPathSeparator ? slash(join(rootDir, prefix, n)) : join(rootDir, prefix, n),
+        value: unixStylePath ? slash(join(rootDir, prefix, n)) : join(rootDir, prefix, n),
         enumerable: true,
         writable: true,
         configurable: true,
       });
     }
 
     if (isDirectory(item)) {
-      const newPaths = getPaths(item, rootDir, useUnixPathSeparator, joinForPosix(prefix, name));
+      const newPaths = getPaths(item, rootDir, unixStylePath, joinForPosix(prefix, name));
       paths = { ...paths, ...newPaths };
     }
   }
@@ -79,11 +79,11 @@ export function getPaths<T extends Directory>(
 export function changeRootDirOfPaths<T extends FlattenDirectory<Directory>>(
   paths: T,
   newRootDir: string,
-  useUnixPathSeparator: boolean,
+  unixStylePath: boolean,
 ): T {
   const newPaths: Record<string, string> = {};
   for (const key of Object.keys(paths)) {
-    newPaths[key] = useUnixPathSeparator ? slash(join(newRootDir, key)) : join(newRootDir, key);
+    newPaths[key] = unixStylePath ? slash(join(newRootDir, key)) : join(newRootDir, key);
   }
   return newPaths as unknown as T;
 }

src/index.test.ts

@@ -211,8 +211,8 @@ describe('CreateIFFResult', () => {
       // eslint-disable-next-line @typescript-eslint/no-unused-expressions
       iff.paths['b/b.txt'];
     });
-    test.runIf(process.platform === 'win32')('useUnixPathSeparator', async () => {
-      const createIFF = defineIFFCreator({ generateRootDir: () => fixtureDir, useUnixPathSeparator: true });
+    test.runIf(process.platform === 'win32')('unixStylePath', async () => {
+      const createIFF = defineIFFCreator({ generateRootDir: () => fixtureDir, unixStylePath: true });
       const iff = await createIFF({
         'a.txt': 'a',
         'b': {
@@ -234,8 +234,8 @@ describe('CreateIFFResult', () => {
       expect(iff.join('nonexistent-file.txt')).toBe(join(fixtureDir, 'nonexistent-file.txt'));
       expect(iff.join('')).toBe(fixtureDir);
     });
-    test.runIf(process.platform === 'win32')('useUnixPathSeparator', async () => {
-      const createIFF = defineIFFCreator({ generateRootDir: () => fixtureDir, useUnixPathSeparator: true });
+    test.runIf(process.platform === 'win32')('unixStylePath', async () => {
+      const createIFF = defineIFFCreator({ generateRootDir: () => fixtureDir, unixStylePath: true });
       const iff = await createIFF({});
       expect(iff.join('a.txt')).toBe(slash(join(fixtureDir, 'a.txt')));
     });

src/index.ts

@@ -41,7 +41,7 @@ export interface DefineIFFCreatorOptions {
    */
   generateRootDir(): string;
   /** Use unix-style path separator (`/`) for paths on windows. */
-  useUnixPathSeparator?: boolean | undefined;
+  unixStylePath?: boolean | undefined;
 }
 
 /**
@@ -251,17 +251,17 @@ export function defineIFFCreator(defineIFFCreatorOptions: DefineIFFCreatorOption
     __INTERNAL__prevIFF?: CreateIFFResult<U>,
   ): Promise<CreateIFFResult<MergeDirectory<U, T>>> {
     const rootDir = options?.overrideRootDir ?? defineIFFCreatorOptions.generateRootDir();
-    const useUnixPathSeparator = defineIFFCreatorOptions.useUnixPathSeparator ?? false;
+    const unixStylePath = defineIFFCreatorOptions.unixStylePath ?? false;
     const paths = {
-      ...changeRootDirOfPaths(__INTERNAL__prevIFF?.paths ?? ({} as FlattenDirectory<U>), rootDir, useUnixPathSeparator),
-      ...getPaths(directory, rootDir, useUnixPathSeparator),
+      ...changeRootDirOfPaths(__INTERNAL__prevIFF?.paths ?? ({} as FlattenDirectory<U>), rootDir, unixStylePath),
+      ...getPaths(directory, rootDir, unixStylePath),
     } as FlattenDirectory<MergeDirectory<U, T>>;
 
     const iff: CreateIFFResult<MergeDirectory<U, T>> = {
       rootDir,
       paths,
       join(...paths) {
-        return useUnixPathSeparator ? slash(join(rootDir, ...paths)) : join(rootDir, ...paths);
+        return unixStylePath ? slash(join(rootDir, ...paths)) : join(rootDir, ...paths);
       },
       async rmRootDir() {
         await rm(rootDir, { recursive: true, force: true });