Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/typescript-ruby/typescript-rails
An asset pipeline wrapper for the TypeScript language
https://github.com/typescript-ruby/typescript-rails
Last synced: 3 months ago
JSON representation
An asset pipeline wrapper for the TypeScript language
- Host: GitHub
- URL: https://github.com/typescript-ruby/typescript-rails
- Owner: typescript-ruby
- License: mit
- Created: 2012-10-03T09:23:18.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2016-11-13T09:53:20.000Z (about 8 years ago)
- Last Synced: 2024-07-24T18:22:13.271Z (4 months ago)
- Language: Ruby
- Homepage:
- Size: 76.2 KB
- Stars: 255
- Watchers: 7
- Forks: 30
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE.txt
Awesome Lists containing this project
- es6-tools - typescript-rails
README
# TypeScript for Rails [](https://travis-ci.org/typescript-ruby/typescript-rails) [](https://coveralls.io/r/typescript-ruby/typescript-rails)
This is a wrapper for the [TypeScript](http://www.typescriptlang.org/), JavaScript superset language by Microsoft.
It enables you to use the `.ts` extension in the Asset Pipeline and also in ActionView Templates.
This gem uses the
[typescript-node-ruby](https://github.com/typescript-ruby/typescript-node-ruby)
library by KAWACHI Takashi for the typescript parsing with node js.
The credit for the overall structure and the tests goes to the people that wrote the [coffee-rails](https://github.com/rails/coffee-rails) Gem, since I shamelessly copy&pasted some of their code.
## Requirements
The current version requires that [node.js](http://nodejs.org/) is
installed on the system.
The requirement for node is tested upon starting the application. If
the node command is not available you get the following error message:
```
typescript-node requires node command, but it's not found. Please install it. Set TS_NODE environmental variable If you want to use node command in non-standard path.
```
## Installation
Add this line to your application's Gemfile:
gem 'typescript-rails'
And then execute:
$ bundle
Note: We need to install (if we haven't already) the Typescript definitions, [more info](https://github.com/DefinitelyTyped/DefinitelyTyped#how-do-i-get-them).
npm install --save-dev @types/node
## Usage
Just add a `.js.ts` file in your `app/assets/javascripts` directory and include it just like you are used to do.
Configurations:
```
Typescript::Rails::Compiler.default_options = %w(--target ES5 --noImplicitAny --module commonjs)
```
Default Configurations:
```
Typescript::Rails::Compiler.default_options = %w(--target ES5 --noImplicitAny)
```
## Default Javascript Compilation
Add this line to your `config/application.rb` as show below, above the `config.assets.enabled = true`:
```ruby
config.app_generators.javascript_engine :typescript
# Enable the asset pipeline
config.assets.enabled = true
```
If you don't want it to be the default javascript engine, you can also use it adhoc as show below:
```ruby
rails g controller MyController --javascript_engine=typescript
```
## Referenced TypeScript dependencies
`typescript-rails` recurses through all [TypeScript-style](https://github.com/teppeis/typescript-spec-md/blob/master/en/ch11.md#1111-source-files-dependencies) referenced files and tells its [`Sprockets::Context`](https://github.com/sstephenson/sprockets/blob/master/lib/sprockets/context.rb) that the TS file being processed [`depend`s`_on`](https://github.com/sstephenson/sprockets#the-depend_on-directive) each file listed as a reference. This activates Sprocket’s cache-invalidation behavior when any of the descendant references of the root TS file is changed.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## Maintainers
FUJI Goro
## Authors
Klaus Zanders