From c4d96cc512d0891b9cbf7a166b282136b21ada82 Mon Sep 17 00:00:00 2001 From: Wes Todd Date: Tue, 17 Oct 2023 14:49:23 -0500 Subject: [PATCH] chore(docs): updated config docs --- workspaces/config/README.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/workspaces/config/README.md b/workspaces/config/README.md index 32418381a4c76..aa399cf7016c0 100644 --- a/workspaces/config/README.md +++ b/workspaces/config/README.md @@ -55,19 +55,14 @@ The resulting hierarchy of configs: ```js const Config = require('@npmcli/config') -// the types of all the configs we know about -const types = require('./config/types.js') -// default values for all the configs we know about -const defaults = require('./config/defaults.js') -// if you want -c to be short for --call and so on, define it here -const shorthands = require('./config/shorthands.js') +const { shorthands, definitions, flatten } = require('@npmcli/config/lib/definitions') const conf = new Config({ // path to the npm module being run npmPath: resolve(__dirname, '..'), - types, + definitions, shorthands, - defaults, + flatten, // optional, defaults to process.argv argv: process.argv, // optional, defaults to process.env