1480: clarifications/renamings

Author: simschla

lib/src/main/java/com/diffplug/spotless/npm/ShadowCopy.java

@@ -49,10 +49,10 @@ public ShadowCopy(@Nonnull File shadowCopyRoot) {
 	}
 
 	public void addEntry(String key, File orig) {
+		// prevent concurrent adding of entry with same key
 		if (!reserveSubFolder(key)) {
-			logger.debug("Shadow copy entry already on the way: {}. Awaiting finalization.", key);
+			logger.debug("Shadow copy entry already in progress: {}. Awaiting finalization.", key);
 			try {
-				// maybe make the duration configurable?
 				NpmResourceHelper.awaitFileDeleted(markerFilePath(key).toFile(), Duration.ofSeconds(120));
 			} catch (TimeoutException e) {
 				throw new RuntimeException(e);

plugin-gradle/src/test/java/com/diffplug/gradle/spotless/NpmInstallCacheIntegrationTests.java

@@ -47,7 +47,7 @@ static void beforeAll(@TempDir File pertainingCacheDir) {
 	}
 
 	@Test
-	void prettierWithDefaultInstallCacheTest() throws IOException {
+	void prettierCachesNodeModulesToADefaultFolderWhenCachingEnabled() throws IOException {
 		File dir1 = newFolder("npm-prettier-1");
 		File cacheDir = DEFAULT_DIR_FOR_NPM_INSTALL_CACHE_DO_NEVER_WRITE_TO_THIS;
 		BuildResult result = runPhpPrettierOnDir(dir1, cacheDir);
@@ -59,7 +59,7 @@ void prettierWithDefaultInstallCacheTest() throws IOException {
 	}
 
 	@Test
-	void prettierWithSpecificInstallCacheTest() throws IOException {
+	void prettierCachesAndReusesNodeModulesInSpecificInstallCacheFolder() throws IOException {
 		File dir1 = newFolder("npm-prettier-1");
 		File cacheDir = newFolder("npm-prettier-cache");
 		BuildResult result = runPhpPrettierOnDir(dir1, cacheDir);
@@ -70,18 +70,17 @@ void prettierWithSpecificInstallCacheTest() throws IOException {
 	}
 
 	@Test
-	void prettierWithNoCacheTest() throws IOException {
+	void prettierDoesNotCacheNodeModulesIfNotExplicitlyEnabled() throws IOException {
 		File dir2 = newFolder("npm-prettier-1");
-		File cacheDir = null;
-		BuildResult result = runPhpPrettierOnDir(dir2, cacheDir);
+		BuildResult result = runPhpPrettierOnDir(dir2, null);
 		Assertions.assertThat(result.getOutput())
 				.doesNotContainPattern("Using cached node_modules for .*")
 				.doesNotContainPattern("Caching node_modules for .*");
 	}
 
 	@Test
 	@Order(1)
-	void prettierWithSpecificGlobalInstallCacheTest() throws IOException {
+	void prettierCachesNodeModuleInGlobalInstallCacheDir() throws IOException {
 		File dir1 = newFolder("npm-prettier-global-1");
 		File cacheDir = pertainingCacheDir;
 		BuildResult result = runPhpPrettierOnDir(dir1, cacheDir);
@@ -92,7 +91,7 @@ void prettierWithSpecificGlobalInstallCacheTest() throws IOException {
 
 	@Test
 	@Order(2)
-	void prettierWithSpecificGlobalInstallCacheTest2() throws IOException {
+	void prettierUsesCachedNodeModulesFromGlobalInstallCacheDir() throws IOException {
 		File dir2 = newFolder("npm-prettier-global-2");
 		File cacheDir = pertainingCacheDir;
 		BuildResult result = runPhpPrettierOnDir(dir2, cacheDir);
@@ -130,7 +129,7 @@ private BuildResult runPhpPrettierOnDir(File projDir, File cacheDir) throws IOEx
 
 	@Test
 	@Order(3)
-	void tsfmtWithSpecificGlobalInstallCacheTest() throws IOException {
+	void tsfmtCachesNodeModuleInGlobalInstallCacheDir() throws IOException {
 		File dir1 = newFolder("npm-tsfmt-global-1");
 		File cacheDir = pertainingCacheDir;
 		BuildResult result = runTsfmtOnDir(dir1, cacheDir);
@@ -141,7 +140,7 @@ void tsfmtWithSpecificGlobalInstallCacheTest() throws IOException {
 
 	@Test
 	@Order(4)
-	void tsfmtWithSpecificGlobalInstallCacheTest2() throws IOException {
+	void tsfmtUsesCachedNodeModulesFromGlobalInstallCacheDir() throws IOException {
 		File dir2 = newFolder("npm-tsfmt-global-2");
 		File cacheDir = pertainingCacheDir;
 		BuildResult result = runTsfmtOnDir(dir2, cacheDir);
@@ -151,10 +150,9 @@ void tsfmtWithSpecificGlobalInstallCacheTest2() throws IOException {
 	}
 
 	@Test
-	void tsfmtWithNoCacheTest() throws IOException {
+	void tsfmtDoesNotCacheNodeModulesIfNotExplicitlyEnabled() throws IOException {
 		File dir2 = newFolder("npm-tsfmt-1");
-		File cacheDir = null;
-		BuildResult result = runTsfmtOnDir(dir2, cacheDir);
+		BuildResult result = runTsfmtOnDir(dir2, null);
 		Assertions.assertThat(result.getOutput())
 				.doesNotContainPattern("Using cached node_modules for .*")
 				.doesNotContainPattern("Caching node_modules for .*");
@@ -185,7 +183,7 @@ private BuildResult runTsfmtOnDir(File projDir, File cacheDir) throws IOExceptio
 
 	@Test
 	@Order(5)
-	void eslintWithSpecificGlobalInstallCacheTest() throws IOException {
+	void eslintCachesNodeModuleInGlobalInstallCacheDir() throws IOException {
 		File dir1 = newFolder("npm-eslint-global-1");
 		File cacheDir = pertainingCacheDir;
 		BuildResult result = runEslintOnDir(dir1, cacheDir);
@@ -196,7 +194,7 @@ void eslintWithSpecificGlobalInstallCacheTest() throws IOException {
 
 	@Test
 	@Order(6)
-	void eslintWithSpecificGlobalInstallCacheTest2() throws IOException {
+	void eslintUsesCachedNodeModulesFromGlobalInstallCacheDir() throws IOException {
 		File dir2 = newFolder("npm-eslint-global-2");
 		File cacheDir = pertainingCacheDir;
 		BuildResult result = runEslintOnDir(dir2, cacheDir);
@@ -206,7 +204,7 @@ void eslintWithSpecificGlobalInstallCacheTest2() throws IOException {
 	}
 
 	@Test
-	void eslintWithNoCacheTest() throws IOException {
+	void eslintDoesNotCacheNodeModulesIfNotExplicitlyEnabled() throws IOException {
 		File dir2 = newFolder("npm-eslint-1");
 		File cacheDir = null;
 		BuildResult result = runEslintOnDir(dir2, cacheDir);