jslib.k6.io, hosted utility libs for k6 scripts.
To make life a little easier during development, make sure to install the following:
[!IMPORTANT] We don't accept external contributions containing minified code for this project. For such cases, we expect the maintainer who reviewed the source code to distribute the changes. The distribution should usually happen after merging the pull request in the sub-project. If that didn't happen, please open a new issue.
main
branch./lib/{lib_name}
/lib/{lib_name}/{desired_version}/
/lib/{lib_name}/{desired_version}/index.js
supported.json
(see example below):{
"{lib_name}": {
// Available package versions
"versions": [
"{desired_version}"
],
// (optional) Documentation's or repository's URL
"docs-url": "{documentation_or_repository_url}",
// (optional) As a default, the homepage will point to
// a package's bundle's index.js. If your package's main
// bundle name is different; set it here (see the AWS
// package for instance).
"bundle-filename": "{index.js}"
}
}
// Example result
{
"awesome-lib": {
"versions": [
"2.0.3",
"2.1.2"
],
"docs-url": "https://github.com/example/jslib",
"bundle-filename": "main.js"
}
}
/tests/basic.js
and /tests/testSuite.js
to ensure that the added lib is importable and runnable by k6.yarn run generate-homepage
./lib/index.html
is legit (Quickly done by running yarn run verify-homepage
).Running yarn run bundle $pkgName@pkgVersion
will try to run webpack bundling on the file located at /lib/$pkgName/$pkgBundle/index.src.js
.
If all goes well, you'll get a bundle file index.js
alongside the "src file".
If there is already a file named index.js
at the given path, you will be asked to override or exit.
When running this command, there will also be an option to run babel transpile on the bundle.
# Example
yarn run bundle [email protected]
main
branch./lib/{lib_name}/{desired_version}/
/lib/{lib_name}/{desired_version}/index.js
supported.json
like:{
"my-lib": [
"1.0.2",
// Use semantic versioning
"{desired_version}"
]
}
// Example result
{
"my-lib": [
"1.0.2",
"2.0.3"
]
}
/tests/basic.js
to ensure that the ported lib is importable and runnable by k6.yarn run generate-homepage
./lib/index.html
is legit (Quickly done by running yarn run verify-homepage
).The homepage of https://jslib.k6.io live in the /static
dir.
The final index.html
page gets generated by running yarn run generate-homepage
.
Useful dev commands:
# Listen to file changes, restart dev server and serve index.html
yarn run develop-homepage
# Quickly serve index.html
yarn run verify-homepage
# Generate index.html
yarn run generate-homepage
The outcome of this might vary depending on the quality of the desired node_module you want to add.
The following command will try to:
/lib
/lib/index.html
yarn run add-pkg {package_name}
Once run successfully, make sure that you do the following:
/tests/basic.js
to ensure that the ported lib is importable and runnable by k6./lib/index.html
is legit.Some of the JS packages in /lib/
can be libraries that exist on NPM today.
The following steps will help you add a specific (or latest) version of an existing npm package:
yarn upgrade {my_package}@version
(for specific version) yarn upgrade {my_package} --latest
(for the latest).yarn run copy-libs
If all went well, the following should have happened:
/lib/{my_package}/{new_version}/index.js
.support.json
(see example below){
"my_package": [
"1.0.2", // Previous version
"2.0.0" // New version added by copy-libs command.
]
}
If not, you will have to manually create the new version as described here.
Once a new version dir has been created and added to supported.json
, it is time to:
/tests/basic.js
to ensure that the added version is importable and runnable by k6.yarn run generate-homepage
./lib/index.html
is legit (Quickly done by running yarn run verify-homepage
).