Merge pull request #57 from LinusU/build-script

🎉 Add support for "build" scripts

Author: LinusU

lib/builder.js

@@ -37,9 +37,10 @@ exports.createZipFile = async function (directory, { customEntrypoint, sshKey })
   const cleanPackageInfo = Object.assign({}, packageInfo, { version: '0.0.0', scripts: undefined })
   const cleanPackageLock = hasYarnLockfile ? null : Object.assign({}, packageLock, { version: '0.0.0' })
 
-  const hasPrepare = Boolean(packageInfo.scripts && packageInfo.scripts.prepare)
+  const hasBuildScript = Boolean(packageInfo.scripts && packageInfo.scripts.build)
+  const hasPrepareScript = Boolean(packageInfo.scripts && packageInfo.scripts.prepare)
   const hasProductionDependencies = Boolean(packageInfo.dependencies && Object.keys(packageInfo.dependencies).length)
-  const dockerfileSource = dockerfile.generate({ hasPrepare, hasProductionDependencies, sshKey: Boolean(sshKey), yarn: hasYarnLockfile })
+  const dockerfileSource = dockerfile.generate({ hasBuildScript, hasPrepareScript, hasProductionDependencies, sshKey: Boolean(sshKey), yarn: hasYarnLockfile })
 
   const hasDockerignore = await pathExists(path.join(directory, '.dockerignore'))
   const hasGitignore = await pathExists(path.join(directory, '.gitignore'))

lib/dockerfile.js

@@ -4,14 +4,15 @@ const sshPrefix = 'echo $SSH_PRIVATE_KEY | base64 --decode > $HOME/.ssh/id_rsa &
 
 /**
  * @param {object} options
- * @param {boolean} options.hasPrepare
+ * @param {boolean} options.hasBuildScript
+ * @param {boolean} options.hasPrepareScript
  * @param {boolean} options.hasProductionDependencies
  * @param {boolean} options.sshKey
  * @param {boolean} options.yarn
  * @returns {string}
  */
 exports.generate = function (options) {
-  const { hasPrepare, hasProductionDependencies, sshKey, yarn } = options
+  const { hasBuildScript, hasPrepareScript, hasProductionDependencies, sshKey, yarn } = options
   const lines = []
 
   // Base image on Amazon Linux
@@ -43,8 +44,8 @@ exports.generate = function (options) {
   if (hasProductionDependencies) lines.push(`RUN ${sshKey ? sshPrefix : ''}${yarn ? 'yarn install --production --frozen-lockfile' : 'npm ci --production'}${sshKey ? sshPostfix : ''}`)
   if (hasProductionDependencies) lines.push('RUN zip -9qyr /output.zip node_modules')
 
-  // Install dev-dependencies, if there is a `prepare` script present
-  if (hasPrepare) lines.push(`RUN ${sshKey ? sshPrefix : ''}${yarn ? 'yarn install --frozen-lockfile' : 'npm ci'}${sshKey ? sshPostfix : ''}`)
+  // Install dev-dependencies, if there is a `prepare` or `build` script present
+  if (hasPrepareScript || hasBuildScript) lines.push(`RUN ${sshKey ? sshPrefix : ''}${yarn ? 'yarn install --frozen-lockfile' : 'npm ci'}${sshKey ? sshPostfix : ''}`)
 
   // Add the app files, and remove our special files
   lines.push('COPY . .')
@@ -54,8 +55,9 @@ exports.generate = function (options) {
     lines.push('RUN rm scandium-clean-package.json scandium-clean-package-lock.json scandium-dockerfile')
   }
 
-  // Run the `prepare` script, if present
-  if (hasPrepare) lines.push('RUN npm run-script prepare')
+  // Run the `prepare` or `build` script, if present
+  if (hasPrepareScript) lines.push('RUN npm run-script prepare')
+  else if (hasBuildScript) lines.push('RUN npm run-script build')
 
   // Add the local code to the zip
   lines.push('RUN rm -r node_modules')

readme.md

@@ -36,9 +36,11 @@ scandium update --name=my-awesome-api
 
 By default, Scandium will set up an API Gateway that simply forwards all requests to the Lambda function. If you want to utilise the benefits of API Gateway fully, you can provide a Swagger file describing your API endpoints. Pass the `--swagger=my-api-definition.yml` to either the `create` or `update` command and Scandium will configure the API Gateway for you.
 
-## `prepare`-scripts
+## `prepare`/`build`-scripts
 
-Scandium has support for `prepare` scripts, if the script is present in the `package.json` it will make sure that the script is being run with full `devDependencies` installed. The final package being uploaded to Lambda will still only contain the production `dependencies`.
+Scandium has support for `prepare`/`build` scripts, if the script is present in the `package.json` it will make sure that the script is being run with full `devDependencies` installed. The final package being uploaded to Lambda will still only contain the production `dependencies`.
+
+If both a `prepare` and a `build` script is present, Scandium will pick the `prepare` script.
 
 ## Ignore files