Merge pull request #19 from digitalmaas/next

New Release

Author: nolde

.circleci/config.yml

@@ -5,15 +5,15 @@ jobs:
       - image: circleci/node:10
     steps:
       - checkout
-      - run: npm ci
+      - run: npm ci --verbose
       - run: npm test
 
   release:
     docker:
       - image: circleci/node:10
     steps:
       - checkout
-      - run: npm ci
+      - run: npm ci --verbose
       - run: npm run release
 
 workflows:
@@ -26,4 +26,6 @@ workflows:
             - run_tests
           filters:
             branches:
-              only: master
+              only:
+                - master
+                - next

.eslintrc.js

@@ -1,24 +1,37 @@
+'use strict'
+
+const prettierrc = require('./.prettierrc.json')
+const engines = require('./package.json').engines
+
 module.exports = {
   root: true,
   parserOptions: {
-    ecmaVersion: 6,
-    sourceType: 'script'
+    ecmaVersion: 2018,
+    sourceType: 'module'
   },
   env: {
-    node: true,
-    es6: true,
-    jest: true
+    node: true
   },
   plugins: [
-    'standard',
-    'prettier'
+    'node',
+    'prettierx'
   ],
   extends: [
+    'eslint:recommended',
+    'plugin:node/recommended',
     'standard',
-    'prettier',
-    'prettier/standard'
+    'plugin:prettierx/standardx'
   ],
+  settings: {
+    prettierx: {
+      usePrettierrc: true,
+      editorconfig: true
+    }
+  },
   rules: {
-    'space-before-function-paren': ['error', 'always']
+    'require-atomic-updates': 0,
+    'node/no-extraneous-require': 0,
+    'node/no-unsupported-features/es-syntax': ['error', { version: engines.node }],
+    'prettierx/options': ['error', prettierrc]
   }
 }

.huskyrc.json

@@ -0,0 +1,7 @@
+{
+  "hooks": {
+    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+    "pre-commit": "lint-staged",
+    "pre-push": "npm test"
+  }
+}

.lintstagedrc

@@ -0,0 +1,3 @@
+{
+  "*.js": "./node_modules/.bin/eslint --fix"
+}

.npmignore

@@ -7,4 +7,4 @@
 !LICENSE
 !package.json
 !index.js
-!lib/**/*
+!lib/

.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "printWidth": 100,
+  "semi": false,
+  "singleQuote": true,
+  "jsxBracketSameLine": true,
+  "endOfLine": "lf",
+  "spaceBeforeFunctionParen": true
+}

.releaserc.json

@@ -1,5 +1,12 @@
 {
-  "branch": "master",
+  "branches": [
+    "master",
+    {
+      "name": "next",
+      "prerelease": "rc",
+      "channel": "next"
+    }
+  ],
   "plugins": [
     [
       "@semantic-release/commit-analyzer",
@@ -42,8 +49,7 @@
     [
       "@semantic-release/changelog",
       {
-        "changelogFile": "CHANGELOG.md",
-        "changelogTitle": "Changelog"
+        "changelogFile": "CHANGELOG.md"
       }
     ],
     "@semantic-release/git",

CHANGELOG.md

@@ -1,3 +1,23 @@
+# [2.3.0-rc.1](https://github.com/digitalmaas/serverless-plugin-browserifier/compare/v2.2.1-rc.1...v2.3.0-rc.1) (2020-03-23)
+
+
+### Bug Fixes
+
+* fix packaging issue involving `graceful-fs` ([2099e52](https://github.com/digitalmaas/serverless-plugin-browserifier/commit/2099e52412942faf8282cd55e1c0d36bcc0f06ad))
+* improve bundling code, use output stream `open` event ([b19ec43](https://github.com/digitalmaas/serverless-plugin-browserifier/commit/b19ec43651425e68219678e4a598cc5d2b1b1da9))
+
+
+### Features
+
+* add SLS_BROWSERIFIER_DEBUG flag ([1dac77e](https://github.com/digitalmaas/serverless-plugin-browserifier/commit/1dac77e52dbd7defd6b9bce20e79791ef5eb1f58))
+
+## [2.2.1-rc.1](https://github.com/digitalmaas/serverless-plugin-browserifier/compare/v2.2.0...v2.2.1-rc.1) (2020-02-10)
+
+
+### Bug Fixes
+
+* update dependencies, trying to fix weird issues with sls 1.62.x ([55f04aa](https://github.com/digitalmaas/serverless-plugin-browserifier/commit/55f04aa65cf5ca2713067cde0bd07497f87dfba2))
+
 Changelog
 
 # [2.2.0](https://github.com/digitalmaas/serverless-plugin-browserifier/compare/v2.1.0...v2.2.0) (2020-02-06)

README.md

@@ -9,6 +9,15 @@ Serverless Browserifier Plugin
 
 > A [Serverless](https://serverless.com) v1 plugin that uses [`browserify`][browserify-url] to bundle your Node.js Lambda functions.
 
+1. [Motivation](#motivation)
+1. [Installation](#installation)
+1. [Basic Setup](#basic-setup)
+1. [Advanced Configuration](#advanced-configuration)
+1. [FAQ](#faq)
+1. [Useful Information](#useful-information)
+1. [License](#license)
+
+
 Motivation
 ----------
 
@@ -41,6 +50,9 @@ From your target serverless project, run:
 npm install serverless-plugin-browserifier --save-dev
 ```
 
+Basic Setup
+-----------
+
 Add the plugin to your `serverless.yml`:
 
 ```yaml
@@ -52,11 +64,13 @@ package:
 
 The `package.individually` setting must be set -- either on global or function level -- to allow minimal bundle size based on each lambda's entrypoint.
 
+You're all set! Use your normal serverless commands to package and deploy.
 
-Configuration
--------------
 
-For most use cases you should **NOT** need to do any configuration. You can, however, introduce custom configuration.
+Advanced Configuration
+----------------------
+
+For most use cases you should **NOT** need to do any extra configuration. That said, the ability is present if you need it.
 
 The base config for browserify is read from the `custom.browserify` section of `serverless.yml`.  All [browserify options][browserify-options] are supported (most are auto configured by this plugin).  This plugin adds one special option `disable` which if `true` will bypass this plugin.
 
@@ -99,22 +113,21 @@ functions:
 ```
 
 
-Usage
------
+### Debugging
 
 When this plugin is enabled, and `package.individually` is `true`, running `serverless deploy` and `serverless deploy -f <funcName>` will automatically browserify your Node.js lambda code.
 
-If you want to see more information about the process, simply set `SLS_DEBUG=*`. Example:
+If you want to see more information about the process, simply set envvar `SLS_DEBUG=*` for full serverless debug output, or `SLS_BROWSERIFIER_DEBUG=*` for plugin only debug messages. Example:
+
 ```
 $ export SLS_DEBUG=*
 $ sls deploy function -v -f usersGet
 ```
 
-You can also verify your bundles by simply using `sls package`, which bundles everything up but does not deploy.
+You may also verify your bundles by simply using `sls package`, which bundles everything up but does not deploy.
 
 
-Using browserify plugins/transforms
------------------------------------
+### Using browserify plugins/transforms
 
 If you want to use browserify plugins, you can easily do that by using the global browserify options. As the plugin merely passes that up to browserify, as if it is calling the main [`browserify`][browserify-options] function, you can use it to add any transformations you want.
 
@@ -146,10 +159,9 @@ custom:
 For an in-depth example, please check [this issue](https://github.com/digitalmaas/serverless-plugin-browserifier/issues/8).
 
 
-Best practices
---------------
+### Best practices
 
-__If using it with AWS, use discrete SDK clients!__
+#### If using it with AWS, use discrete SDK clients!
 
 The official [aws-sdk-js][aws-sdk] officially [supports browserify][aws-sdk-support]. That allows us to further reduce the size of our bundles (and Lambda memory usage and speed) by loading only what is strictly needed.
 
@@ -162,7 +174,7 @@ const S3 = require('aws-sdk/clients/s3')
 const s3 = new S3()
 ```
 
-__Ignore AWS SDK!__
+#### Ignore AWS SDK!
 
 Although you can use discrete clients (see item above), AWS Lambda service always bundles up the latest SDK version in its Lambda container image. That means that, even if you don't add AWS SDK to your bundle, it will still be available in runtime.
 
@@ -176,6 +188,36 @@ custom:
       - aws-sdk/clients/s3
 ```
 
+To help you out, here's a script you can use to hide `aws-sdk` and all its clients from browserify. You can use it in your custom config for the plugin in _serverless.yml_:
+
+```yml
+# serverless.yml
+
+custom:
+  browserify: browserify: ${file(./custom.browserify.js)}
+```
+
+```js
+// custom.browserify.js
+//
+const fs = require('fs')
+const path = require('path')
+
+module.exports = function browserifyOptions () {
+  return {
+    // any other valid browserify configuration...
+    noParse: ['/**/*.json'],
+    exclude: ['aws-sdk', ...getAllAwsSdkClients()]
+  }
+}
+
+function getAllAwsSdkClients () {
+  return fs
+    .readdirSync('./node_modules/aws-sdk/clients', { withFileTypes: true })
+    .filter(file => file.isFile() && path.extname(file.name) === '.js')
+    .map(file => `aws-sdk/clients/${path.basename(file.name, '.js')}`)
+}
+```
 
 FAQ
 ---
@@ -193,7 +235,7 @@ __Avoid mixing this plugin with other plugins that modify serverless' packaging
 This plugin _hijacks_ the normal serverless packaging process, so it will probably conflict with other plugins that use similar mechanisms.
 
 
-Useful information
+Useful Information
 ------------------
 
 - [List of browserify's transforms][useful-transforms-list]

index.js

@@ -15,6 +15,7 @@ class BrowserifierPlugin {
     this.S = serverless
     this._b = {
       options,
+      debugOn: Boolean(process.env.SLS_DEBUG) || Boolean(process.env.SLS_BROWSERIFIER_DEBUG),
       isDisabled: get(this.S, 'service.custom.browserify.disable', false),
       servicePath: path.join(this.S.config.servicePath || os.tmpdir(), '.serverless'),
       runtimeIsNode: get(this.S, 'service.provider.runtime', '').indexOf('nodejs') !== -1,
@@ -33,25 +34,25 @@ class BrowserifierPlugin {
   }
 
   _prepareAllFunctions () {
-    return Promise
-      .bind(this)
+    return Promise.bind(this)
       .then(this._validate)
       .then(this._computeGlobalConfig)
       .then(() => {
         const fns = this._getAllFunctions()
         this.S.cli.log(`Browserifier: Preparing ${fns.length} function(s)...`)
-        return Promise.all(fns.map(name => this._bootstrap(name).reflect()))
+        return Promise.map(fns, name => this._bootstrap(name).reflect())
+      })
+      .then(results => {
+        return results
+          .filter(inspection => inspection.isRejected())
+          .forEach(inspection => this._handleSkip(inspection.reason()))
       })
-      .then(results => results
-        .filter(inspection => inspection.isRejected())
-        .forEach(inspection => this._handleSkip(inspection.reason())))
       .catch(this._handleSkip)
       .tapCatch(this._warnFailure)
   }
 
   _prepareFunction () {
-    return Promise
-      .bind(this)
+    return Promise.bind(this)
       .then(this._validate)
       .then(this._computeGlobalConfig)
       .then(() => this._bootstrap(this._b.options.function))
@@ -60,16 +61,14 @@ class BrowserifierPlugin {
   }
 
   _bundleAllFunctions () {
-    return Promise
-      .bind(this)
+    return Promise.bind(this)
       .then(this._validate)
       .then(() => Promise.all(this._getAllFunctions().map(name => this._bundle(name))))
       .tapCatch(this._warnFailure)
   }
 
   _bundleFunction () {
-    return Promise
-      .bind(this)
+    return Promise.bind(this)
       .then(this._validate)
       .then(() => this._bundle(this._b.options.function))
       .tapCatch(this._warnFailure)