feat: support custom esbuild module path (#220)

.projenrc.ts

@@ -175,6 +175,7 @@ project.tryFindObjectFile('.github/workflows/release.yml')?.addToArray(
 // eslint
 project.eslint?.addRules({
   'no-console': 'error',
+  'eol-last': ['error', 'always'],
   '@typescript-eslint/member-ordering': 'off',
 });
 project.eslint?.addOverride({
@@ -214,6 +215,7 @@ new JsonFile(project, '.vscode/settings.json', {
     '[svg]': {
       'editor.defaultFormatter': 'jock.svg',
     },
+    'python.formatting.provider': 'black',
   },
 });
 

CONTRIBUTING.md

@@ -13,14 +13,14 @@ Like every Construct, *cdk-esbuild* is a [jsii](https://github.com/aws/jsii) pro
 Sometimes it is required to test these generated packages in a real life environment.
 All paths in the instructions below, will assume you are testing with one of the examples.
 
-### NodeJs
+### Node.js
 
 **Option 1:**
 
 *This is the preferred approach, as it is more consistent and closer to how npm would behave for a real user.*
 
 - `pj build`
-- The NodeJS package can be found in `dist/js`
+- The Node.js package can be found in `dist/js`
 - In your Python app, run `npm install ../../dist/js/[email protected]` (path to the file in dist)
 - `npx cdk synth` will use the locally build version
 

examples/python-app/README.md

@@ -9,20 +9,20 @@ All interfaces are available, but the esbuild binary must be available in path,
 
 To set up a new virtualenv, run
 
-```
-$ python3 -m venv .venv
+```bash
+python3 -m venv .venv
 ```
 
 Then activate the venv and install all dependencies:
 
-```
-$ source .venv/bin/activate
-$ pip install -r requirements.txt
-$ npm install --location=global esbuild
+```bash
+source .venv/bin/activate
+pip install -r requirements.txt -r requirements-dev.txt
+npm install -g esbuild
 ```
 
-Finally run the CDK app:
+Run the CDK app providing the `CDK_ESBUILD_MODULE_PATH`:
 
+```bash
+CDK_ESBUILD_MODULE_PATH="$(npm prefix -g)/lib/node_modules/esbuild" cdk synth
 ```
-$ cdk synth
-```

examples/python-app/python_app/python_app_stack.py

@@ -19,7 +19,10 @@ def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
             self,
             "Website",
             sources=[
-                TypeScriptSource("lambda-handler/index.ts", copy_dir="lambda-handler")
+                TypeScriptSource(
+                    "lambda-handler/index.ts",
+                    copy_dir="lambda-handler",
+                )
             ],
             destination_bucket=s3.Bucket(
                 self,
@@ -37,6 +40,9 @@ def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
                 build_options=BuildOptions(
                     format="esm", outfile="index.mjs", external=["aws-sdk"]
                 ),
+                # Override the global setting with a specific path per Construct
+                # This can be useful if a Construct requires a different version of esbuild
+                esbuild_module_path="/project/node_modules/esbuild@13",
             ),
         )
 

examples/python-app/requirements-dev.txt

@@ -1 +1,2 @@
 pytest==6.2.5
+black>=22.6.0

examples/python-app/requirements.txt

@@ -1,3 +1,3 @@
-aws-cdk-lib==2.27.0
+aws-cdk-lib==2.37.1
 constructs>=10.0.0,<11.0.0
-mrgrain.cdk-esbuild>=4.0.0
+mrgrain.cdk-esbuild>=3.10.0