feat: add post-build hook #992
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Allow to configure a hook to be ran whenever a build is made, so that
users can perform post-build tasks. This is especially useful for the
`dev` task, as a build is ran each time the filetree changes.
This is an opportunity for users to perform custom tasks that they may
need on every builds. To do so, they just have to declare a
POST_BUILD_SCRIPT environment variable containing the path to a script,
like this:
POST_BUILD_SCRIPT=./post-build.cjs plasmo dev
The provided script must export a function, which will be executed:
```javascript
module.exports = function() {
// do stuff after build is done
}
```
louisgv
reviewed
Jun 8, 2024
Comment on lines
+228
to
+229
| if (!process.env.POST_BUILD_SCRIPT) | ||
| return |
There was a problem hiding this comment.
nit: for readability, we encapsulate early return with bracket
louisgv
reviewed
Jun 8, 2024
| return | ||
| } | ||
|
|
||
| const postBuild = require(postBuildPath) |
There was a problem hiding this comment.
nit: would be nice if this script could also be in TS 🤑 (maybe run it via tsx, or run it via some type of bundling technique (prob overkill for a postbuild script)
Also would be nice if we don't have to use require, and instead use async import instead.
I think we can put this under a future issue
louisgv
reviewed
Jun 8, 2024
| const postBuildPath = resolve(process.env.POST_BUILD_SCRIPT) | ||
|
|
||
| if (!existsSync(postBuildPath)) { | ||
| console.error("Post-build file does not exist or is not readable:", postBuildPath) |
There was a problem hiding this comment.
Should use the logger utils instead
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Details
Allow to configure a hook to be ran whenever a build is made, so that users can perform post-build tasks. This is especially useful for the
devtask, as a build is ran each time the filetree changes.This is an opportunity for users to perform custom tasks that they may need on every builds. To do so, they just have to declare a POST_BUILD_SCRIPT environment variable containing the path to a script, like this:
The provided script must export a function, which will be executed:
Code of Conduct