Updated Configuration definition docs

Added sample for what `package.json` should look like when defining a `configSchema` Signed-off-by: Alex Crome <afscrome@users.noreply.github.com>
2022-10-10 12:31:23 +01:00
parent 25b49d2538
commit 0e14a26749
1 changed files with 11 additions and 0 deletions
@@ -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!