Config ​

Civet offers many configuration options to adjust the language to your liking. We start with the various options, and then show the various ways that they can be specified.

General Options ​

Import Options ​

TypeScript only allows importing .ts files as .js; see this issue. As a workaround, Civet automatically rewrites imports to .ts into imports to .js. Some environments, such as Deno, allow importing .ts directly, and following ESM, require importing files with the correct extension.

Language Options ​

ECMAScript Compatibility ​

Eventually, we plan a jsCompat compatibility flag to modify Civet to be closer to pure ECMAScript, removing the few places where Civet is not a superset of ECMAScript. For now, we have the following related options:

CoffeeScript Compatibility ​

Environment Options ​

Running in a particular environment? Try one of these options:

Local Configuration via Directives ​

At the top of any Civet file (possibly after a #! line, comments, triple slash directives, and other string directives such as "use strict"), you can specify one or more configurations with a "civet" directive. For example:

"civet objectIs -implicit-returns tab=2"

"civet objectIs -implicit-returns tab=2"

This directive specifies that:

• The is operator should be implemented via Object.is
• Implicit returns are disabled
• Tab characters should be treated like 2 spaces

In general, a word like objectIs or object-is enables a feature; a negated word like -implicitReturns or -implicit-returns disables a feature; and an assignment like tab=2 specifies a value for a feature (in rare cases). You can use camelCase or kebab-case as you prefer.

Global Configuration via Config Files ​

In the root directory of your project, or in a .config subdirectory, you can add one of the following files:

• 🐈.json
• civetconfig.json
• civet.config.json
• package.json with a "civetConfig" property
• Any of the above with .yaml or .yml extension
  • Requires yaml to be installed as optional peerDependencies
  • In particular, supports package.yaml with a "civetConfig" property
• Any of the above with a .civet or .js extension, with code that export defaults an object equivalent to a JSON file.

The JSON data should consist of an object with a "parseOptions" property, which should be an object specifying one of more directives in the natural way. For example, the directive"civet objectIs -implicit-returns tab=2" is equivalent to:

{
  "parseOptions": {
    "objectIs": true,
    "implicitReturns": false,
    "tab": 2
  }
}

{
  "parseOptions": {
    "objectIs": true,
    "implicitReturns": false,
    "tab": 2
  }
}

Global Configuration within Build Tools ​

The unplugin offers options to specify global config directives (overriding even config files) and to specify or disable a config file. For example:

civetPlugin({
  parseOptions: {
    objectIs: true,
    implicitReturns: false,
    tab: 2,
  },
})

civetPlugin({
  parseOptions: {
    objectIs: true,
    implicitReturns: false,
    tab: 2,
  },
})

Configuration via API ​

The Civet compilation API (compile) offers a similar parseOptions for specifying config directives:

import {compile} from "@danielx/civet"
const code = await compile(civetCode, {
  parseOptions: {
    objectIs: true,
    implicitReturns: false,
    tab: 2,
  },
})

import {compile} from "@danielx/civet"
const code = await compile(civetCode, {
  parseOptions: {
    objectIs: true,
    implicitReturns: false,
    tab: 2,
  },
})

compile does not look at config files. Instead, you can use the config module to look for and parse config files:

import { findInDir, findConfig, loadConfig } from "@danielx/civet/config"
// Look for standard name for config file in specified directory
const path1 = await findInDir(process.cwd())
// Look for standard name for config file in specified directory or ancestors
const path2 = await findConfig(process.cwd())
// Load config file from specified path
const config = await loadConfig(path)
// Pass config to compile
const code = await compile(civetCode, config)

import { findInDir, findConfig, loadConfig } from "@danielx/civet/config"
// Look for standard name for config file in specified directory
const path1 = await findInDir(process.cwd())
// Look for standard name for config file in specified directory or ancestors
const path2 = await findConfig(process.cwd())
// Load config file from specified path
const config = await loadConfig(path)
// Pass config to compile
const code = await compile(civetCode, config)

Configuration via CLI ​

By default, the Civet CLI searches all ancestor directories of the current directory for a configuration file with a standard name. It also options to specify config directives and to override config files:

# Specify a directive
civet --civet "objectIs -implicit-returns tab=2" ...
# Specify a config file
civet --config custom-config.civet ...
# Disable config files
civet --no-config ...

# Specify a directive
civet --civet "objectIs -implicit-returns tab=2" ...
# Specify a config file
civet --config custom-config.civet ...
# Disable config files
civet --no-config ...

Compiler Options ​

In addition to the "parse options" described above, there are a few top-level options (above parseOptions):

• threads: Use specified number of Node worker threads to compile Civet files faster. Default: 0 (don't use threads), or CIVET_THREADS environment variable if set.