Hvordan produsere en .d.ts "typings" definisjon fil fra en Javascript-bibliotek eksisterende?

Du kan enten bruke tsc --declaration fileName.tssom Ryan beskriver, eller du kan spesifisere declaration: trueetter compilerOptionsi ditt tsconfig.jsonforutsatt at du allerede har hatt en tsconfig.jsoni henhold til prosjektet.

Den beste måten å håndtere dette (hvis en erklæring filen ikke er tilgjengelig på DefinitelyTyped ) er å skrive erklæringer bare for de tingene du bruker i stedet for hele biblioteket. Dette reduserer arbeidet mye - og i tillegg kompilatoren er der for å hjelpe ut av klager om manglende metoder.

Som Ryan sier, har TSC kompilatoren en bryter --declarationsom genererer en .d.tsfil fra en .tsfil. Vær også oppmerksom på at (sperring bugs) Loggfila er ment å være i stand til å kompilere Javascript, slik at du kan passere eksisterende javascript-kode til TSC kompilatoren.

som beskrevet i http://channel9.msdn.com/posts/Anders-Hejlsberg-Steve-Lucco-and-Luke-Hoban-Inside-TypeScript på 00:33:52 de hadde bygget et verktøy for å konvertere WebIDL og WinRT metadata i Loggfila d.ts

Her er noen Powershell som skaper en enkelt Loggfila definisjonsfilen et bibliotek som inneholder flere *.jsfiler med moderne Javascript.

Først endre alle utvidelser til .ts.

Get-ChildItem | foreach { Rename-Item $_ $_.Name.Replace(".js", ".ts") }

For det andre bruker Loggfila kompilatoren å generere definisjonsfiler. Det vil være en haug med kompilatoren feil, men vi kan ignorere disse.

Get-ChildItem | foreach { tsc $_.Name  }

Til slutt, kombinere alle *.d.tsfiler til en index.d.ts, fjerne importuttalelser og fjerne defaultfra hvert eksport uttalelse.

Remove-Item index.d.ts; 

Get-ChildItem -Path *.d.ts -Exclude "Index.d.ts" | `
  foreach { Get-Content $_ } | `
  where { !$_.ToString().StartsWith("import") } | `
  foreach { $_.Replace("export default", "export") } | `
  foreach { Add-Content index.d.ts $_ }

Det ender med et enkelt, brukervennlig index.d.tsfil som inneholder mange av definisjonene.

Jeg vil se på en eksisterende kartlegging av tredje parts JS biblioteker som støtter Script # eller SharpKit. Brukere av disse C # til JS kryss kompilatorer vil ha møtt problemet du nå står overfor, og kanskje har publisert en åpen kildekode-program for å skanne tredje part lib og konvertere til skjelettet C # klasser. Hvis så hacke skanneren program for å generere Loggfila i stedet for C #.

Sviktende at sette en C # felles grensesnitt for tredje part lib inn Loggfila definisjoner kan være enklere enn å gjøre det samme ved å lese kilden Javascript.

Min spesiell interesse er Sencha er ExtJS RIA rammeverk og jeg vet det har vært prosjekter publisert å generere en C # tolkning Script # eller SharpKit

Når du oppretter ditt eget bibliotek, kan du opprette *.d.tsfiler ved hjelp av tsc(Loggfila Compiler) kommandoen slik: (forutsatt at du bygge ditt bibliotek til dist/libmappe)

tsc -d --declarationDir dist/lib --declarationMap --emitDeclarationOnly

• -d( --declaration): Genererer *.d.tsfiler
• --declarationDir dist/libUtgang katalog for genererte erklæring filer.
• --declarationMap: Genererer en sourcemap for hver tilsvarende' .d.ts' fil.
• --emitDeclarationOnly: Bare avgir' .d.ts erklæring filer. (Ingen kompilert JS)

(se dokumenter for alle kommandolinje kompilatoren alternativene)

Eller for eksempel i package.json:

"scripts": {
    "build:types": "tsc -d --declarationDir dist/lib --declarationMap --emitDeclarationOnly",
}

og deretter kjøre: yarn build:types(eller npm run build:types)