From 7926ae9ff55e4e9ee09467ed84688809e1c8f8fc Mon Sep 17 00:00:00 2001 From: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com> Date: Tue, 26 Nov 2019 12:48:58 -0800 Subject: [PATCH] Update new package instructions (#40677) 1. Only index.d.ts is allowed in files list; all other d.ts files should be referenced from it. 2. Unreferenced files that nonetheless need to ship can be added to OTHER_FILES.txt --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 51a718011f..614464d516 100644 --- a/README.md +++ b/README.md @@ -171,7 +171,9 @@ Your package should have this structure: Generate these by running `npx dts-gen --dt --name my-package-name --template module` if you have npm ≥ 5.2.0, `npm install -g dts-gen` and `dts-gen --dt --name my-package-name --template module` otherwise. See all options at [dts-gen](https://github.com/Microsoft/dts-gen). -You may edit the `tsconfig.json` to add new files, to add `"target": "es6"` (needed for async functions), to add to `"lib"`, or to add the `"jsx"` compiler option. +You may edit the `tsconfig.json` to add new test files, to add `"target": "es6"` (needed for async functions), to add to `"lib"`, or to add the `"jsx"` compiler option. If you have `.d.ts` files besides `index.d.ts`, make sure that they are referenced either in `index.d.ts` or the tests. + +If a file is neither tested nor referenced in `index.d.ts`, add it to a file named `OTHER_FILES.txt`. This file is a list of other files that need to be included in the typings package, one file per line. Definitely Typed members routinely monitor for new PRs, though keep in mind that the number of other PRs may slow things down.