Configuration

The configuration file for the CLI can be placed in the following locations:

• An omlet property in the package.json file.

• An .omletrc file in JSON or YAML format in the root directory of your repository

• An .omletrc.json, .omletrc.yaml, .omletrc.yml, or .omletrc.js file in the root directory of your repository

Alternatively, you can also specify a custom configuration file name and location using the --config option in the CLI command:

npm

npx @omlet/cli analyze --config './path/file'

yarn

yarn dlx @omlet/cli analyze --config './path/file'

pnpm

pnpm dlx @omlet/cli analyze --config './path/file'

Properties

The configuration file can include the following properties:

include

Filenames or glob patterns that will be included in the scan.

{
  "include": string[]
}

ignore

Filenames or glob patterns that will be excluded from the scan.

{
    "ignore": string[]
}

aliases

Custom alias configurations.

"aliases": {
    [name: string]: string[]
}

exports

Corresponding entry points of packages.

"exports": {
    [name: string]: string[]
}

workspaces

Package-specific configurations if you have a monorepo.

"workspaces": {
  [packageName: string]: {
    "aliases": {
      [name: string]: string[]
    }
  }
}

tsconfigpath

Path to your tsconfig file.

"tsconfigPath": string

include, ignore, and tsconfigPath properties can be set using either command-line arguments or the configuration file. If a property is provided as a command-line argument, the corresponding value in the configuration file will be ignored. A default value will be used if a property is not set via the configuration file or command-line argument.