Skip to content

Commit 255ce85

Browse files
committed
Polishing
1 parent 8e16997 commit 255ce85

1 file changed

Lines changed: 18 additions & 20 deletions

File tree

README.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,6 @@ This project provides a [JUnit Jupiter][] extension for in-memory
66
[`@TempDir`](https://junit.org/junit5/docs/current/api/org.junit.jupiter.api/org/junit/jupiter/api/io/TempDir.html)
77
directories via the [Jimfs][] file system.
88

9-
## Motivation
10-
11-
It is currently possible to use Jimfs and JUnit Jupiter together to create in-memory temporary directories for testing.
12-
However, this requires Jimfs in-memory file system handling to be integrated with JUnit Jupiter test lifecycle callbacks,
13-
boilerplate code that users must implement themselves.
14-
15-
Starting from version 5.10, JUnit Jupiter offers a
16-
[`TempDirFactory` SPI](https://junit.org/junit5/docs/5.10.0/user-guide/#writing-tests-built-in-extensions-TempDirectory)
17-
for customizing how temporary directories are created via the `@TempDir` annotation.
18-
The SPI allows libraries like Jimfs to provide their own implementations.
19-
20-
First-party support was requested in [google/jimfs#258](https://github.com/google/jimfs/issues/258).
21-
However, Google has not yet started using JUnit Jupiter, and first-party support may only be provided once it does.
22-
Since this extension was created to offer users a smooth integration between Jimfs and JUnit Jupiter, the project will
23-
likely be discontinued if Google ever provides official support for this integration.
24-
259
## Compatibility
2610

2711
Jimfs JUnit Jupiter is based on JUnit Jupiter 5 and requires Java 8 or higher.
@@ -144,13 +128,27 @@ its `value` attribute is set.
144128
Jimfs JUnit Jupiter only supports annotated fields or parameters of type `Path`, as Jimfs is a non-default file
145129
system and `File` instances can only be associated with the default file system.
146130

147-
## Improvements
148-
149-
Compared to the configuration options that Jimfs provides, Jimfs JUnit Jupiter offers a simplified interface to keep
150-
its usage straightforward.
131+
Plus, compared to the configuration options that Jimfs provides, Jimfs JUnit Jupiter offers a simplified interface to
132+
keep its usage straightforward.
151133

152134
In case something is missing for your use case, please [raise an issue](../../issues/new)!
153135

136+
## Motivation
137+
138+
It is currently possible to use Jimfs and JUnit Jupiter together to create in-memory temporary directories for testing.
139+
However, this requires Jimfs in-memory file system handling to be integrated with JUnit Jupiter test lifecycle callbacks,
140+
boilerplate code that users must implement themselves.
141+
142+
Starting from version 5.10, JUnit Jupiter offers a
143+
[`TempDirFactory` SPI](https://junit.org/junit5/docs/5.10.0/user-guide/#writing-tests-built-in-extensions-TempDirectory)
144+
for customizing how temporary directories are created via the `@TempDir` annotation.
145+
The SPI allows libraries like Jimfs to provide their own implementations.
146+
147+
First-party support was requested in [google/jimfs#258](https://github.com/google/jimfs/issues/258).
148+
However, Google has not yet started using JUnit Jupiter, and first-party support may only be provided once it does.
149+
Since this extension was created to offer users a smooth integration between Jimfs and JUnit Jupiter, the project will
150+
likely be discontinued if Google ever provides official support for this integration.
151+
154152
## License
155153

156154
Jimfs JUnit Jupiter is released under version 2.0 of the [Apache License][].

0 commit comments

Comments
 (0)