@cosva-lab/serverless-esbuild-prisma
v1.2.1
Published
A Serverless Framework plugin that integrates ESBuild and Prisma for efficient bundling and seamless database management in serverless applications.
Readme
@cosva-lab/serverless-esbuild-prisma
@cosva-lab/serverless-esbuild-prisma is a Serverless plugin designed to integrate Prisma with the esbuild bundler, ensuring that the Prisma schema and engine files are correctly packaged within your deployment artifacts.
Features
- Automatically embeds the Prisma schema and engine files into your Serverless deployment package.
- Supports multiple engines and runtime environments.
- Seamlessly integrates with the Serverless framework and esbuild bundler.
Installation
Install the package via npm:
npm install @cosva-lab/serverless-esbuild-prisma --save-devUsage
Add the plugin to your serverless.yml file:
plugins:
- '@cosva-lab/serverless-esbuild-prisma'Configuration
You can customize the plugin's behavior by adding a custom block in your serverless.yml:
custom:
prisma:
prismaPath: ./path/to/your/prisma/schema # Optional: Specify the path to your Prisma schema
ignoreFunctions: # Optional: Specify functions to ignore
- functionName1
- functionName2
esbuild:
outputDir: ./path/to/output/dir # Optional: Specify the output directory for esbuildExample
Here’s a basic example of how to use this plugin:
service: my-service
provider:
name: aws
runtime: nodejs14.x
plugins:
- '@cosva-lab/serverless-esbuild-prisma'
custom:
prisma:
prismaPath: ./prisma/schema.prisma
ignoreFunctions:
- anotherFunction
esbuild:
outputDir: ./build
functions:
hello:
handler: handler.hello
anotherFunction:
handler: handler.anotherDevelopment
To contribute to this plugin:
- Clone the repository.
- Install dependencies:
npm install - Make your changes and test them.
- Submit a pull request.
