generano automaticamente le dichiarazioni di modulo ambientali

Question

Dato questi file 2 dattiloscritto

api/Token.ts

interface Token { 
    code: string 
} 
export default Token 

e index.ts

export * from './api/Token' 

TSC 1.5 con l'interruttore --declarations genererà due .d.ts files (con contenuti simili)

api/Token.d.ts

interface Token { 
    code: string; 
} 
export default Token; 

e index.d.ts

export * from './api/Token'; 

Esecuzione grugnito-DTS-fascio con le seguenti opzioni

dts_bundle: { 
     release: { 
      options: { 
       name: 'my-module', 
       main: 'index.d.ts' 
      } 
     } 
    } 

genererà un file di dichiarazione del modulo ambiente my-module.d.ts con il seguente contenuto

declare module 'my-module' { 
    export * from './api/Token'; 
} 

Tuttavia questa dichiarazione non compila a causa di: Import or export declaration in an ambient module declaration cannot reference module through relative module name.

Come posso automaticamente generare una dichiarazione del modulo ambiente per i due file dattiloscritto sopra?

EDIT

Si prega di seguire gli ultimi aggiornamenti sulla https://github.com/Microsoft/TypeScript/issues/2262

Answer 1

Recentemente ho scritto un blog post su questo. Per riassumere, si può usare autodts se si sostituisce index.ts con api.ts, contenente le seguenti:

export {default as Token} from './api/Token'; 

Assicurarsi api.ts è nello stesso luogo come directory api (accanto, non dentro di esso).

allora avete bisogno di un file package.json:

{ 
    "name": "api", 
    "version": "1.0.0", 
    "main": "dist/api.js", 
    "scripts": { 
    "preinstall": "npm install autodts", 
    "postinstall": "autodts link", 
    "prepublish": "tsc && autodts generate" 
    }, 
    "typescript": { 
    "definition": "index.d.ts" 
    }, 
    "dependencies": { 
    "autodts": "~0.0.4" 
    }, 
    "devDependencies": { 
    "@lib/autodts-generator": "~0.0.1", 
    "typescript": "~1.5.3" 
    } 
} 

E 'importante che il nome del pacchetto api corrisponde il file e la directory api.tsapi. In questo modo sia Node.js che il compilatore TypeScript guarderanno nello stesso posto quando usano il tuo pacchetto.

Infine, è necessario un file tsconfig.json:

{ 
    "compilerOptions": { 
     "declaration": true, 
     "module": "CommonJS", 
     "target": "es5", 
     "outDir": "dist" 
    }, 
    "files": [ 
     "api.ts" 
    ] 
} 

Ora npm install sarà compilare il pacchetto e produrre un file di index.d.ts in bundle come definito nell'impostazione definition in package.json.

Per utilizzare il pacchetto, è possibile fare qualcosa di simile:

/// <reference path = "api/index.d.ts" /> 

import {Token} from 'api'; 

class foo { 
    key: Token; 
} 

È possibile utilizzare autodts link per mantenere il reference path fino ad oggi, controllare il post sul blog e/o autodts docs per questo.

La risultante index.d.ts contiene:

/// <reference path="index.ref.d.ts" /> 
declare module 'api/Token' { 
    interface Token { 
     code: string; 
    } 
    export default Token; 

} 
declare module 'api' { 
    export { default as Token } from 'api/Token'; 

} 

index.ref.d.ts e api.js sono vuote.