Allow programmatic file deletion

[stefanbuck]

The current API design supports just a single way of deleting a file

files: {
  "file/to/delete.txt"" null
}

However, it would be useful to trigger a file deletion based on specific conditions, such as the example below:

files: {
  "file/to/delete.txt": ({ exists, encoding, content }) => {
    // do not create the file if it does not exist
    if (!exists) return null;

    const fileContent = Buffer.from(content, encoding).toString("utf-8")

    if (fileContent.includes('abc')) {
      // trigger file deletion
      return ???
    }

    // do not alter file content
    return null;
  }
}

Since both null and undefined already have different functionalities, it is unclear what return value could be used to instruct the library to initiate a file deletion. What are your thoughts?

[gr2m]

Since both null and undefined already have different functionalities, it is unclear what return value could be used to instruct the library to initiate a file deletion. What are your thoughts?

I think the correct way to do this is to use Symbols. See how mapObjectSkip is implemented in map-obj. I don't mind releasing a breaking change for this.

What do you think?

[github-actions]

🎉 This issue has been resolved in version 5.0.0 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀