Nomenclature Predictably Misunderstood

    nx-remotecache-custom
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    npm package link

    nx-remotecache-custom

    nx-remotecache-custom is a simple package which includes a helper function to create custom nx remote cache implementations. You'll only need to add functions for:

    1. storing a file / buffer
    2. retrieving a file / buffer
    3. checking if a file / buffer exists

    and createCustomRunner() is taking care of everything else. Not convinced yet? The package will also:

    • Print beautiful & colored nx-style messages to the console 💅🎆
    • Allow you to execute asynchronous code in the setup phase of your runner 🤖
    • Handle all thrown errors No broken builds to offline remote caches 🚀
    • Automagically zip all the cached files Minimal storage & traffic consumption 📦
    • Provide a small defined and documented API 📚

    Usage

    npm i nx-remotecache-custom
    // define custom parameters for your nx.json here
    interface MyRunnerOptions {
      remoteUrl: string;
    }
    
    export default createCustomRunner<MyRunnerOptions>(async (options) => {
      // initialize environment variables from dotfile
      initEnv(options);
    
      // initialize the connection to your remote storage here
      const myStorage = new MyStorage(options.remoteUrl);
    
      return {
        // name is used for logging purposes
        name: "My Storage",
    
        // fileExists checks whether a file exists on your remote storage
        fileExists: (filename) => myStorage.exists(filename),
    
        // retrieveFile downloads a file from your remote storage
        retrieveFile: (filename) => myStorage.download(),
    
        // storeFile uploads a file from a buffer to your remote storage
        storeFile: (filename, buffer) => myStorage.upload(filename, buffer),
      };
    });
    {
      "name": "nx-remotecache-mystorage",
      "main": "index.js"
    }

    After this your package is already ready for usage. Publish it to npm (or an internal registry) and consume it in your client library. Install it and adjust your nx.json to use the newly created runner:

    "tasksRunnerOptions": {
      "default": {
        "runner": "nx-remotecache-mystorage",
        "options": {
          "remoteUrl": "http://127.0.0.1:1337",
          "cacheableOperations": ["build", "test", "lint", "e2e"]
        }
      }
    }

    For a more in-depth code example you can take a look at the implementation of nx-remotecache-azure which uses this package to implement a nx cache on the Azure Blob Storage.

    Advanced Configuration

    Option Environment Variable / .env Description
    name NX_CACHE_NAME Set to provide task runner name for logging. Overrides name provided in implementation.
    verbose Set to receive full stack traces whenever errors occur. Best used for debugging. Default: false
    silent Set to mute success and info logs. Default: false
    dotenv Set to false to disable reading .env into process.env. Default: true
    dotenvPath Set to read .env files from a different folder.
    "tasksRunnerOptions": {
      "default": {
        "options": {
          "name": "My Storage",
          "verbose": true,
          "silent": true
        }
      }
    }

    All Custom Runners

    Runner Storage
    nx-remotecache-azure  Azure Blob Storage
    nx-remotecache-minio  MinIO Storage

    Install

    npm i nx-remotecache-custom

    DownloadsWeekly Downloads

    9,199

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    23.6 kB

    Total Files

    29

    Last publish

    Collaborators

    • niklaspor