Release v18.0.0

Author: NiklasPor

CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 18.0.0
+
+## Breaking Changes
+
+- Nx support starts at 18.0.0
+- Nx issue [https://github.com/nrwl/nx/issues/20689](#20689) requires us to set `skipLibCheck: true` inside the `tsconfig.json` of `nx-remotecache-*` packages.
+
 ## 17.1.1
 
 ### Chore

lib/create-custom-runner.ts

@@ -1,11 +1,10 @@
-import { Task } from "nx/src/config/task-graph";
-import type { RemoteCache } from "nx/src/tasks-runner/default-tasks-runner";
 import defaultTasksRunner from "nx/tasks-runners/default";
 import { createRemoteCacheRetrieve } from "./create-remote-cache-retrieve";
 import { createRemoteCacheStore } from "./create-remote-cache-store";
 import { getSafeRemoteCacheImplementation } from "./get-safe-remote-cache-implementation";
 import * as log from "./log";
 import { CustomRunnerOptions } from "./types/custom-runner-options";
+import { NxRemoteCache, NxTask } from "./types/nx";
 import { RemoteCacheImplementation } from "./types/remote-cache-implementation";
 
 type DefaultTasksRunner = typeof defaultTasksRunner;
@@ -15,7 +14,7 @@ const cacheNoop = async () => false;
 const createRemoteCache = (
   implementation: Promise<RemoteCacheImplementation>,
   options: CustomRunnerOptions
-): RemoteCache => {
+): NxRemoteCache => {
   const read = process.env.NXCACHE_READ
     ? process.env.NXCACHE_READ !== "false"
     : options.read ?? true;
@@ -50,7 +49,7 @@ export const createCustomRunner =
   <T extends Object>(
     setup: (
       options: CustomRunnerOptions<T>,
-      tasks: Task[]
+      tasks: NxTask[]
     ) => Promise<RemoteCacheImplementation>
   ): DefaultTasksRunner =>
   (tasks, options, context) =>

lib/create-remote-cache-retrieve.ts

@@ -1,11 +1,12 @@
 import { mkdir, writeFile } from "fs/promises";
-import type { RemoteCache } from "nx/src/tasks-runner/default-tasks-runner";
+
 import { join } from "path";
 import { Readable } from "stream";
 import { pipeline } from "stream/promises";
 import { extract } from "tar";
 import { createFilterSourceFile } from "./create-filter-source-file";
 import { getFileNameFromHash } from "./get-file-name-from-hash";
+import { NxRemoteCache } from "./types/nx";
 import { SafeRemoteCacheImplementation } from "./types/safe-remote-cache-implementation";
 
 const COMMIT_FILE_EXTENSION = ".commit";
@@ -35,7 +36,7 @@ const writeCommitFile = (destination: string) => {
 export const createRemoteCacheRetrieve =
   (
     safeImplementation: Promise<SafeRemoteCacheImplementation | null>
-  ): RemoteCache["retrieve"] =>
+  ): NxRemoteCache["retrieve"] =>
   async (hash, cacheDirectory) => {
     const implementation = await safeImplementation;
 

lib/create-remote-cache-store.ts

@@ -1,8 +1,8 @@
-import type { RemoteCache } from "nx/src/tasks-runner/default-tasks-runner";
 import { Readable } from "stream";
 import { create } from "tar";
 import { createFilterSourceFile } from "./create-filter-source-file";
 import { getFileNameFromHash } from "./get-file-name-from-hash";
+import { NxRemoteCache } from "./types/nx";
 import { SafeRemoteCacheImplementation } from "./types/safe-remote-cache-implementation";
 
 const archiveFolder = (cwd: string, hash: string): Readable =>
@@ -13,7 +13,7 @@ const archiveFolder = (cwd: string, hash: string): Readable =>
 export const createRemoteCacheStore =
   (
     safeImplementation: Promise<SafeRemoteCacheImplementation | null>
-  ): RemoteCache["store"] =>
+  ): NxRemoteCache["store"] =>
   async (hash, cacheDirectory) => {
     const implementation = await safeImplementation;
 

lib/types/custom-runner-options.ts

@@ -1,7 +1,7 @@
-import type { DefaultTasksRunnerOptions } from "nx/src/tasks-runner/default-tasks-runner";
+import { NxDefaultTasksRunnerOptions } from "./nx";
 
 export type CustomRunnerOptions<T extends Object = Object> = T &
-  DefaultTasksRunnerOptions & {
+  NxDefaultTasksRunnerOptions & {
     /**
      * Sets task runner name for logging.
      */

lib/types/nx.ts

@@ -0,0 +1,11 @@
+// Re-export types here to avoid needing to update "private" paths everywhere
+
+import { Task } from "nx/src/config/task-graph";
+import type {
+  DefaultTasksRunnerOptions,
+  RemoteCache,
+} from "nx/src/tasks-runner/default-tasks-runner";
+
+export type NxDefaultTasksRunnerOptions = DefaultTasksRunnerOptions;
+export type NxRemoteCache = RemoteCache;
+export type NxTask = Task;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nx-remotecache-custom",
-  "version": "17.1.1",
+  "version": "18.0.0",
   "description": "Build custom caching for @nrwl/nx in a few lines of code",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -31,7 +31,7 @@
   "devDependencies": {
     "@types/tar": "^6.1.3",
     "@types/yargs": "^17.0.13",
-    "nx": "^17.0.0",
+    "nx": "^18.0.0",
     "typescript": "^5.1.0"
   },
   "dependencies": {
@@ -40,6 +40,6 @@
     "tar": "^6.1.12"
   },
   "peerDependencies": {
-    "nx": "^17.0.0"
+    "nx": "^18.0.0"
   }
-}
+}