Skip to content

Update convex.schema.json #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions schemas/convex.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,13 @@
"description": "Configuration schema for Convex project settings.\n\nDocumentation: https://docs.convex.dev/production/project-configuration#convexjson",
"type": "object",
"properties": {
"$schema": {
"type": "string"
},
"node": {
"type": "object",
"description": "Node.js specific configuration for server-side packages and dependencies.",
"properties": {
"externalPackages": {
"type": ["array"],
"description": "List of packages that should be installed on the server instead of being bundled. Use this for packages that can't be bundled or need to be installed directly on the server.\n\nIf you want to mark all dependencies as external, you can use the string '*' instead of an array.\n\nDocumentation: https://docs.convex.dev/functions/bundling#external-packages",
"description": "List of packages that should be installed on the server instead of being bundled. Use this for packages that can't be bundled or need to be installed directly on the server.\n\nYou can use '*' to mark all dependencies as external.",
"items": {
"type": "string"
},
Expand All @@ -37,12 +34,12 @@
},
"generateCommonJSApi": {
"type": "boolean",
"description": "When true, generates CommonJS-compatible API files for projects not using ES modules. Enable this if your project uses require() syntax instead of ES modules.\n\nDocumentation: https://docs.convex.dev/client/javascript/node#javascript-with-commonjs-require-syntax",
"description": "When true, generates CommonJS-compatible API files for projects using require().",
"default": false
},
"functions": {
"type": "string",
"description": "Path to the directory containing Convex functions. You can customize this to use a different location than the default 'convex/' directory.\n\nDocumentation: https://docs.convex.dev/production/project-configuration#changing-the-convex-folder-name-or-location",
"description": "Path to the directory containing Convex functions.",
"default": "convex/"
}
},
Expand Down