Skip to content

Commit a93479b

Browse files
committed
📝 we don't recommend people use our package.json feature as it will be removed
1 parent 3298b9b commit a93479b

File tree

2 files changed

+2
-18
lines changed

2 files changed

+2
-18
lines changed

README.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ JavaScript developers can now just open a `.ts` file and start hacking away like
2828
* Compile on save
2929
* Project Context Support (`tsconfig.json`)
3030
* Project Build Support
31-
* `package.json` Support
3231
* Format code
3332
* Goto Declaration
3433
* Find References
@@ -82,22 +81,6 @@ Shortcut: `F6`. If there are any errors they are shown as well.
8281

8382
![](https://raw.githubusercontent.com/TypeStrong/atom-typescript/master/docs/screens/build%20errors.png)
8483

85-
## `package.json` Support
86-
Where a sample `package.json` (anywhere next to or above a `tsconfig.json`) looks like:
87-
```json
88-
{
89-
"name": "awesome",
90-
"main": "./dist/foo.js",
91-
"typescript": {
92-
"definition": "./definition/awesome.d.ts"
93-
}
94-
}
95-
```
96-
97-
We would generate a `definition/awesome.d.ts` file for you *on build* so that other TypeScript projects can do a simple `require('awesome')`.
98-
99-
Note: Other people will be able to do `require('awesome')` only if their IDE supports looking at `node_modules` like we do. Otherwise they can always explicitly `/// <reference` your `awesome.d.ts` that we generate to get the same effect.
100-
10184
## Format Code
10285
Shortcut : `ctrl+alt+l` or `cmd+alt+l`. Will format just the selection if you have something selected otherwise it will format the entire file.
10386

docs/CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,5 @@ We only plan strictly document the breaking changes. The rest is optional.
1313
* We will now resolve a parent `package.json` for you *automatically* so that its *one less thing you need to configure*. :rose:
1414

1515
# Planned
16-
* No breaking changes yet.
16+
[](* No breaking changes yet.)
17+
* Remove `dts-generator` support as TypeScript will have a better module sharing story out of the box.

0 commit comments

Comments
 (0)