Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vbauer/lein-typescript
A Leiningen plugin for running TypeScript compiler
https://github.com/vbauer/lein-typescript
clj clojure javascript js lein leiningen typescript typescript-compiler
Last synced: 4 months ago
JSON representation
A Leiningen plugin for running TypeScript compiler
- Host: GitHub
- URL: https://github.com/vbauer/lein-typescript
- Owner: vbauer
- License: epl-1.0
- Created: 2015-03-25T19:04:38.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-11-14T06:18:23.000Z (about 6 years ago)
- Last Synced: 2024-09-28T17:40:53.431Z (5 months ago)
- Topics: clj, clojure, javascript, js, lein, leiningen, typescript, typescript-compiler
- Language: Clojure
- Size: 30.3 KB
- Stars: 7
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
lein-typescript
=================
[](https://travis-ci.org/vbauer/lein-typescript)
[](https://clojars.org/lein-typescript)
> **TypeScript** is a free and open source programming language developed and maintained by Microsoft. It is a strict superset of JavaScript, and adds optional static typing and class-based object-oriented programming to the language. - [Wikipedia](https://en.wikipedia.org/wiki/TypeScript)
[lein-typescript](https://github.com/vbauer/lein-typescript) is a Leiningen plugin that allows to use TypeScript compiler.
Pre-requirements
================
Install [NodeJS](http://nodejs.org/) and [NPM](https://github.com/npm/npm) (package manager for Node) to install TypeScript:
* On Ubuntu: `sudo apt-get install nodejs`
* On Mac OS X: `brew install node`
Installation
============
Install [TypeScript](https://www.npmjs.org/package/typescript) to use lein-typescript plugin. It could be done in few ways:
* Use NPM to install TypeScript globally: `npm install typescript -g`
* You can also install TypeScript in the current directory: `npm install typescript`
* Use [lein-npm](https://github.com/bodil/lein-npm) plugin: `lein npm install`
* Use just Leiningen: `lein deps`
To enable lein-typescript for your project, put the following in the :plugins vector of your project.clj file:
```clojure
; Use latest version instead of "X.X.X"
:plugins [[lein-typescript "X.X.X"]]
```
Configuration
=============
To configure lein-typescript, put the :typescript parameter in the file project.clj. It could be a single configuration (simple map) or a collection of configurations (for multiple configuration).
```clojure
:typescript {
:sources ["*.ts" "resources/*.ts"]
:excludes ["bad.ts"]
:out "app.js"
:declaration true
:remove-comments true
:target :es5
}
```
Configuration parameters
------------------------
- :sources
- List of input TypeScript sources. It is possible to use a single source or a vector of sources. To configure this parameter, you could also use a Glob Patterns.
- :excludes
- List of glob patterns to prevent processing of some files. It is also possible to use both variants: single pattern and collection of patterns.
- :out-dir
- Redirect output structure to the specified directory (it is undefined by default). ":out" parameter will be used in priority.
- :out
- Concatenate and emit output to single file which you can specify using this parameter (it is undefined by default).
- :remove-comments
- Do not emit comments to output (default value is "false").
- :declaration
- Generates corresponding ".d.ts" file (default value is "false").
- :source-map
- Generates corresponding '.map' file (default is "false").
- :module
- Specify module code generation: :commonjs or :amd (it is undefined by default).
- :target
- Specify ECMAScript target version: :es3 (default), :es5, or :es6 (experimental).
- :watch
- Watch input files. It could be helpful to use this parameter with lein-pdo and/or with separate profile (default is "false").
Hooks
-----
To enable this plugin in the compile stage, use the following hook:
```clojure
:hooks [lein-typescript.plugin]
```
Usage
=====
To compile TypeScript files using configuration from project.clj, you should use: `lein typescript`.
It is also possible to use short alias for `typescript` task: `lein ts`.
To show help: `lein help typescript`
Example project
===============
Just clone the current repository and try to play with [example project](https://github.com/vbauer/lein-typescript/tree/master/example) for better understanding how to use lein-typescript.
Thanks to
=========
[Microsoft Corporation](http://www.microsoft.com), [Anders Hejlsberg](https://github.com/ahejlsberg) and [TypeScript community](https://github.com/Microsoft/TypeScript) for the great programming language.
Might also like
===============
* [lein-coffeescript](https://github.com/vbauer/lein-coffeescript) - a Leiningen plugin for running CoffeeScript compiler.
* [lein-jslint](https://github.com/vbauer/lein-jslint) - a Leiningen plugin for running javascript code through JSLint.
* [lein-jshint](https://github.com/vbauer/lein-jshint) - a Leiningen plugin for running javascript code through JSHint.
* [lein-plantuml](https://github.com/vbauer/lein-plantuml) - a Leiningen plugin for generating UML diagrams using PlantUML.
* [lein-asciidoctor](https://github.com/asciidoctor/asciidoctor-lein-plugin) - A Leiningen plugin for generating documentation using Asciidoctor.
* [jabberjay](https://github.com/vbauer/jabberjay) - a simple framework for creating Jabber bots.
* [coderwall-clj](https://github.com/vbauer/coderwall-clj) - a tiny CoderWall client for Clojure.
License
=======
Copyright © 2015 Vladislav Bauer
Distributed under the Eclipse Public License, the same as Clojure.