fib-typify

fib-typify

just write fibjs with typescript : )

Introduction

fib-typify allows you write fibjs with typescript in compilation or in runtime. It depends on original typescript stable version. As typescript is written with nodejs, it's not restricted in nodejs runtime: you can also compile typescript in browser or ANY other pure Javascript runtime. That is, you can use it in fibjs also.

renderer

fib-typify's core is jstransformer-typescript (which is one jstransformer aimed to typescript) like, but this core is only valid in fibjs rather than pure javascript

Usage

APIs

NOTE All TSCompilerOptions is just typescript's compilerOptions

---

compileRaw: (tsRaw: string, tsCompilerOptions: TSCompilerOptions) => string

compile tsRaw to javascript.

compileRawToFile: (tsRaw: string, targetpath: string, tsCompilerOptions: TSCompilerOptions) => void

compile tsRaw to javascript, then write to targetpath

compileRawToSandbox: (tsRaw: string, sboxOpts: any, tsCompilerOptions: TSCompilerOptions) => any

compile tsRaw to javascript, then read it as sandbox

compileFile: (filepath?: string, tsCompilerOptions: TSCompilerOptions) => string

compile content in filepath to javascript.

compileFileTo: (srcpath?: string, targetpath: string, tsCompilerOptions: TSCompilerOptions) => void

compile content in filepath to javascript, then write to targetpath

compileRawToFile: (filepath?: string, tsCompilerOptions: TSCompilerOptions) => string

compile content in filepath to javascript, then read it as sandbox

compileDirectoryTo: (baseDir: string, distDir: string, compileDirToOpts: any) => void

Param	Type	Required/Default
baseDir	string	Y / -
distDir	string	Y / -
compileDirToOpts	compileDirToOpts	N / -

compile files in directory baseDir recursively to distDir, view options in view compileDirToOpts

---

compileDirToOpts

Field	Type	Required/Default	Explanation
compilerOptions	boolean	Y / false	typescript's compilerOptions
fileglobsToCopy	Array, '*'	N / ['*.js', '*.jsc', '*.json']	whitelist for extensions of globnames to copy when recursive walk to one
includeLeveledGlobs	string	string[]	N / ['*', '!node_modules', '!.ts']
filterFileName	(filename: string): boolean	N / -	whether compile File, file would be compiled if returning true

notice compileDirToOpts.extsToCopy is depreacated, if you pass it,compileDirToOpts.fileglobsToCopy get invalid.

File Filter Priority

High -> Low:

1. includeLeveledGlobs
2. fileglobsToCopy
3. filterFileName

File Writing Priority

1. [compileResult]
2. fileglobsToCopy

TODO

• There is no official *.d.ts for fibjs yet. I will support generating fibjs.d.ts when compilation. ---> Just use fib-types
• better options for compileDirectoryTo
  • hooks before, when, after compiling
  • on walk to one file recursively
  • customizable recursive
  • support fileglobsToCopy with higher priorty than extsToCopy
• compile '.ts' to '.jsc' directly
• pack compiled '.jsc' to binary and extract one zipped file.

Contributions

If you wanna contribute to this package, just learn about fibjs first, then fork this repo :)