-
Notifications
You must be signed in to change notification settings - Fork 84
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(web): add custom scripts plugin #17
Merged
+90
−12
Merged
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
c04bbc4
feat(web): add custom scripts plugin
eahefnawy 7ab434d
feat(web): inhert script process logs if verbose or debug
eahefnawy b25d041
chore(GA): revert GA changes
eahefnawy 2b1a092
Merge remote-tracking branch 'origin/main' into add-custom-scripts-pl…
eahefnawy 03e6fb9
chore(website): added inline comments
eahefnawy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
import { execSync } from "child_process"; | ||
|
||
class Scripts { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you add inline comments to provide more context for users who might not be familiar with plugins. A few things to cover...
|
||
constructor(serverless, options, utils) { | ||
this.serverless = serverless; | ||
this.options = options; | ||
this.utils = utils; | ||
|
||
this.commands = {}; | ||
this.hooks = {}; | ||
|
||
this.defineCommands(); | ||
this.defineHooks(); | ||
} | ||
|
||
getConfig() { | ||
const service = this.serverless.service; | ||
return service.custom && service.custom.scripts; | ||
} | ||
|
||
defineCommands() { | ||
const config = this.getConfig(); | ||
const commands = config && config.commands; | ||
if (!commands) return; | ||
|
||
for (const name of Object.keys(commands)) { | ||
if (!this.commands[name]) { | ||
this.commands[name] = { lifecycleEvents: [] }; | ||
} | ||
this.commands[name].lifecycleEvents.push(name); | ||
|
||
this.hooks[`${name}:${name}`] = this.runCommand.bind(this, name); | ||
} | ||
} | ||
|
||
defineHooks() { | ||
const config = this.getConfig(); | ||
const hooks = config && config.hooks; | ||
if (!hooks) return; | ||
|
||
for (const name of Object.keys(hooks)) { | ||
this.hooks[name] = this.runHook.bind(this, name); | ||
} | ||
} | ||
|
||
runCommand(name) { | ||
const commands = this.getConfig().commands; | ||
const command = commands[name]; | ||
this.execute(command); | ||
} | ||
|
||
runHook(name) { | ||
const hooks = this.getConfig().hooks; | ||
const hook = hooks[name]; | ||
this.execute(hook); | ||
} | ||
|
||
execute(command) { | ||
let stdio = ["ignore", "ignore", "inherit"]; | ||
|
||
if (this.options.verbose || this.options.debug) { | ||
stdio = "inherit"; | ||
} | ||
|
||
execSync(command, { stdio }); | ||
} | ||
} | ||
|
||
export default Scripts; |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This project uses npm workspaces, so don't forget to run
npm i
in the root to update the lock files.