Skip to content
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
merged 5 commits into from
Oct 16, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
"name": "website",
"version": "1.0.0",
"main": "index.js",
"type": "module",
"license": "MIT",
"dependencies": {
"express": "^4.19.2",
"serverless-http": "^3.2.0"
},
"devDependencies": {
"serverless-domain-manager": "^7.4.0",
"serverless-plugin-scripts": "^1.0.2"
"serverless-domain-manager": "^7.4.0"
Copy link
Member

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.

}
}
69 changes: 69 additions & 0 deletions website/scripts.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
import { execSync } from "child_process";

class Scripts {
Copy link
Member

Choose a reason for hiding this comment

The 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...

  • Why it exists - to run custom scripts, which we need to run the build script at deploy time, with support for variable resolution from framework, as well as proper stdio handling.
  • How this works - it runs because it's included as a plugin in serverless.yml, and how hooks work.

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;
2 changes: 1 addition & 1 deletion website/serverless.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ provider:
runtime: nodejs20.x

plugins:
- serverless-plugin-scripts
- serverless-domain-manager
- ./scripts

build:
esbuild: true
Expand Down