From 0e14a26749e52d7122fa3bbf28969198182f312f Mon Sep 17 00:00:00 2001 From: Alex Crome Date: Mon, 10 Oct 2022 12:31:23 +0100 Subject: [PATCH] Updated Configuration definition docs Added sample for what `package.json` should look like when defining a `configSchema` Signed-off-by: Alex Crome --- docs/conf/defining.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/conf/defining.md b/docs/conf/defining.md index 6462f4f60a..29964dbcbc 100644 --- a/docs/conf/defining.md +++ b/docs/conf/defining.md @@ -23,6 +23,17 @@ Each package is searched for a schema at a single point of entry, a top-level inlined JSON schema, or a relative path to a schema file. Supported schema file formats are `.json` or `.d.ts`. +```jsonc title="package.json" +{ + // ... + "files": [ + // ... + "config.d.ts" + ], + "configSchema": "config.d.ts" +} +``` + > When defining a schema file, be sure to include the file in your > `package.json` > `"files"` field as well!