node.js – 如何在TypeScript中正确使用NodeJS目标的模块和接口？

我的团队和我是TypeScript和NodeJS的新手,我们遇到了一些严重的麻烦,让这个项目落地.它意味着是一个用TypeScript编写的模块化游戏资产管道,用于NodeJS(我在这里没有参与决策,讨论仍在进行中,但我们仍然需要一个原型).

我们已经很好地了解了这个架构,但是甚至很难让原型运行起来,因为我似乎无法理解模块如何与接口和外部依赖关系结合起来.我们的一些组件也需要使用NodeJS或其他库模块(例如NodeJS.fs用于读/写文件),我们更喜欢能够使用///引用添加适当的d.ts文件来保持类型开发时的安全性.

假设的项目结构的一个例子是：

/pipeline
    /log
        - ILog.d.ts
        - StdOutLog.ts
        - FileLog.ts
        - ...
    /reader
        - IReader.d.ts
        - TextReader.ts
        - ...
    /parser
        - IParser.d.ts
        - XmlParser.ts
        - JsonParser.ts
        - ...
    /task
        - ITask.d.ts
        - JsTask.ts
        - CliTask.ts
        - ...
    /...

我们想要使用它的方式是我们为接口提供默认实现(以涵盖基础知识,例如运行控制台命令,记录到文件或流,读取JSON和XML配置,……),以及接口本身,以便其他团队可以创建自己的扩展(例如,类GitTask扩展CliTask以封装存储库操作,或类JpgReader实现IReader).

在调用方面,在不同的项目/跑步者应用程序中,它应该像这样工作：

import pipeline = require('pipeline');

//...

var log = new pipeline.log.FileLog();
log.info("filelog started");

var parser = new pipeline.parser.XmlParser();
parser.parse(somexmldata);
log.info("parsing XML");

// ...

我很可能只是做错了(tm),但我觉得用TypeScript做我们想做的事情并不容易,特别是考虑到这一点.日志组件的定义可以很容易地有几个接口和枚举(工厂,记录器,logitem,logtarget,loglevel).据我所知,NodeJS模块需要是一个单独的JS文件,但即使使用一个导入也会将您的模块转换为外部模块,而这些模块将不再编译成单个文件,因此这似乎是一个相当陡峭的障碍.我.

有没有办法实现针对NodeJS的TypeScript的结构和预期用途？如果是,那么文件需要看起来像什么(特别是关于模块层次结构和组件FQN,例如pipeline.log.X,pipeline.task.Y等;我将如何正确使用模块并导出它)？如果不是,有什么方法可以实现我们的目标？

[更新]我根据basarat的建议重构了我的原型,它看起来已经比以前好多了.但是,我在使用另一个类时遇到了编译错误：

error TS2095: Could not find symbol 'LogItem'.

LogItem是在/ log中定义的类,它由StdOutLog.ts在同一文件夹中使用. IntelliJ为我提供了多个定义(显然,一个是LogItem类本身,另一个是/ log的索引文件,在那里它被导出).我已经尝试使用模块表示法log.LogItem,但这不起作用.将所有默认实现文件添加到全局声明文件也不起作用. [/更新]

[Update2]这里有一些关于错误发生位置的代码.只有在运行grunt-ts任务时,我才会在IntelliJ中收到任何错误/标记.

// src / log / LogItem.ts：

///<reference path='../pipeline.d.ts'/>
class LogItem implements ILogItem {
    // ...

    constructor(level:LogLevel, message:string) {
        // ...
    }

    public static create(level:LogLevel, message:string):ILogItem {
        return new LogItem(level, message);
    }

    // ...
}

export = LogItem;

// src / log / Log.ts：

///<reference path='../pipeline.d.ts'/>
class Log implements ILog {
    // ...

    private getLogItem(level:LogLevel, message:string):ILogItem {
        return LogItem.create(level, message); // <-- that's where I get the "symbol not found" error
    }

    // ...
}

export = Log;

// src / pipeline.d.ts：

///<reference path="../typings/node/node.d.ts" />

//grunt-start
/// <reference path="pipeline.ts" />
/// <reference path="log/Log.ts" />
/// <reference path="log/LogFactory.ts" />
/// <reference path="log/LogItem.ts" />
/// <reference path="log/StdLogEmitter.ts" />
/// <reference path="log/log.d.ts" />
/// <reference path="log/log.ts" />
/// <reference path="parser/JsonParser.ts" />
/// <reference path="parser/parser.d.ts" />
/// <reference path="parser/parser.ts" />
//grunt-end

[/ UPDATE2]

引用全局globals.d.ts文件中的所有.d.ts文件,该文件具有///<引用标记到所有单个引用vendor.d.ts(例如node.d.ts)文件.

/pipeline
    /globals.d.ts
    /log
        - ILog.d.ts
        - StdOutLog.ts
        - FileLog.ts
        - ...
    /reader
        - IReader.d.ts
        - TextReader.ts
        - ...
    /parser
        - IParser.d.ts
        - XmlParser.ts
        - JsonParser.ts
        - ...
    /task
        - ITask.d.ts
        - JsTask.ts
        - CliTask.ts
        - ...
    /...

这可以防止您不断引用.d.ts文件.

现在每个打字稿文件将导出一些类,例如XmlParser.ts：

/// <reference path='../globals.d.ts'/>
class XMLParser implements IParser{
}
export = XMLParser;

每个文件夹还有一个index.ts,用于导入和导出该文件夹中的所有类外部模块样式：

export import XmlParser = require('./xmlParser'); 
// so on

对于一个级别向上(管道/ index.ts)：

export import parser = require('./parser/index');

现在,如果您导入管道/ index.ts,您的代码将按预期工作：

import pipeline = require('./pipeline/index');


var parser = new pipeline.parser.XmlParser();
parser.parse(somexmldata);
log.info("parsing XML");

注意：Grunt-ts可以为您创建这些导入/导出语句,因此您无需担心文件路径：https://github.com/grunt-ts/grunt-ts/issues/85