Support blobpack or benthos config key

Author: razor-x

README.md

@@ -68,7 +68,7 @@ add this to your `package.json`,
   "scripts": {
     "postinstall": "blobpack install"
   },
-  "benthos": {
+  "blobpack": {
     "name": "benthos-lambda",
     "version": "3.54.1",
     "platform": "linux_amd64",
@@ -104,7 +104,7 @@ boring:
     include: []
 ```
 
-First, add the `artifacts` section to the `benthos` config.
+First, add the `artifacts` section to the `blobpack` config.
 This will generate a new artifact to `dist/boring.zip` which uses
 `config/boring.yaml` and intelligently merges resources in both
 `resources/outputs.yaml` and `node_modules/@my-org/blobd/resources/logger.yaml`.
@@ -114,7 +114,7 @@ If two files have the same key, the last one wins._
 
 ```json
 {
-  "benthos": {
+  "blobpack": {
     "artifacts": [
       {
         "name": "boring",
@@ -133,7 +133,7 @@ you can use this shorthand,
 
 ```json
 {
-  "benthos": {
+  "blobpack": {
     "artifacts": [
       "boring"
     ]
@@ -146,7 +146,7 @@ you can use the `include` property,
 
 ```json
 {
-  "benthos": {
+  "blobpack": {
     "include": {
       "resources": ["logger"]
     },

fixtures/config.json

@@ -1,5 +1,5 @@
 {
-  "benthos": {
+  "blobpack": {
     "name": "benthos-lambda",
     "version": "3.54.1",
     "platform": "linux_amd64",

lib/build.doc.js

@@ -2,7 +2,7 @@
  * Build Benthos artifacts for AWS Lambda.
  * @function build
  * @param {Object} parameters
- * @param {string} [parameters.configPath=package.json] Path to JSON file with a benthos config key.
+ * @param {string} [parameters.configPath=package.json] Path to JSON file with a blobpack config key.
  * @param {string} [parameters.tmpRoot=s3] Temporary directory to download artifacts.
  * @param {string} [parameters.configRoot=config] Path where configs are located.
  * @param {string} [parameters.resourcesRoot=resources] Path where resources are located.

lib/build.js

@@ -5,7 +5,7 @@ import mkdirp from 'mkdirp'
 import jsYaml from 'js-yaml'
 import jszip from 'jszip'
 
-import { loadJson } from './load-json.js'
+import { loadConfig } from './config.js'
 import { zipName } from './zip-name.js'
 import { mergeArrayProps, mergeConfig } from './merge.js'
 
@@ -23,13 +23,9 @@ export const build = async ({
   logger = console
 } = {}) => {
   try {
-    const { benthos } = await loadJson(configPath)
+    const config = await loadConfig(configPath)
 
-    if (!benthos) {
-      throw new Error(`Cannot find key benthos in config at ${configPath}`)
-    }
-
-    const artifacts = await createArtifacts(benthos, {
+    const artifacts = await createArtifacts(config, {
       tmpRoot,
       configRoot,
       resourcesRoot,

lib/config.js

@@ -0,0 +1,19 @@
+import fs from 'fs'
+
+export const loadConfig = async (configPath) => {
+  const { benthos, blobpack } = await loadJson(configPath)
+  const config = blobpack ?? benthos
+
+  if (!config) {
+    throw new Error(
+      `Cannot find key blobpack or benthos in config at ${configPath}`
+    )
+  }
+
+  return config
+}
+
+const loadJson = async (name) => {
+  const data = await fs.promises.readFile(name)
+  return JSON.parse(data)
+}

lib/index.js

@@ -1,3 +1,2 @@
 export * from './build.js'
 export * from './install.js'
-export * from './load-json.js'

lib/install.js

@@ -6,21 +6,16 @@ import download from 'download'
 import mkdirp from 'mkdirp'
 
 import { zipName } from './zip-name.js'
-import { loadJson } from './load-json.js'
+import { loadConfig } from './config.js'
 
 export const install = async ({
   configPath = 'package.json',
   tmpRoot = 'tmp',
   logger = console
 } = {}) => {
   try {
-    const { benthos } = await loadJson(configPath)
-
-    if (!benthos) {
-      throw new Error(`Cannot find key 'benthos' in config at ${configPath}`)
-    }
-
-    const { data, name } = await pull(benthos)
+    const config = await loadConfig(configPath)
+    const { data, name } = await pull(config)
     await write(tmpRoot, name, data)
     const outputPath = path.resolve(tmpRoot, name)
     logger.log(`Verified ${outputPath}`)

lib/load-json.doc.js

@@ -4,14 +4,15 @@ import path from 'path'
 import test from 'ava'
 
 import { zipName } from '../lib/zip-name.js'
-import { build, install, loadJson } from '../index.js'
+import { loadConfig } from '../lib/config.js'
+import { build, install } from '../index.js'
 
 const tmpRoot = path.join('tmp', 'build-spec')
 const configPath = path.join('fixtures', 'config.json')
 
 test.beforeEach(async (t) => {
-  const { benthos } = await loadJson(configPath)
-  const name = zipName(benthos)
+  const config = await loadConfig(configPath)
+  const name = zipName(config)
   const outputPath = path.join(tmpRoot, name)
   const logger = {
     log: (msg) => t.log(msg),