Class RealFsTestHelper

Test helper that creates a temporary real directory and a ts-morph project on it, as an alternative to the in-memory file system when a test must reflect real file system behavior (for example schematics tests). RealFsTestHelper.cleanup removes the directory.

Example

describe('NgModuleManager (Real FS)', () => {
  let testFs: RealFsTestHelper;

  beforeEach(async () => {
    testFs = await RealFsTestHelper.create();
  });

  afterEach(async () => {
    await testFs.cleanup();
  });

  it('extracts imports', async () => {
    const file = await testFs.createFile('/module.ts', `
      @NgModule({ imports: [CommonModule, FormsModule] })
    `);

    const imports = manager.getNgModuleImports(file);
    expect(imports).toEqual(['CommonModule', 'FormsModule']);
  });
});

Index

Methods

cleanup createDirectory createFile deleteFile fileExists getCreatedFiles getFullPath getProject getStatistics getTempDir listFiles readFile saveAll create

Methods

cleanup

cleanup(): Promise<void>
Clean up temp directory and all created files.

⚠️ IMPORTANT: Always call this in afterEach to prevent temp file accumulation.

Returns Promise<void>
Example
```
afterEach(async () => {
  await testFs.cleanup();
});
```

createDirectory

createDirectory(relativePath: string): Promise<void>
Create a directory in the temp directory.
Parameters
- relativePath: string
  Path relative to temp directory
Returns Promise<void>
Example
```
await testFs.createDirectory('/src/app/modules');
```

createFile

createFile(relativePath: string, content: string): Promise<SourceFile>
Create a new file in the temp directory.
Parameters
- relativePath: string
  Path relative to temp directory (e.g., '/module.ts' or 'src/app/module.ts')
- content: string
  File content
Returns Promise<SourceFile>
SourceFile instance from ts-morph
Example
```
const file = await testFs.createFile('/test.module.ts', `
  @NgModule({ imports: [CommonModule] })
  export class TestModule {}
`);
```

deleteFile

deleteFile(relativePath: string): Promise<void>
Delete a file from the temp directory.
Parameters
- relativePath: string
  Path relative to temp directory
Returns Promise<void>
Example
```
await testFs.deleteFile('/old-module.ts');
```

fileExists

fileExists(relativePath: string): Promise<boolean>
Check if a file exists in the temp directory.
Parameters
- relativePath: string
  Path relative to temp directory
Returns Promise<boolean>
True if file exists
Example
```
const exists = await testFs.fileExists('/module.ts');
expect(exists).toBe(true);
```

getCreatedFiles

getCreatedFiles(): Set<string>
Get all created files.

Returns Set<string>
Set of absolute file paths

getFullPath

getFullPath(relativePath: string): string
Get the absolute path for a relative file path.
Parameters
- relativePath: string
  Path relative to temp directory
Returns string
Absolute path
Example
```
const fullPath = testFs.getFullPath('/module.ts');
```

getProject

getProject(): Project

Get the ts-morph Project instance.

Returns Project

ts-morph Project

Example

const project = testFs.getProject();
const sourceFiles = project.getSourceFiles();

getStatistics

getStatistics(): {
    filesCreated: number;
    sourceFilesInProject: number;
    tempDir: string;
}
Get statistics about the test helper (for debugging/validation).

Returns { filesCreated: number; sourceFilesInProject: number; tempDir: string }
Statistics object
- filesCreated: number
  Number of files created through this helper.
- sourceFilesInProject: number
  Number of source files in the ts-morph project.
- tempDir: string
  Path of the temporary directory.

getTempDir

getTempDir(): string
Get the absolute path to the temp directory.

Returns string
Absolute path to temp directory
Example
```
const tempDir = testFs.getTempDir();
console.info(`Test files in: ${tempDir}`);
```

listFiles

listFiles(relativePath?: string): Promise<string[]>
List all files in a directory.
Parameters
- relativePath: string = '/'
  Path relative to temp directory
Returns Promise<string[]>
Array of file names
Example
```
const files = await testFs.listFiles('/src');
expect(files).toContain('app.module.ts');
```

readFile

readFile(relativePath: string): Promise<string>
Read a file from the temp directory.
Parameters
- relativePath: string
  Path relative to temp directory
Returns Promise<string>
File content as string
Example
```
const content = await testFs.readFile('/module.ts');
expect(content).toContain('CommonModule');
```

saveAll

saveAll(): Promise<void>

Save all modified source files.

Returns Promise<void>

Example

// Modify files
sourceFile.replaceText([0, 10], 'new content');

// Save all changes
await testFs.saveAll();

`Static`create

create(): Promise<RealFsTestHelper>
Factory method to create and initialize a new RealFsTestHelper.

Returns Promise<RealFsTestHelper>
Initialized test helper instance
Example
```
const testFs = await RealFsTestHelper.create();
```

Class RealFsTestHelper

Example

Index

Methods

Methods

cleanup

Returns Promise<void>

Example

createDirectory

Parameters

Returns Promise<void>

Example

createFile

Parameters

Returns Promise<SourceFile>

Example

deleteFile

Parameters

Returns Promise<void>

Example

fileExists

Parameters

Returns Promise<boolean>

Example

getCreatedFiles

Returns Set<string>

getFullPath

Parameters

Returns string

Example

getProject

Returns Project

Example

getStatistics

Returns { filesCreated: number; sourceFilesInProject: number; tempDir: string }

filesCreated: number

sourceFilesInProject: number

tempDir: string

getTempDir

Returns string

Example

listFiles

Parameters

Returns Promise<string[]>

Example

readFile

Parameters

Returns Promise<string>

Example

saveAll

Returns Promise<void>

Example

Staticcreate

Returns Promise<RealFsTestHelper>

Example

Settings

On This Page

`Static`create