--emitDeclarationOnly flag to enable declarations only output by nojvek · Pull Request #20735 · microsoft/TypeScript

Noj Vek (nojvek) · 2017-12-16T19:30:31Z

Fixes Suggestion: a --noEmitJS compiler option #15158 and Can compiler only emit declaration file ? #1866. Part of fix for Allow --declaration with --allowJs #7546
Code is up-to-date with the master branch
You've successfully run jake runtests locally
You've signed the CLA
There are new or updated unit tests validating the change

Sheetal Nandi (sheetalkamat) · 2017-12-18T19:44:39Z

+            if (options.noEmitJs && !options.declaration) {
+                programDiagnostics.add(createCompilerDiagnostic(Diagnostics.Option_0_cannot_be_specified_without_specifying_option_1, "noEmitJs", "declaration"));
+            }
+


you would also want to skip verifyEmitFilePath(emitFileNames.jsFilePath, emitFilesSeen); down below when noEmitJs is true

Noj Vek (nojvek) · 2018-01-03T19:29:28Z

Kind ping regarding this Sheetal Nandi (@sheetalkamat)

Should I be adding any specific devs from typescript team to this PR? What's the usual process before a PR lands in the repo ?

Mohamed Hegazy (mhegazy) · 2018-01-05T00:45:20Z

            description: Diagnostics.Do_not_emit_outputs,
        },
+        {
+            name: "noEmitJs",


I think the name should be --emitDeclarationsOnly instead.

Mohamed Hegazy (mhegazy) · 2018-01-05T00:47:01Z

+            name: "noEmitJs",
+            type: "boolean",
+            showInSimplifiedHelpView: true,
+            category: Diagnostics.Basic_Options,


i would say this belongs into Advanced_Options

Advanced_options don't show up as part of --help or in default tsc --init. Doesn't it make sense that the option showed up there? I plan to enable allowJs + emitDeclarationsOnly in another PR which would help with lots of npm projects to auto-generate jsdoc to .d.ts declarations.

Puppeteer is one good example

Mohamed Hegazy (mhegazy) · 2018-01-05T00:47:19Z

        "category": "Message",
        "code": 6013
    },
+    "Do not emit js outputs.": {


Only emit declaration files.

Mohamed Hegazy (mhegazy) · 2018-01-05T00:48:30Z


    const ioSession = new IOSession(options);
-    process.on("uncaughtException", err => {
+    process.on("uncaughtException", (err: any) => {


Because it was failing compilation when doing a “gulp build” with an error.

should work now. that was a @types/node issue.

merge when microsoft/TypeScript#20735 hits

Bazyli Brzóska (niieani) · 2018-01-17T22:26:20Z

Noj Vek (@nojvek) awesome job so far! The Puppeteer community would love some progress on this! ❤️

Noj Vek (nojvek) · 2018-01-17T23:02:23Z

On it.

…

On Wed, Jan 17, 2018 at 2:26 PM Bazyli Brzóska ***@***.***> wrote: @nojvek <https://github.com/nojvek> the Puppeteer community would love some progress on this! ❤️ — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#20735 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA-JVO5w32fVMKrjX3ixMygNKGtq4l90ks5tLnOxgaJpZM4REbr-> .

Noj Vek (nojvek) · 2018-01-23T06:38:40Z

Mohamed Hegazy (@mhegazy) want to take another pass ?

Bazyli Brzóska (@niieani) - Unfortunately this PR doesn't enable emitting declarations from a JS project. I'll start work on it as soon as this PR lands.

Mohamed Hegazy (mhegazy) · 2018-01-24T23:59:04Z

Daniel Rosenwasser (@DanielRosenwasser) and Sheetal Nandi (@sheetalkamat) any concerns?

Bazyli Brzóska (niieani) · 2018-01-26T09:12:43Z

Thank you Noj Vek (@nojvek)! Looking forward to the next PR 😊!

Noj Vek (nojvek) · 2018-01-29T16:13:28Z

Mohamed Hegazy (@mhegazy) Sheetal Nandi (@sheetalkamat)

// @declaration: true
// @emitDeclarationsOnly: true

For consistency with declaration: true flag, does it make sense to call this new flag emitDeclarationOnly ?

        declaration?: boolean;
        emitDeclarationsOnly?: boolean;
        declarationDir?: string;

It seems the pattern is to use singular *declaration*.

What do you think ?

I can send a rename PR

Mohamed Hegazy (mhegazy) · 2018-01-30T00:04:34Z

humm.. good point.. we can change it to EmitDeclarationOnly

Noj Vek (nojvek) · 2018-01-30T00:06:31Z

K will send a rename PR

…

On Mon, Jan 29, 2018 at 4:05 PM Mohamed Hegazy ***@***.***> wrote: humm.. good point.. we can change it to EmitDeclarationOnly — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#20735 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA-JVDl4kIDfOb339mxN7auA52aTAzFYks5tPly4gaJpZM4REbr-> .

Mohamed Hegazy (mhegazy) · 2018-02-05T22:30:58Z

rename PR up in #21651

* Add emitOnlyDeclarations flag * Fix name * verifyOptions checking logic * Passing tests * doJsEmitBaseline * Tests !!!

* --emitDeclarationsOnly flag to enable declarations only output (#20735) * Add emitOnlyDeclarations flag * Fix name * verifyOptions checking logic * Passing tests * doJsEmitBaseline * Tests !!! * Rename switch `--emitDeclarationsOnly` to `--emitDeclarationOnly` (#21651) * Rename `--emitDeclarationsOnly` to `--renameDeclarationOnly` * Rename test files

Noj Vek (nojvek) changed the title ~~Adding noEmitJs flag to enable declarations only output~~ Dec 16, 2017

Sheetal Nandi (sheetalkamat) reviewed Dec 18, 2017

View reviewed changes

Mohamed Hegazy (mhegazy) suggested changes Jan 5, 2018

View reviewed changes

Len Boyette (kevlened) added a commit to kevlened/str2buf that referenced this pull request Jan 6, 2018

Add types

d9b235c

merge when microsoft/TypeScript#20735 hits

Bnaya Peretz (Bnaya) mentioned this pull request Jan 21, 2018

Suggestion: generate typescript declarations using angular/clutz (Closure to TypeScript .d.ts generator) puppeteer/puppeteer#1826

Closed

Noj Vek added 6 commits January 22, 2018 22:36

Add emitOnlyDeclarations flag

ee1d08e

Fix name

7aa27b8

verifyOptions checking logic

6a41628

Passing tests

fdcb8f4

doJsEmitBaseline

e9b6c99

Tests !!!

e34b4fb

Noj Vek (nojvek) changed the title ~~noEmitJs flag to enable declarations only output~~ Jan 23, 2018

Mohamed Hegazy (mhegazy) approved these changes Jan 24, 2018

View reviewed changes

Sheetal Nandi (sheetalkamat) approved these changes Jan 25, 2018

View reviewed changes

Mohamed Hegazy (mhegazy) merged commit afc588e into microsoft:master Jan 25, 2018

Mohamed Hegazy (mhegazy) mentioned this pull request Feb 5, 2018

Rename switch --emitDeclarationsOnly to --emitDeclarationOnly #21651

Merged

Mohamed Hegazy (mhegazy) changed the title ~~--emitDeclarationsOnly flag to enable declarations only output~~ Feb 5, 2018

Mohamed Hegazy (mhegazy) pushed a commit that referenced this pull request Feb 5, 2018

--emitDeclarationsOnly flag to enable declarations only output (#20735)

6496b0b

* Add emitOnlyDeclarations flag * Fix name * verifyOptions checking logic * Passing tests * doJsEmitBaseline * Tests !!!

Mohamed Hegazy (mhegazy) mentioned this pull request Feb 5, 2018

Port --emitDeclarationOnly flag support to release-2.7 #21654

Merged

Mohamed Hegazy (mhegazy) mentioned this pull request Feb 6, 2018

Add new flag support for TS 2.7.2 #21657

Closed

3 tasks

Daniel Rosenwasser (DanielRosenwasser) mentioned this pull request Feb 21, 2018

Only emit declaration files with TypeScript urql-graphql/urql#49

Merged

This was referenced Mar 5, 2018

Document --emitDeclarationOnly microsoft/TypeScript-Handbook#730

Open

Suggestion : Documentation about a proper/clean way to reuse types/interfaces in Babel 7 #22326

Closed

Microsoft (microsoft) locked and limited conversation to collaborators Jul 3, 2018

Navigation Menu

Uh oh!

--emitDeclarationOnly flag to enable declarations only output - #20735

--emitDeclarationOnly flag to enable declarations only output#20735
Mohamed Hegazy (mhegazy) merged 6 commits into
microsoft:masterfrom
nojvek:noEmitJs

Noj Vek (nojvek) commented Dec 16, 2017 •

edited

Loading

Sheetal Nandi (sheetalkamat) Dec 18, 2017

Noj Vek (nojvek) commented Jan 3, 2018

Mohamed Hegazy (mhegazy) Jan 5, 2018

Mohamed Hegazy (mhegazy) Jan 5, 2018

Noj Vek (nojvek) Jan 21, 2018 •

edited

Loading

Mohamed Hegazy (mhegazy) Jan 5, 2018

Mohamed Hegazy (mhegazy) Jan 5, 2018

Noj Vek (nojvek) Jan 5, 2018

Mohamed Hegazy (mhegazy) Jan 6, 2018

Bazyli Brzóska (niieani) commented Jan 17, 2018 •

edited

Loading

Noj Vek (nojvek) commented Jan 17, 2018 via email

Noj Vek (nojvek) commented Jan 23, 2018

Mohamed Hegazy (mhegazy) commented Jan 24, 2018

Bazyli Brzóska (niieani) commented Jan 26, 2018

Noj Vek (nojvek) commented Jan 29, 2018

Mohamed Hegazy (mhegazy) commented Jan 30, 2018

Noj Vek (nojvek) commented Jan 30, 2018 via email

Mohamed Hegazy (mhegazy) commented Feb 5, 2018

Labels

4 participants

Uh oh!

Conversation

Noj Vek (nojvek) commented Dec 16, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Sheetal Nandi (sheetalkamat) Dec 18, 2017

Choose a reason for hiding this comment

Noj Vek (nojvek) commented Jan 3, 2018

Mohamed Hegazy (mhegazy) Jan 5, 2018

Choose a reason for hiding this comment

Mohamed Hegazy (mhegazy) Jan 5, 2018

Choose a reason for hiding this comment

Noj Vek (nojvek) Jan 21, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Mohamed Hegazy (mhegazy) Jan 5, 2018

Choose a reason for hiding this comment

Mohamed Hegazy (mhegazy) Jan 5, 2018

Choose a reason for hiding this comment

Noj Vek (nojvek) Jan 5, 2018

Choose a reason for hiding this comment

Mohamed Hegazy (mhegazy) Jan 6, 2018

Choose a reason for hiding this comment

Bazyli Brzóska (niieani) commented Jan 17, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Noj Vek (nojvek) commented Jan 17, 2018 via email

Noj Vek (nojvek) commented Jan 23, 2018

Mohamed Hegazy (mhegazy) commented Jan 24, 2018

Bazyli Brzóska (niieani) commented Jan 26, 2018

Noj Vek (nojvek) commented Jan 29, 2018

Mohamed Hegazy (mhegazy) commented Jan 30, 2018

Noj Vek (nojvek) commented Jan 30, 2018 via email

Mohamed Hegazy (mhegazy) commented Feb 5, 2018

Labels

4 participants

Noj Vek (nojvek) commented Dec 16, 2017 •

edited

Loading

Noj Vek (nojvek) Jan 21, 2018 •

edited

Loading

Bazyli Brzóska (niieani) commented Jan 17, 2018 •

edited

Loading