chore: deprecate (#606)

* chore: bye bye * Apply suggestions from code review Co-authored-by: Kristen Lavavej <[email protected]> * chore: mention nft * Update README.md Co-authored-by: Kristen Lavavej <[email protected]> --------- Co-authored-by: Kristen Lavavej <[email protected]>
netlify · Feb 15, 2023 · cf8cacf · cf8cacf
1 parent 19abfb0
commit cf8cacf
Show file tree

Hide file tree

Showing 7 changed files with 8,260 additions and 2,664 deletions.
diff --git a/.github/workflows/fossa.yml b/.github/workflows/fossa.yml
diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml
diff --git a/MIGRATE.md b/MIGRATE.md
@@ -0,0 +1,135 @@
+# Migration Guide
+
+This guide covers the following use cases of netlify-lambda and how to accomplish them without this deprecated tool.
+
+- [Run Netlify functions locally](#run-netlify-functions-locally)
+- [Use Typescript or non-standard JavaScript features](#use-typescript-or-non-standard-javascript-features)
+- [Bundle with Webpack](#bundle-with-webpack)
+- [Install function dependencies](#install-function-dependencies)
+
+## Run Netlify Functions locally
+
+The tooling to run functions locally has been completely integrated into the Netlify CLI, which offers even more functionality like local debugging.
+
+If you had `netlify-lambda` in your npm scripts, you can migrate by changing to the Netlify CLI `dev` command.
+
+For example in a theoretical Gatsby project you can migrate with the following changes:
+
+> package.json
+
+```diff
+ {
+   "scripts": {
+-     "start:app": "npm run develop",
+-     "start:lambda": "netlify-lambda serve src/lambda",
+-     "start": "concurrently \"yarn start:lambda\" \"yarn develop\"",
+-     "develop": "gatsby develop",
++     "start": "netlify dev",
+   },
+   "devDependencies": {
+-    "netlify-lambda": "^1.4.3",
++    "netlify-cli": "^10.14.0",
+   }
+ }
+```
+
+## Use TypeScript or non-standard JavaScript features
+
+Netlify now supports TypeScript and non-standard JavaScript features.
+For TypeScript there is no configuration needed and it will work out of the box. The same is true if you use ESM modules in your functions. The bundling logic will automatically detect these and use `esbuild` or `nft` to bundle the functions.
+In any other case you can set the `node_bundler` to `esbuild` yourself for the functions in your `netlify.toml` file. https://docs.netlify.com/configure-builds/file-based-configuration/#functions
+
+Should `esbuild` not work for your use case then please report this to us or use webpack directly as described in the next section.
+
+## Bundle with Webpack
+
+If after trying our [automated bundling](#use-typescript-or-non-standard-javascript-features) you still want to use webpack to bundle your functions, you can use webpack directly and adjust the config to your needs. The following example is for webpack 4, which is the version that netlify-lambda used.
+
+> package.json
+
+```json
+{
+    "scripts":{
+        "build":"webpack --config ./webpack.config.js"
+    }
+    "devDependencies": {
+        "webpack": "^4.46.0",
+        "webpack-cli": "^4.10.0",
+        "babel-loader": "^8.2.5",
+        "@babel/preset-env": "^7.18.9",
+    }
+}
+```
+
+> webpack.config.js
+
+```js
+const webpack = require('webpack');
+
+module.exports = {
+  mode: 'production',
+  resolve: {
+    extensions: ['.wasm', '.mjs', '.js', '.json', '.ts'],
+    mainFields: ['module', 'main'],
+  },
+  module: {
+    rules: [
+      {
+        test: /\.(m?js|ts)?$/,
+        exclude: new RegExp(
+          `(node_modules|bower_components|\\.(test|spec)\\.?)`,
+        ),
+        use: {
+          loader: require.resolve('babel-loader'),
+          options: {
+            cacheDirectory: true,
+            presets: [
+              [
+                require.resolve('@babel/preset-env'),
+                { targets: { node: '16.6.0' } },
+              ],
+            ],
+          },
+        },
+      },
+    ],
+  },
+  context: './src/functions',
+  entry: {},
+  target: 'node',
+  plugins: [new webpack.IgnorePlugin(/vertx/)],
+  output: {
+    path: './netlify/functions',
+    filename: '[name].js',
+    libraryTarget: 'commonjs',
+  },
+  optimization: {
+    nodeEnv: process.env.NODE_ENV || 'production',
+  },
+  bail: true,
+  devtool: false,
+  stats: {
+    colors: true,
+  },
+};
+```
+
+## Install function dependencies
+
+Consider moving the dependencies of your functions into your main `package.json` for automatic installation during local development. If this is not possible you can use the following change.
+
+Note that this is needed for local development only. The Netlify build system will detect and install dependencies of your functions.
+
+> package.json
+
+```diff
+ {
+   "scripts": {
+-     "postinstall": "netlify-lambda install",
++     "postinstall": "npm --prefix ./functions/my-function i && npm --prefix ./functions/other-function i",
+   },
+   "devDependencies": {
+-    "netlify-lambda": "^1.4.3",
+   }
+ }
+```