Last active
July 28, 2024 07:41
-
-
Save okineadev/6d7b8db9dc9066be8119200fcae93d1c to your computer and use it in GitHub Desktop.
bunfig.toml configuration schema
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "$schema": "http://json-schema.org/draft-07/schema#", | |
| "type": "object", | |
| "title": "Bun configuration", | |
| "description": "Bun configuration schema for `bunfig.toml`", | |
| "$comment": "Author: Okinea Dev (https://github.com/okineadev). Made for Bun", | |
| "properties": { | |
| "preload": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#preload", | |
| "type": "array", | |
| "description": "An array of scripts/plugins to execute before running a file or script", | |
| "examples": [["./preload.ts"]] | |
| }, | |
| "jsx": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#jsx", | |
| "type": "string", | |
| "description": "Configure how Bun handles JSX. You can also set these fields in the `compilerOptions` of your `tsconfig.json`, but they are supported here as well for non-TypeScript projects", | |
| "examples": ["react"] | |
| }, | |
| "smol": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#smol", | |
| "type": "boolean", | |
| "description": "Enable `smol` mode. This reduces memory usage at the cost of performance" | |
| }, | |
| "logLevel": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#loglevel", | |
| "type": "string", | |
| "description": "Set the log level. This can be one of `\"debug\"`, `\"warn\"`, or `\"error\"`", | |
| "enum": ["debug", "warn", "error"], | |
| "examples": ["debug"] | |
| }, | |
| "define": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#define", | |
| "type": "object", | |
| "description": "The `define` field allows you to replace certain global identifiers with constant expressions. Bun will replace any usage of the identifier with the expression. The expression should be a JSON string" | |
| }, | |
| "loader": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#loader", | |
| "type": "object", | |
| "description": "Configure how Bun maps file extensions to loaders. This is useful for loading files that aren't natively supported by Bun" | |
| }, | |
| "telemetry": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#telemetry", | |
| "type": "boolean", | |
| "description": "The `telemetry` field permit to enable/disable the analytics records. Bun records bundle timings (so we can answer with data, \"is Bun getting faster?\") and feature usage (e.g., \"are people actually using macros?\"). The request body size is about 60 bytes, so it's not a lot of data. By default the telemetry is enabled. Equivalent of `DO_NOT_TRACK` env variable", | |
| "default": "true", | |
| "examples": ["false"] | |
| }, | |
| "test": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#test-runner", | |
| "description": "Test runner", | |
| "type": "object", | |
| "properties": { | |
| "root": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#test-root", | |
| "type": "string", | |
| "description": "The root directory to run tests from. Default `.`", | |
| "examples": ["./__tests__"] | |
| }, | |
| "preload": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#test-preload", | |
| "type": "array", | |
| "description": "Same as the top-level `preload` field, but only applies to `bun test`", | |
| "examples": [["./setup.ts"]] | |
| }, | |
| "smol": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#test-smol", | |
| "type": "boolean", | |
| "description": "Same as the top-level `smol` field, but only applies to `bun test`" | |
| }, | |
| "coverage": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#test-coverage", | |
| "type": "boolean", | |
| "description": "Enables coverage reporting. Default `false`. Use `--coverage` to override", | |
| "default": "false" | |
| }, | |
| "coverageThreshold": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#test-coveragethreshold", | |
| "type": ["integer", "object"], | |
| "description": "To specify a coverage threshold. By default, no threshold is set. If your test suite does not meet or exceed this threshold, `bun test` will exit with a non-zero exit code to indicate the failure", | |
| "examples": ["0.9", "{ line = 0.7, function = 0.8, statement = 0.9 }"] | |
| }, | |
| "coverageSkipTestFiles": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#test-coverageskiptestfiles", | |
| "type": "boolean", | |
| "description": "Whether to skip test files when computing coverage statistics. Default false" | |
| } | |
| } | |
| }, | |
| "install": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#package-manager", | |
| "type": "object", | |
| "description": "Package management is a complex issue; to support a range of use cases, the behavior of `bun install` can be configured under the `[install]` section", | |
| "properties": { | |
| "optional": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#install-optional", | |
| "type": "boolean", | |
| "description": "Whether to install optional dependencies. Default `true`", | |
| "default": "true" | |
| }, | |
| "dev": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#install-dev", | |
| "type": "boolean", | |
| "description": "Whether to install development dependencies. Default `true`", | |
| "default": "true" | |
| }, | |
| "peer": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#install-peer", | |
| "type": "boolean", | |
| "description": "Whether to install peer dependencies. Default `true`", | |
| "default": "true" | |
| }, | |
| "production": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#install-production", | |
| "type": "boolean", | |
| "description": "Whether bun install will run in \"production mode\". Default `false`\n\nIn production mode, `\"devDependencies\"` are not installed. You can use `--production` in the CLI to override this setting", | |
| "default": "false" | |
| }, | |
| "exact": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#install-exact", | |
| "type": "boolean", | |
| "description": "Whether to set an exact version in package.json. Default `false`\n\nBy default Bun uses caret ranges; if the `latest` version of a package is `2.4.1`, the version range in your `package.json` will be `^2.4.1`. This indicates that any version from `2.4.1` up to (but not including) `3.0.0` is acceptable", | |
| "default": "false" | |
| }, | |
| "auto": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#install-auto", | |
| "type": "string", | |
| "description": "To configure Bun's package auto-install behavior. Default `\"auto\"` — when no `node_modules` folder is found, Bun will automatically install dependencies on the fly during execution", | |
| "enum": ["auto", "force", "disable", "fallback"], | |
| "default": "auto" | |
| }, | |
| "frozenLockfile": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#install-frozenlockfile", | |
| "type": "boolean", | |
| "description": "When true, `bun install` will not update `bun.lockb`. Default `false`. If `package.json` and the existing `bun.lockb` are not in agreement, this will error", | |
| "default": "false" | |
| }, | |
| "dryRun": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#install-dryrun", | |
| "type": "boolean", | |
| "description": "Whether `bun install` will actually install dependencies. Default `false`. When true, it's equivalent to setting `--dry-run` on all `bun install` commands", | |
| "default": "false" | |
| }, | |
| "globalDir": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#install-globaldir", | |
| "type": "string", | |
| "description": "To configure the directory where Bun puts globally installed packages", | |
| "default": "~/.bun/install/global", | |
| "examples": ["~/.bun/install/global"] | |
| }, | |
| "globalBinDir": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#install-globalbindir", | |
| "type": "string", | |
| "description": "To configure the directory where Bun installs globally installed binaries and CLIs", | |
| "default": "~/.bun/bin", | |
| "examples": ["~/.bun/bin"] | |
| }, | |
| "registry": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#install-registry", | |
| "type": ["string", "object"], | |
| "description": "The default registry is `https://registry.npmjs.org/`. This can be globally configured in `bunfig.toml`", | |
| "default": "https://registry.npmjs.org/", | |
| "examples": [ | |
| "https://registry.npmjs.org", | |
| "{ url = \"https://registry.npmjs.org\", token = \"123456\" }", | |
| "https://username:password@registry.npmjs.org" | |
| ] | |
| } | |
| } | |
| }, | |
| "install.scopes": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#install-scopes", | |
| "type": "object", | |
| "description": "To configure a registry for a particular scope (e.g. `@myorg/<package>`) use `install.scopes`. You can reference environment variables with `$variable` notation" | |
| }, | |
| "install.cache": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#install-cache", | |
| "type": "object", | |
| "description": "To configure the cache behavior", | |
| "properties": { | |
| "dir": { | |
| "type": "string", | |
| "description": "The directory to use for the cache", | |
| "default": "~/.bun/install/cache", | |
| "examples": ["~/.bun/install/cache"] | |
| }, | |
| "disable": { | |
| "type": "boolean", | |
| "description": "When true, don't load from the global cache.\n\nBun may still write to `node_modules/.cache`" | |
| }, | |
| "disableManifest": { | |
| "type": "boolean", | |
| "description": "When true, always resolve the latest versions from the registry" | |
| } | |
| } | |
| }, | |
| "install.lockfile": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#install-lockfile", | |
| "type": "object", | |
| "description": "To configure lockfile behavior, use the `install.lockfile` section", | |
| "properties": { | |
| "save": { | |
| "type": "boolean", | |
| "description": "Whether to generate a lockfile on `bun install`. Default `true`", | |
| "default": "true" | |
| }, | |
| "print": { | |
| "type": "string", | |
| "description": "Whether to generate a non-Bun lockfile alongside `bun.lockb`. (A `bun.lockb` will always be created.) Currently `\"yarn\"` is the only supported value", | |
| "const": "yarn" | |
| } | |
| } | |
| }, | |
| "run": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#bun-run", | |
| "type": "object", | |
| "description": "The `bun run` command can be configured under the `[run]` section. These apply to the `bun run` command and the `bun` command when running a file or executable or script.\n\nCurrently, `bunfig.toml` isn't always automatically loaded for `bun run` in a local project (it does check for a global `bunfig.toml`), so you might still need to pass `-c` or `-c=bunfig.toml` to use these settings", | |
| "properties": { | |
| "shell": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#run-shell-use-the-system-shell-or-bun-s-shell", | |
| "type": "string", | |
| "description": "The shell to use when running package.json scripts via `bun run` or `bun`. On Windows, this defaults to `\"bun\"` and on other platforms it defaults to `\"system\"`", | |
| "enum": ["system", "bun"] | |
| }, | |
| "bun": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#run-bun-auto-alias-node-to-bun", | |
| "type": "boolean", | |
| "description": "Auto alias `node` to `bun`\n\nWhen `true`, this prepends `$PATH` with a `node` symlink that points to the `bun` binary for all scripts or executables invoked by `bun run` or `bun`\n\nThis means that if you have a script that runs `node`, it will actually run `bun` instead, without needing to change your script. This works recursively, so if your script runs another script that runs `node`, it will also run `bun` instead. This applies to shebangs as well, so if you have a script with a shebang that points to `node`, it will actually run `bun` instead.\n\nBy default, this is enabled if `node` is not already in your `$PATH`" | |
| }, | |
| "silent": { | |
| "$comment": "https://bun.sh/docs/runtime/bunfig#run-silent-suppress-reporting-the-command-being-run", | |
| "type": "boolean", | |
| "description": "When `true`, suppresses the output of the command being run by `bun run` or `bun`", | |
| "default": "false" | |
| } | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment