我正在尝试将宠物项目转换为 TypeScript,但似乎无法使用该tsc
实用程序来查看和编译我的文件。帮助说我应该使用-w
开关,但它看起来无法*.ts
递归地观察和编译某个目录中的所有文件。这似乎tsc
应该能够处理。我有哪些选择?
11 回答
创建一个以tsconfig.json
项目根目录命名的文件,并在其中包含以下行:
{
"compilerOptions": {
"emitDecoratorMetadata": true,
"module": "commonjs",
"target": "ES5",
"outDir": "ts-built",
"rootDir": "src"
}
}
请注意,它outDir
应该是接收编译好的 JS 文件rootDir
的目录的路径,并且应该是包含您的源(.ts)文件的目录的路径。
打开终端并运行tsc -w
,它会将目录中的任何.ts
文件编译src
到.js
并存储在ts-built
目录中。
TypeScript 1.5 beta 引入了对名为tsconfig.json
. 在该文件中,您可以配置编译器,定义代码格式化规则,更重要的是,为您提供有关项目中 TS 文件的信息。
一旦正确配置,您可以简单地运行该tsc
命令并让它编译您项目中的所有 TypeScript 代码。
如果你想让它监视文件的变化,那么你可以简单地添加--watch
到tsc
命令中。
这是一个示例 tsconfig.json 文件
{
"compilerOptions": {
"target": "es5",
"module": "commonjs",
"declaration": false,
"noImplicitAny": false,
"removeComments": true,
"noLib": false
},
"include": [
"**/*"
],
"exclude": [
"node_modules",
"**/*.spec.ts"
]}
在上面的示例中,我将所有.ts
文件包含在我的项目中(递归地)。请注意,您还可以使用"exclude"
带有数组的属性来排除文件。
有关更多信息,请参阅文档:http ://www.typescriptlang.org/docs/handbook/tsconfig-json.html
你可以像这样观看所有文件
tsc *.ts --watch
从技术上讲,您在这里有几个选择:
如果您使用像 Sublime Text 这样的 IDE 和用于 Typescript 的集成 MSN 插件:http: //blogs.msdn.com/b/interoperability/archive/2012/10/01/sublime-text-vi-emacs-typescript-enabled。 aspx.ts
你可以创建一个自动编译源代码的构建系统.js
。以下是如何做到这一点的解释:如何为 TypeScript 配置 Sublime 构建系统。
.js
您甚至可以定义在文件保存时将源代码编译到目标文件。在 github 上托管了一个 sublime 包:https ://github.com/alexnj/SublimeOnSaveBuild可以实现这一点,只需要在文件中包含ts
扩展名。SublimeOnSaveBuild.sublime-settings
另一种可能性是在命令行中编译每个文件。您甚至可以一次编译多个文件,方法是用空格分隔它们:tsc foo.ts bar.ts
. 检查此线程:如何将多个源文件传递给 TypeScript 编译器?,但我认为第一个选项更方便。
其他答案可能在几年前很有用,但现在已经过时了。
鉴于项目有一个tsconfig文件,请运行此命令...
tsc --watch
...监视更改的文件并根据需要进行编译。该文档解释说:
在监视模式下运行编译器。观察输入文件并在更改时触发重新编译。监视文件和目录的实现可以使用环境变量进行配置。有关更多详细信息,请参阅配置手表。
要回答最初的问题,即使在没有本机支持的平台上也可以进行递归目录监视,如配置监视文档所述:
通过使用 TSC_WATCHDIRECTORY 选择的不同选项为子目录递归创建目录观察程序,支持在不支持在节点中本地查看递归目录的平台上查看目录
tsc 编译器只会监视您在命令行上传递的那些文件。它不会监视使用/// <sourcefile>
引用包含的文件。如果您使用 bash,您可以使用 find 递归查找所有*.ts
文件并编译它们:
find . -name "*.ts" | xargs tsc -w
考虑使用 grunt 来自动执行此操作,周围有很多教程,但这里有一个快速入门。
对于像这样的文件夹结构:
blah/
blah/one.ts
blah/two.ts
blah/example/
blah/example/example.ts
blah/example/package.json
blah/example/Gruntfile.js
blah/example/index.html
您可以通过以下示例文件夹轻松观看和使用 typescript:
npm install
grunt
使用 package.json:
{
"name": "PROJECT",
"version": "0.0.1",
"author": "",
"description": "",
"homepage": "",
"private": true,
"devDependencies": {
"typescript": "~0.9.5",
"connect": "~2.12.0",
"grunt-ts": "~1.6.4",
"grunt-contrib-watch": "~0.5.3",
"grunt-contrib-connect": "~0.6.0",
"grunt-open": "~0.2.3"
}
}
还有一个 grunt 文件:
module.exports = function (grunt) {
// Import dependencies
grunt.loadNpmTasks('grunt-contrib-watch');
grunt.loadNpmTasks('grunt-contrib-connect');
grunt.loadNpmTasks('grunt-open');
grunt.loadNpmTasks('grunt-ts');
grunt.initConfig({
pkg: grunt.file.readJSON('package.json'),
connect: {
server: { // <--- Run a local server on :8089
options: {
port: 8089,
base: './'
}
}
},
ts: {
lib: { // <-- compile all the files in ../ to PROJECT.js
src: ['../*.ts'],
out: 'PROJECT.js',
options: {
target: 'es3',
sourceMaps: false,
declaration: true,
removeComments: false
}
},
example: { // <--- compile all the files in . to example.js
src: ['*.ts'],
out: 'example.js',
options: {
target: 'es3',
sourceMaps: false,
declaration: false,
removeComments: false
}
}
},
watch: {
lib: { // <-- Watch for changes on the library and rebuild both
files: '../*.ts',
tasks: ['ts:lib', 'ts:example']
},
example: { // <--- Watch for change on example and rebuild
files: ['*.ts', '!*.d.ts'],
tasks: ['ts:example']
}
},
open: { // <--- Launch index.html in browser when you run grunt
dev: {
path: 'http://localhost:8089/index.html'
}
}
});
// Register the default tasks to run when you run grunt
grunt.registerTask('default', ['ts', 'connect', 'open', 'watch']);
}
tsc 0.9.1.1 似乎没有手表功能。
您可以使用像这样的 PowerShell 脚本:
#watch a directory, for changes to TypeScript files.
#
#when a file changes, then re-compile it.
$watcher = New-Object System.IO.FileSystemWatcher
$watcher.Path = "V:\src\MyProject"
$watcher.IncludeSubdirectories = $true
$watcher.EnableRaisingEvents = $true
$changed = Register-ObjectEvent $watcher "Changed" -Action {
if ($($eventArgs.FullPath).EndsWith(".ts"))
{
$command = '"c:\Program Files (x86)\Microsoft SDKs\TypeScript\tsc.exe" "$($eventArgs.FullPath)"'
write-host '>>> Recompiling file ' $($eventArgs.FullPath)
iex "& $command"
}
}
write-host 'changed.Id:' $changed.Id
#to stop the watcher, then close the PowerShell window, OR run this command:
# Unregister-Event < change Id >
今天我设计了这个 Ant MacroDef 来解决和你一样的问题:
<!--
Recursively read a source directory for TypeScript files, generate a compile list in the
format needed by the TypeScript compiler adding every parameters it take.
-->
<macrodef name="TypeScriptCompileDir">
<!-- required attribute -->
<attribute name="src" />
<!-- optional attributes -->
<attribute name="out" default="" />
<attribute name="module" default="" />
<attribute name="comments" default="" />
<attribute name="declarations" default="" />
<attribute name="nolib" default="" />
<attribute name="target" default="" />
<sequential>
<!-- local properties -->
<local name="out.arg"/>
<local name="module.arg"/>
<local name="comments.arg"/>
<local name="declarations.arg"/>
<local name="nolib.arg"/>
<local name="target.arg"/>
<local name="typescript.file.list"/>
<local name="tsc.compile.file"/>
<property name="tsc.compile.file" value="@{src}compile.list" />
<!-- Optional arguments are not written to compile file when attributes not set -->
<condition property="out.arg" value="" else='--out "@{out}"'>
<equals arg1="@{out}" arg2="" />
</condition>
<condition property="module.arg" value="" else="--module @{module}">
<equals arg1="@{module}" arg2="" />
</condition>
<condition property="comments.arg" value="" else="--comments">
<equals arg1="@{comments}" arg2="" />
</condition>
<condition property="declarations.arg" value="" else="--declarations">
<equals arg1="@{declarations}" arg2="" />
</condition>
<condition property="nolib.arg" value="" else="--nolib">
<equals arg1="@{nolib}" arg2="" />
</condition>
<!-- Could have been defaulted to ES3 but let the compiler uses its own default is quite better -->
<condition property="target.arg" value="" else="--target @{target}">
<equals arg1="@{target}" arg2="" />
</condition>
<!-- Recursively read TypeScript source directory and generate a compile list -->
<pathconvert property="typescript.file.list" dirsep="\" pathsep="${line.separator}">
<fileset dir="@{src}">
<include name="**/*.ts" />
</fileset>
<!-- In case regexp doesn't work on your computer, comment <mapper /> and uncomment <regexpmapper /> -->
<mapper type="regexp" from="^(.*)$" to='"\1"' />
<!--regexpmapper from="^(.*)$" to='"\1"' /-->
</pathconvert>
<!-- Write to the file -->
<echo message="Writing tsc command line arguments to : ${tsc.compile.file}" />
<echo file="${tsc.compile.file}" message="${typescript.file.list}${line.separator}${out.arg}${line.separator}${module.arg}${line.separator}${comments.arg}${line.separator}${declarations.arg}${line.separator}${nolib.arg}${line.separator}${target.arg}" append="false" />
<!-- Compile using the generated compile file -->
<echo message="Calling ${typescript.compiler.path} with ${tsc.compile.file}" />
<exec dir="@{src}" executable="${typescript.compiler.path}">
<arg value="@${tsc.compile.file}"/>
</exec>
<!-- Finally delete the compile file -->
<echo message="${tsc.compile.file} deleted" />
<delete file="${tsc.compile.file}" />
</sequential>
</macrodef>
在您的构建文件中使用它:
<!-- Compile a single JavaScript file in the bin dir for release -->
<TypeScriptCompileDir
src="${src-js.dir}"
out="${release-file-path}"
module="amd"
/>
它用于我当时正在使用 Webstorm 开发的 TypeScript 项目 PureMVC 。
在linux中我使用:
tsc -w $(查找 .|grep .ts)
这将监视当前目录下的每个打字稿文件。
编辑:注意,这是如果您的打字稿源中有多个 tsconfig.json 文件。对于我的项目,我们将每个 tsconfig.json 文件编译为不同名称的 .js 文件。这使得观看每个打字稿文件变得非常容易。
我写了一个甜蜜的 bash 脚本,它找到你所有的 tsconfig.json 文件并在后台运行它们,然后如果你 CTRL+C 终端,它将关闭所有正在运行的 typescript watch 命令。
这在 MacOS 上进行了测试,但应该可以在任何支持 BASH 3.2.57 的地方工作。未来的版本可能会改变一些东西,所以要小心!
#!/bin/bash
# run "chmod +x typescript-search-and-compile.sh" in the directory of this file to ENABLE execution of this script
# then in terminal run "path/to/this/file/typescript-search-and-compile.sh" to execute this script
# (or "./typescript-search-and-compile.sh" if your terminal is in the folder the script is in)
# !!! CHANGE ME !!!
# location of your scripts root folder
# make sure that you do not add a trailing "/" at the end!!
# also, no spaces! If you have a space in the filepath, then
# you have to follow this link: https://stackoverflow.com/a/16703720/9800782
sr=~/path/to/scripts/root/folder
# !!! CHANGE ME !!!
# find all typescript config files
scripts=$(find $sr -name "tsconfig.json")
for s in $scripts
do
# strip off the word "tsconfig.json"
cd ${s%/*} # */ # this function gets incorrectly parsed by style linters on web
# run the typescript watch in the background
tsc -w &
# get the pid of the last executed background function
pids+=$!
# save it to an array
pids+=" "
done
# end all processes we spawned when you close this process
wait $pids
有用的资源:
- bash:将字符串变量解释为文件名/路径
- 不记住在 while 循环内修改的变量
- https://www.cyberciti.biz/faq/search-for-files-in-bash/
- https://opensource.com/article/18/5/you-dont-know-bash-intro-bash-arrays
- https://linuxize.com/post/bash-concatenate-strings/
- https://www.cyberciti.biz/faq/bash-for-loop/
- https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
- https://unix.stackexchange.com/questions/144298/delete-the-last-character-of-a-string-using-string-manipulation-in-shell-script
- 什么是特殊的美元符号 shell 变量?