Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@oclif/config

oclif6.8mMITdeprecated1.18.17TypeScript support: included

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

base config object and standard interfaces for oclif components

oclif

readme

@oclif/config

This library has been replaced by @oclif/core and is now in maintenance mode. We will only consider PRs that address security concerns.

base config object and standard interfaces for oclif components

Version CircleCI Appveyor CI Known Vulnerabilities Downloads/week License

changelog

1.18.17 (2023-08-20)

Bug Fixes

  • deps: bump @oclif/parser from 3.8.16 to 3.8.17 (4b231ad)

1.18.16 (2023-07-30)

Bug Fixes

  • deps: bump @oclif/parser from 3.8.15 to 3.8.16 (a4acc8c)
  • deps: bump tslib from 2.6.0 to 2.6.1 (512c365)

1.18.15 (2023-07-23)

Bug Fixes

  • deps: bump @oclif/parser from 3.8.14 to 3.8.15 (c9477dc)

1.18.14 (2023-07-19)

Bug Fixes

  • deps: bump word-wrap from 1.2.3 to 1.2.4 (820f7e7)

1.18.13 (2023-07-16)

Bug Fixes

  • deps: bump @oclif/parser from 3.8.13 to 3.8.14 (5e0c708)

1.18.12 (2023-07-11)

Bug Fixes

  • deps: bump semver from 5.7.0 to 5.7.2 (16fa2c2)

1.18.11 (2023-07-02)

Bug Fixes

  • deps: bump @oclif/parser from 3.8.12 to 3.8.13 (a6b0b1a)

1.18.10 (2023-06-04)

Bug Fixes

  • deps: bump @oclif/parser from 3.8.11 to 3.8.12 (c7b3145)

1.18.9 (2023-05-21)

Bug Fixes

  • deps: bump @oclif/parser from 3.8.10 to 3.8.11 (3c58128)

1.18.8 (2023-01-29)

Bug Fixes

  • deps: bump @oclif/parser from 3.8.9 to 3.8.10 (61a8dc8)

1.18.7 (2023-01-29)

Bug Fixes

  • deps: bump tslib from 2.4.1 to 2.5.0 (48f732c)

1.18.6 (2022-11-06)

Bug Fixes

  • deps: bump @oclif/parser from 3.8.8 to 3.8.9 (6c30537)

1.18.5 (2022-10-02)

Bug Fixes

  • deps: bump @oclif/parser from 3.8.7 to 3.8.8 (b03591e)

1.18.4 (2022-10-01)

Bug Fixes

  • deps: bump @oclif/errors from 1.3.5 to 1.3.6 (8fbab15)

1.18.3 (2022-01-31)

Bug Fixes

Reverts

  • Revert "Fix plugins not being found when no node_modules exists (#171)" (3ac747b), closes #171

1.17.0 (2020-08-03)

Features

1.16.0 (2020-06-29)

Bug Fixes

Features

  • add postrun hook (#111) (149529d)
  • add support for experimentalDecorators and emitDecoratorMetadata from tsconfig.json (#97) (89bb82b)
  • adds support for WSL (#107) (d64a537)

1.15.1 (2020-04-14)

Bug Fixes

  • do not load oclif.devPlugins in production (#104) (c850bbe)

1.15.0 (2020-04-14)

Features

1.14.0 (2020-02-06)

Bug Fixes

Features

  • support .tsx files with JSX syntax (#96) (6c800f2)

1.13.3 (2019-08-15)

Bug Fixes

  • limit warning about missing files attribute (#86) (d84a238)

1.13.2 (2019-07-11)

1.13.1 (2019-07-10)

1.13.0 (2019-05-09)

Features

1.12.12 (2019-03-29)

Bug Fixes

  • allow process.emitWarning to receive non-error object (#79) (647a78e)

1.12.11 (2019-03-20)

Bug Fixes

1.12.10 (2019-03-13)

Bug Fixes

  • allow loading typescript from plugin root (#77) (30df3fe)

1.12.9 (2019-02-27)

1.12.8 (2019-02-19)

1.12.7 (2019-02-19)

Bug Fixes

  • hide debug warning if typescript is not found (#75) (6994d0a)

1.12.6 (2019-02-11)

1.12.5 (2019-02-11)

Bug Fixes

1.12.4 (2019-01-31)

1.12.3 (2019-01-31)

Bug Fixes

  • Lazy require 'typescript' module. (#72) (49ed0bd)

1.12.2 (2019-01-30)

1.12.1 (2019-01-30)

Bug Fixes

  • Use typescript's tsconfig.json parsing functionality instead of JSON.parse (#70) (7324a99)

1.12.0 (2019-01-18)

1.11.0 (2019-01-18)

Features

1.10.4 (2018-12-27)

Bug Fixes

1.10.3 (2018-12-21)

Bug Fixes

1.10.2 (2018-12-18)

1.10.1 (2018-12-18)

Bug Fixes

  • move conventional-changelog to devDeps (466ead8)

1.10.0 (2018-12-18)

Features

1.9.0 (2018-11-07)

Features

1.8.8 (2018-10-13)

Bug Fixes

  • remove greenkeeper badge (99fb3ab)

1.8.7 (2018-10-13)

Bug Fixes

1.8.6 (2018-10-04)

Bug Fixes

  • Add channel and version to config ctor options (#60) (65ce583)

1.8.5 (2018-10-04)

Bug Fixes

1.8.4 (2018-10-03)

Bug Fixes

  • Hook.PluginsPreinstall shape (52a420a)

1.8.3 (2018-10-03)

Bug Fixes

  • Add missing Hook.Update (9c7e0e6)

1.8.2 (2018-10-03)

Bug Fixes

1.8.1 (2018-10-02)

Bug Fixes

  • plugins:install->preinstall (2d501d7)

1.8.0 (2018-10-02)

Features

1.7.6 (2018-09-14)

Bug Fixes

1.7.5 (2018-09-13)

Bug Fixes

1.7.4 (2018-08-31)

Bug Fixes

  • cache allowNo on boolean flags (05964f7)

1.7.3 (2018-08-30)

Bug Fixes

1.7.2 (2018-08-27)

Bug Fixes

1.7.1 (2018-08-27)

Bug Fixes

  • exclude spec files from being loaded as commands (#46) (5854d34), closes #158

1.7.0 (2018-08-17)

Features

1.6.33 (2018-06-20)

Bug Fixes

1.6.32 (2018-06-18)

Bug Fixes

  • add rootDir from tsconfig for plugins that use it (#39) (a6078d1)

Reverts

  • Revert "fix: --declarationMap" (7c5284d)

1.6.31 (2018-06-16)

Bug Fixes

1.6.30 (2018-06-15)

Bug Fixes

1.6.29 (2018-06-15)

Bug Fixes

1.6.28 (2018-06-12)

Bug Fixes

1.6.27 (2018-06-01)

Bug Fixes

1.6.26 (2018-06-01)

Bug Fixes

  • add optional url type to user plugins (57cb0c5)

1.6.25 (2018-06-01)

Bug Fixes

1.6.24 (2018-05-31)

1.6.23 (2018-05-31)

Bug Fixes

  • make imports not use "import *" to avoid node warning (eac2edc)

1.6.22 (2018-05-31)

Bug Fixes

1.6.21 (2018-05-26)

Bug Fixes

  • do not default registry (e29ceef)

1.6.20 (2018-05-26)

Bug Fixes

  • warn if files attribute is not specified (cc73cb5)

1.6.19 (2018-05-17)

Bug Fixes

1.6.18 (2018-05-11)

Bug Fixes

1.6.17 (2018-05-03)

Bug Fixes

  • allow reading oclif manifest not as a dotfile (7ee3007)

1.6.16 (2018-05-01)

Bug Fixes

  • set cwd to project root when loading ts-node (d120ec1)

1.6.15 (2018-04-30)

Bug Fixes

  • use require.resolve to find globby and ts-node (0a75d62)

1.6.14 (2018-04-30)

Bug Fixes

  • use ts-node and globby from root of plugin (e86e23a)

1.6.13 (2018-04-21)

Bug Fixes

1.6.12 (2018-04-21)

Bug Fixes

1.6.11 (2018-04-21)

Bug Fixes

1.6.10 (2018-04-21)

Bug Fixes

  • skip loading existing plugins (f6d5a76)

1.6.9 (2018-04-21)

Bug Fixes

1.6.8 (2018-04-21)

Bug Fixes

1.6.7 (2018-04-21)

Bug Fixes

  • add valid flag to iconfig (80d4bf9)

1.6.6 (2018-04-20)

Bug Fixes

1.6.5 (2018-04-20)

Bug Fixes

1.6.4 (2018-04-17)

Bug Fixes

1.6.3 (2018-04-10)

Bug Fixes

1.6.2 (2018-04-10)

Bug Fixes

  • plugin actually needs to be nullable (0669622)

1.6.1 (2018-04-10)

Bug Fixes

1.6.0 (2018-04-10)

Bug Fixes

  • export platform and arch types (471ba1a)

Features

1.5.0 (2018-04-10)

Features

1.4.14 (2018-04-10)

Bug Fixes

1.4.13 (2018-04-09)

Bug Fixes

  • add versioned/non-versioned tarball templates (b8409f6)

1.4.12 (2018-04-09)

Bug Fixes

  • new template format for stable channels (1f27a10)

1.4.11 (2018-04-09)

Bug Fixes

1.4.10 (2018-04-09)

Bug Fixes

1.4.9 (2018-04-09)

Bug Fixes

1.4.8 (2018-04-09)

Bug Fixes

1.4.7 (2018-04-09)

Bug Fixes

  • add debug to hook context (8c9d9bd)

1.4.6 (2018-04-09)

Bug Fixes

1.4.5 (2018-04-08)

Bug Fixes

1.4.4 (2018-04-08)

Bug Fixes

  • use dirname for s3 path (69d5e2d)

1.4.3 (2018-04-08)

Bug Fixes

1.4.2 (2018-04-08)

Bug Fixes

1.4.1 (2018-04-08)

Bug Fixes

  • improve mismatch version warning (8a670bd)
  • set s3Host automatically (29503dd)

1.4.0 (2018-04-07)

Features

  • added s3 template strings (220580a)

1.3.68 (2018-04-07)

Bug Fixes

1.3.67 (2018-04-07)

Bug Fixes

1.3.66 (2018-04-07)

Bug Fixes

  • added props for updater (6c11c6f)

1.3.65 (2018-04-07)

Bug Fixes

1.3.64 (2018-04-07)

Bug Fixes

1.3.63 (2018-04-07)

Bug Fixes

1.3.62 (2018-03-26)

Bug Fixes

  • add config to hook context (f06fa67)

1.3.61 (2018-03-24)

Bug Fixes

1.3.60 (2018-03-24)

Bug Fixes

  • move debug to dependencies (ff29737)

1.3.59 (2018-03-15)

Bug Fixes

  • add an option to throw instead or warn on manifest create (573c26e)

1.3.58 (2018-02-28)

Bug Fixes

1.3.57 (2018-02-17)

Bug Fixes

  • add description to command topics (684c214)

1.3.56 (2018-02-17)

Bug Fixes

1.3.55 (2018-02-17)

Bug Fixes

1.3.54 (2018-02-17)

Bug Fixes

1.3.53 (2018-02-17)

Bug Fixes

  • make plugin optional for single-command support (9086435)

1.3.52 (2018-02-14)

Bug Fixes

  • remove parens around platform/arch (d3f78ba)

1.3.51 (2018-02-13)

Bug Fixes

  • split on - when checking version (699b922)

1.3.50 (2018-02-13)

Bug Fixes

  • added scopedEnvVar* to iconfig (718bdeb)

1.3.49 (2018-02-13)

Bug Fixes

1.3.48 (2018-02-13)

Bug Fixes

1.3.47 (2018-02-13)

Bug Fixes

1.3.46 (2018-02-13)

Bug Fixes

1.3.45 (2018-02-07)

Bug Fixes

1.3.44 (2018-02-07)

Bug Fixes

  • remove undefined topics (1070e57)

1.3.43 (2018-02-07)

Bug Fixes

  • make scoped package scopes friendlier (43cc3d9)

1.3.42 (2018-02-07)

Bug Fixes

1.3.41 (2018-02-07)

Bug Fixes

  • ensure config gets sent (1bd765f)

1.3.40 (2018-02-07)

Bug Fixes

1.3.39 (2018-02-07)

Bug Fixes

1.3.38 (2018-02-07)

Performance Improvements

  • use fs instead of load-json-file (7091b4d)

1.3.37 (2018-02-07)

Bug Fixes

  • fixed skipping of ts-node (62658b3)

1.3.36 (2018-02-07)

Bug Fixes

1.3.35 (2018-02-07)

Bug Fixes

1.3.34 (2018-02-07)

Bug Fixes

1.3.33 (2018-02-07)

Bug Fixes

  • allow finding root with name (a559ee2)

1.3.32 (2018-02-07)

Bug Fixes

1.3.31 (2018-02-07)

Bug Fixes

1.3.30 (2018-02-07)

Bug Fixes

  • build topics dynamically (8418ace)

1.3.29 (2018-02-07)

Bug Fixes

1.3.28 (2018-02-07)

Bug Fixes

  • allow legacy converter to set commands (aa75c49)

1.3.27 (2018-02-07)

Bug Fixes

  • add config to hook opts (1eb0417)

1.3.26 (2018-02-07)

Bug Fixes

1.3.25 (2018-02-07)

Bug Fixes

  • merge plugin properties (b5c2553)

1.3.24 (2018-02-07)

Bug Fixes

  • ignore version mismatch when publishing (9a3e71b)

1.3.23 (2018-02-06)

Bug Fixes

1.3.22 (2018-02-06)

Bug Fixes

1.3.21 (2018-02-06)

Bug Fixes

  • fixed bugs with topic parsing (fb639fd)

1.3.20 (2018-02-06)

Bug Fixes

1.3.19 (2018-02-06)

Bug Fixes

1.3.18 (2018-02-06)

Bug Fixes

1.3.17 (2018-02-06)

Bug Fixes

1.3.16 (2018-02-06)

Bug Fixes

  • added flags for dev + user plugins (621cac8)

1.3.15 (2018-02-06)

Bug Fixes

  • raise errors if must is set (a662a73)

1.3.14 (2018-02-06)

Bug Fixes

  • added examples to cache (f6d9be9)

1.3.13 (2018-02-06)

Bug Fixes

  • remove title in favor of description (26f5dc3)

1.3.12 (2018-02-06)

Bug Fixes

1.3.11 (2018-02-06)

Bug Fixes

  • fix return when no globby (dde0f09)

1.3.10 (2018-02-06)

Bug Fixes

  • fixed error propagation (2cbeaf9)

1.3.9 (2018-02-06)

Bug Fixes

  • move @anycli/errors to dev deps (41bb4b5)
  • move @anycli/errors to dev deps (34cd88a)
  • use @anycli/errors (d23cd49)

1.3.7 (2018-02-06)

Bug Fixes

  • use CLIError when command is not found (ef0a6ac)

1.3.6 (2018-02-06)

Bug Fixes

  • make plugin more easily extendable (735667c)

1.3.5 (2018-02-06)

Bug Fixes

1.3.4 (2018-02-05)

Bug Fixes

1.3.3 (2018-02-05)

Bug Fixes

  • fixed passing error to cli-ux (2389fe5)

1.3.2 (2018-02-05)

Bug Fixes

1.3.1 (2018-02-05)

Bug Fixes

1.3.0 (2018-02-05)

Bug Fixes

Features

1.2.3 (2018-02-05)

Bug Fixes

1.2.2 (2018-02-05)

Bug Fixes

1.2.1 (2018-02-05)

Bug Fixes

1.2.0 (2018-02-05)

Features

1.1.8 (2018-02-05)

Bug Fixes

1.1.7 (2018-02-05)

Bug Fixes

  • optionally include id on init (a436947)

1.1.6 (2018-02-05)

Bug Fixes

1.1.5 (2018-02-05)

Bug Fixes

  • make dependencies optional (14dcaa5)

1.1.4 (2018-02-05)

Bug Fixes

  • make dependencies optional (177bf45)

1.1.3 (2018-02-05)

Bug Fixes

  • remove cli-ux and lodash from deps (7dbb4c9)

1.1.2 (2018-02-03)

Bug Fixes

1.1.1 (2018-02-03)

Bug Fixes

  • let command call the init hook (aa67851)

1.1.0 (2018-02-03)

Features

  • added init and prerun hooks (cf9fe20)

1.0.20 (2018-02-03)

Bug Fixes

1.0.19 (2018-02-03)

Bug Fixes

  • fixed already loaded flag (a617ab1)

1.0.18 (2018-02-03)

Bug Fixes

1.0.17 (2018-02-03)

Bug Fixes

  • skip loading plugin if already loaded (35897b0)

1.0.16 (2018-02-03)

Bug Fixes

1.0.15 (2018-02-03)

Bug Fixes

  • add interfaces for plugin types (9af2a66)
  • improve plugin typing (9a6e1d5)

1.0.14 (2018-02-03)

Bug Fixes

  • add name to link plugins (6b9e448)

1.0.13 (2018-02-03)

Bug Fixes

1.0.12 (2018-02-03)

Bug Fixes

1.0.11 (2018-02-03)

Bug Fixes

1.0.10 (2018-02-03)

Bug Fixes

  • add command/topic getters (92a8316)

1.0.9 (2018-02-03)

Bug Fixes

  • add ignoreManifest flag (0988509)

1.0.8 (2018-02-03)

Bug Fixes

  • fixed tsPath when no tsconfig (8cf8808)

1.0.7 (2018-02-03)

Bug Fixes

  • move up config require just in case (cec67ea)

1.0.6 (2018-02-03)

Bug Fixes

1.0.5 (2018-02-03)

Bug Fixes

  • actually we need argv in ctor (087771f)

1.0.4 (2018-02-03)

Bug Fixes

1.0.3 (2018-02-03)

Bug Fixes

  • add undefined to options (ed4c718)

1.0.2 (2018-02-03)

Bug Fixes

1.0.1 (2018-02-03)

Bug Fixes

Features

  • move engine logic into config (003c74f)

BREAKING CHANGES

  • this is a big refactor that consolidates the code from @anycli/config and @anycli/engine

0.3.3 (2018-02-02)

Bug Fixes

0.3.2 (2018-02-02)

Bug Fixes

  • added plugin attribute to icommand (709921b)

0.3.1 (2018-02-02)

Bug Fixes

0.3.0 (2018-02-02)

Features

0.2.11 (2018-02-01)

Bug Fixes

  • add getPluginCommands and read tsconfig when no .git (623204e)

0.2.10 (2018-02-01)

Bug Fixes

  • add constructor to icommand (9b2e1b0)

0.2.9 (2018-02-01)

Bug Fixes

  • add constructor to icommand (ca0bd58)

0.2.8 (2018-02-01)

Bug Fixes

  • fixed typing on command args/flags (2517177)

0.2.7 (2018-02-01)

Bug Fixes

0.2.6 (2018-02-01)

Bug Fixes

  • set flags/args to parser types (f2344a8)

0.2.5 (2018-02-01)

Bug Fixes

0.2.4 (2018-02-01)

Bug Fixes

0.2.3 (2018-01-31)

Bug Fixes

  • make config required in constructor only (78124f7)

0.2.2 (2018-01-31)

Bug Fixes

0.2.1 (2018-01-31)

Bug Fixes

  • add title + description to pjson (ddfe082)

0.2.0 (2018-01-31)

Features

0.1.41 (2018-01-31)

Bug Fixes

0.1.40 (2018-01-30)

Bug Fixes

  • assume engine is always on config (8d02f30)

0.1.39 (2018-01-30)

Bug Fixes

0.1.38 (2018-01-29)

Bug Fixes

0.1.37 (2018-01-29)

Bug Fixes

  • have engine take config instead of root (23e3516)

0.1.36 (2018-01-29)

Bug Fixes

0.1.35 (2018-01-29)

Bug Fixes

0.1.34 (2018-01-29)

Bug Fixes

0.1.33 (2018-01-28)

Bug Fixes

  • added extra help properties (39effe2)

0.1.32 (2018-01-28)

Bug Fixes

  • TS loading improvements (fcae462)

0.1.31 (2018-01-28)

Bug Fixes

0.1.30 (2018-01-28)

Bug Fixes

0.1.29 (2018-01-28)

Bug Fixes

  • limit plugin types required (309482e)

0.1.28 (2018-01-28)

Bug Fixes

0.1.27 (2018-01-28)

Bug Fixes

0.1.26 (2018-01-26)

Bug Fixes

0.1.25 (2018-01-26)

Bug Fixes

  • added plugin attributes (10fde6f)

0.1.24 (2018-01-25)

Bug Fixes

  • use rootDirs not rootDir (dcba41b)

0.1.23 (2018-01-25)

Bug Fixes

0.1.22 (2018-01-25)

Bug Fixes

0.1.21 (2018-01-20)

Bug Fixes

  • added command_not_found hook (a5db89e)
  • use CLIConfig in hooks (4c6862a)

0.1.20 (2018-01-20)

Bug Fixes

0.1.19 (2018-01-20)

Bug Fixes

  • updated plugin properties (df26a0c)

0.1.18 (2018-01-20)

Bug Fixes

0.1.17 (2018-01-19)

Bug Fixes

  • default root to parent path (48e8261)

0.1.16 (2018-01-19)

Bug Fixes

  • do not require opts to read (dcf4907)

0.1.15 (2018-01-19)

Bug Fixes

0.1.14 (2018-01-19)

Bug Fixes

0.1.13 (2018-01-19)

Bug Fixes

  • make compatible with @dxcli/command (3ac9c6d)

0.1.12 (2018-01-19)

Bug Fixes

0.1.11 (2018-01-19)

Bug Fixes

0.1.10 (2018-01-19)

Bug Fixes

0.1.9 (2018-01-19)

Bug Fixes

0.1.8 (2018-01-19)

Bug Fixes

0.1.7 (2018-01-19)

Bug Fixes

0.1.6 (2018-01-19)

Bug Fixes

0.1.5 (2018-01-18)

Bug Fixes

0.1.4 (2018-01-17)

Bug Fixes

0.1.3 (2018-01-17)

Bug Fixes

0.1.2 (2018-01-17)

Bug Fixes

  • needed changes for loader (6418f12)

0.1.1 (2018-01-16)

Bug Fixes

0.1.0 (2018-01-16)

Features

  • added base config object (0e9824c)

0.0.0 (2018-01-13)