Skip to content

Commit

Permalink
fix(schema): add missing typescript information in schema (#2525)
Browse files Browse the repository at this point in the history
* feat(schema): add ts and esm descriptions to processor

* fix(schema): add missing config.bundling.external option
  • Loading branch information
bernardobridge committed Mar 1, 2024
1 parent ff6cb36 commit 6b6ff07
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion packages/types/schema/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ const ConfigSchemaWithoutEnvironments = Joi.object({
socketio: SocketIoConfigSchema.meta({ title: 'SocketIo Configuration' }),
processor: Joi.string()
.meta({ title: 'Processor Function Path' })
.description('Path to a CommonJS module to load for this test run.'),
.description('Path to a CommonJS (.js), ESM (.mjs) or Typescript (.ts) module to load for this test run.\nhttps://www.artillery.io/docs/reference/test-script#processor---custom-js-code'),
variables: Joi.object()
.meta({ title: 'Variables' })
.description('Map of variables to expose to the test run.'),
Expand All @@ -109,6 +109,13 @@ const ConfigSchemaWithoutEnvironments = Joi.object({
'Load data from CSV to be used during the test run:\nhttps://www.artillery.io/docs/reference/test-script#payload---loading-data-from-csv-files'
),
tls: TlsConfig.meta({ title: 'TLS Settings' }),
bundling: Joi.object({
external: Joi.array().items(Joi.string())
.meta({ title: 'External Packages' })
.description('Can be used when using Typescript (.ts) processors. List npm modules to prevent them from being bundled. Use in case there are issues with bundling certain packages.\nhttps://www.artillery.io/docs/reference/test-script#preventing-bundling-of-typescript-packages'),
})
.meta({ title: 'Bundling'})
.description('Configuration for bundling the test script and its dependencies'),
plugins: Joi.object({ ...ArtilleryBuiltInPlugins })
.meta({ title: 'Plugins' })
.description(
Expand Down

0 comments on commit 6b6ff07

Please sign in to comment.