typescript-monkey 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 427a6a30bc837fb2b3600d1f6540bcdffd3573b4
+  data.tar.gz: ede7bb0989b12ff88229f928d3a088bc028089a0
+SHA512:
+  metadata.gz: d93b9f102f8b58147d15dc905bf62cbefd588661b4a73a0d35d6439a1e7737f0c5536807f98edab0ba02ce9f5d0d3b7ce3fe9c34b5c76763f31fe5eebfd73b66
+  data.tar.gz: e17b79826473486f468a140d4448d0d47423efdc19b24cc34219c64868f1643e63a92659349b63ce3eae28d027a22f9f492e2d460e4f1716c3d0940a307d1c21

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.editorconfig

@@ -0,0 +1,27 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+
+[*.{js,json}]
+indent_size = 2
+
+[*.{ts}]
+indent_size = 4
+
+[*.{rb,rake}]
+indent_size = 2
+
+[*.html]
+indent_size = 2
+
+[*.{css,scss}]
+indent_size = 2
+
+[{Gemfile}]
+indent_size = 2
+
+[*.yml]
+indent_size = 2

data/.gitignore

@@ -0,0 +1,52 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore secret environment configs
+.env
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+/test/tmp
+
+# Ignore some ruby files
+.rvmrc
+Gemfile.lock
+
+# Ignore yardoc object cache and generated docs
+.yardopts
+.yardoc
+
+# Ignore ydoc output files
+doc/yard
+
+# Ignore rdoc output files
+doc/rdoc_converted
+doc/rdoc
+
+# Ignore generated gem files
+/*.gem
+
+# Ignore generated assets
+/lib/assets/javascripts/dyrt*.js
+/lib/assets/javascripts/transpile*.js
+
+# Ignore coveralls output
+/coverage
+
+# Ignore local node packages
+/node_modules
+
+# Ignore other unneeded files
+database.yml
+*.swp
+*~
+.project
+.DS_Store
+.byebug_history

data/.ruby-gemset

@@ -0,0 +1 @@
+typescript-monkey

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/.travis.yml

@@ -0,0 +1,27 @@
+language: ruby
+
+before_install:
+  - "npm install"
+  - "gem update --system 2.6.12"
+  - "gem update bundler"
+
+script:
+  - bundle exec rake test
+
+rvm:
+  - 2.0.0
+  - 2.3.4
+  - 2.4.1
+  - ruby-head
+
+sudo: false
+
+cache: bundler
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+
+notifications:
+  email: false

data/.vscode/tasks.json

@@ -0,0 +1,40 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "0.1.0",
+  "command": "node_modules/.bin/gulp",
+  "isShellCommand": true,
+  "args": ["--no-color"],
+  "tasks": [
+    {
+      "taskName": "all",
+      "isBuildCommand": true,
+      "showOutput": "always"
+    },
+    {
+      "taskName": "transpile",
+      "isBuildCommand": true,
+      "showOutput": "always"
+    },
+    {
+      "taskName": "transpile-min",
+      "isBuildCommand": true,
+      "showOutput": "always"
+    },
+    {
+      "taskName": "transpile-once",
+      "isBuildCommand": true,
+      "showOutput": "always"
+    },
+    {
+      "taskName": "transpile-once-min",
+      "isBuildCommand": true,
+      "showOutput": "always"
+    },
+    {
+      "taskName": "watch",
+      "isBuildCommand": true,
+      "showOutput": "always"
+    }
+  ]
+}

data/CHANGES.md

@@ -0,0 +1,48 @@
+## v0.6.2.4 2016-09-12 13:48:00+0300
+
+* Add typescript template generator (not defaulted). Thanks to @mjfaga
+
+## v0.6.2.3 2016-07-27 17:25:00+0300
+
+* Fixed incorrect value of register_mime_type (@mihai-dinculescu)
+
+## v0.6.2.1 2016-07-26 18:27:00+0300
+
+* Added Sprockets 4 support. Thanks to @mihai-dinculescu
+
+## v0.6.2 2015-07-27 21:52:50+0300
+
+* Updated to TS v1.6.2
+
+## v0.6.1 2015-07-27 21:52:50+0300
+
+* Now code raises exception with correct file name when TS compilation error occurs
+
+## v0.6.0 2015-07-06 22:36:25+0300
+
+* Updated version to 0.6.0 for using Typescript source 1.4.1.3
+
+## v0.5.0 2015-03-25 10:46:29+0900
+
+* Expire root TS cache in response to change in referenced `.ts` files (#24)
+
+## v0.4.2 2014-11-26 07:30:12+0900
+
+* Fix newlines (#15)
+* Mention to `default_options` in README (#18)
+
+## v0.4.1 2014-08-12 00:05:17+0900
+
+* Fix a runtime error
+
+## v0.4.0 2014-08-11 23:04:20+0900
+
+* Set `--noImplicitAny` by default to tsc compiler
+* Typescript::Rails::Compiler.default_options to provide tsc compiler with otpions
+    * default values: `--target ES5 --noImplicitAny`
+* A lot of refactoring
+
+## v0.3.0 2014-08-09 10:27:54+0900
+
+* Compiles TypeScript files in ES5 mode
+

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in typescript-monkey.gemspec
+gemspec
+
+group :test do
+  gem 'rails', '~> 4.0'
+  gem 'sprockets-rails', '> 2.0'
+  gem 'minitest-power_assert'
+  gem 'coveralls'
+  gem 'simplecov'
+  gem 'thor', '0.19.1'
+  gem 'tzinfo-data', platforms: [:mingw, :mswin]
+  gem "byebug", '~> 9.0.6'
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (C) 2017 Mark Eissler. All rights reserved.
+Portions Copyright (C) 2012-2016 Klaus Zanders et al.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,351 @@
+# TypeScript Monkey [![Build Status](https://api.travis-ci.org/markeissler/typescript-monkey.svg?branch=feature/typescript-monkey)](https://travis-ci.org/markeissler/typescript-monkey) [![Coverage Status](https://coveralls.io/repos/github/markeissler/typescript-monkey/badge.svg?branch=feature%2Ftypescript-monkey)](https://coveralls.io/github/markeissler/typescript-monkey?branch=feature%2Ftypescript-monkey)
+
+This is a TypeScript transpiler engine for the Rails asset pipeline.
+
+>BETA: TypeScript Monkey is currently in pre-release. That doesn't mean it's not ready for production, it just means it
+hasn't been tested by a large audience yet. The more the merrier and the faster we get to v1.0. Install it, open issues
+if you find bugs.
+
+## Overview
+
+TypeScript Monkey let's you use TypeScript (files with a `.ts` extension) wherever you can use JavaScript (`.js`) files.
+This includes support for pre-processing other template formats. For instance, you can also create `.ts.erb` files. In
+essence, TypeScript is a first class citizen on Rails!
+
+For more information on TypeScript visit the [TypeScript](http://www.typescriptlang.org/) homepage.
+
+## Requirements
+
+### Node.js
+
+One of the goals of __TypeScript Monkey__ is to reduce the dependence on third-party gems which aren't under active
+development. This gem does require that [Node.js](https://nodejs.org/) has been installed either globally or locally. Specifically,
+TypeScript support (language and compiler) is provided by the TypeScript package for Node. <u>If installed locally,
+it is not recommended that you commit your `node_modules` directory to source control.</u>
+
+If you're not familiar with Node.js don't worry, it's not that scary.
+
+To install Node.js support, our recommendation is to use an appropriate package manager:
+
+[Installing Node.js via package manager](https://nodejs.org/en/download/package-manager/)
+
+#### Recommended package managers
+
+For MacOS, our recommendation is [Homebrew](https://brew.sh/); for Windows your best bet is probably [Chocolatey](http://chocolatey.org/).
+Go and install a package manager first, then install node, then come back here. If you're on Linux, well, the assumption
+is that you probably know what you're doing already!
+
+>NOTE: Another obvious choice for Windows is [NuGet](https://www.nuget.org/) but it appears that the Node package there is stale.
+
+## Installation
+
+### Adding a Node Package Definition (package.json) File
+
+The first step is to create a Node.js `package.json` file at the root of your Rails project. You may have created this
+file already for other uses, if so, then you will need to merge in the following dependencies:
+
+```json
+  "dependencies": {
+    "@types/jquery": "^2.0.41",
+    "@types/node": "^7.0.14",
+    "typescript": "^2.3.1"
+  }
+```
+
+If you don't have an existing `package.json` you can use the `example_package.json` file in the [contrib](./contrib/)
+directory as a starting point. Copy the file to the `root` of your Rails project. __Be sure to rename the file as simply
+"package.json".__
+
+The second step is to install some TypeScript dependencies with the Node.js package manager (`npm`):
+
+```sh
+    >npm install
+```
+
+The package manager will determine and install the dependencies noted above by reading the `package.json` file.
+
+### Adding the Gem to your Rails Project's Gemfile
+
+Update your Gemfile to include the following statement:
+
+```ruby
+# typescript support in the asset pipeline!
+gem 'typescript-monkey', '~> 0.9.0'
+```
+
+Then run bundler:
+
+```sh
+    >bundle install
+```
+
+Finally, restart your Rails server to load the __Typescript Monkey__ gem.
+
+## Usage
+
+### TypeScript Triple-Slash Directives
+
+__Typescript Monkey__ parses Typescript files and examines __Triple-Slash__ directives (also known as __reference__ tags
+or comments). For each directive, a Sprockets dependency relationship will be created so that a change in a dependency
+will trigger Sprockets to re-process the dependent file as well.
+
+>NOTE: __TypeScript Monkey__ does not currently support _import_ directives. See [Features Not Yet Implemented (but on the way)](#pending-features)
+for more information.
+
+Learn more about __Triple-Slash__ directives by referring to the following secction of the __Typescript Spec__:
+
+[Source Files Dependencies](https://github.com/teppeis/typescript-spec-md/blob/master/en/ch11.md#1111-source-files-dependencies)
+
+### In the Asset Pipeline (Sprockets)
+
+Typical usage is the same as with JavaScript. That is, you will need to add your TypeScript files to `.js` manifest
+files just like you would with JavaScript. For instance, in the below example let's pretend that you have created the
+following:
+
+```sh
+app/assets/javascripts/
+├── application.js
+├── my-typescript-files
+    └── superduper.ts
+```
+
+#### File example: superduper.ts
+
+```ts
+class SuperDuper {
+    public message(message: string): void {
+        const body: HTMLBodyElement = document.getElementsByTagName("body")[0];
+        const element = document.createElement("p");
+        element.innerHTML = `${message}`;
+        body.appendChild(element);
+    }
+}
+
+$(() => {
+    const superduper = new SuperDuper();
+    superduper.message("TypeScript at work.");
+});
+```
+
+Then, your `application.js` file might look like this:
+
+#### File example: application.js
+
+```js
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require jquery-ui/core
+//= require bootstrap-sprockets
+//= require my-typescript-files/superduper
+
+```
+
+### Embedded in \<script\> tags
+
+Yes, you can embeded TypeScript in your templates just like JavaScript! All that's required is __TypeScript Monkey__
+DYnamic Runtime Transpiler (aka __"dyrt"__). For example, let's say you had the following snippet in your template:
+
+```erb
+    <script type="text/typescript">
+        class Alert {
+            public alert(message: string): void {
+                alert(`An important message: ${message}`);
+                return;
+            }
+        }
+        let myAlert = new Alert();
+        myAlert.alert("TypeScript is awesome!");
+    </script>
+```
+
+The key is making sure your `<script>` tag type is set appropriately as above.
+
+To transpile this script at runtime you will have to make __dyrt__ available at runtime. You will also need to make the
+TypeScript library avaialable at runtime. Both of these dependencies can be resolved by adding the following to the end
+of your `<body>` section:
+
+```erb
+    <%= javascript_include_tag 'transpiler_pkg' %>
+```
+
+After the page loads, __dyrt__ will parse all `<script>` tags, transpile the TypeScript objects and then append them
+to the end of the page.
+
+#### Loading the transpiler with other scripts
+
+Yes, you could (theoretically) load the __Typescript Monkey__ transpiler along with you other script assets. If you
+were to do that, you would then have to make the following call to trigger transpilation after DOM load:
+
+```js
+$(function() {
+    var transpiler = new TypeScript::Monkey::Transpiler();
+    transpiler.transpile();
+);
+```
+
+The `transpile()` method will parse the page, remove all previous transpiled scripts, transpile each TypeScript object
+and then append these scripts to the end of the page.
+
+Pretty neat right? __BUT__ it's important to state that using __TypeScript Monkey__ this way may not offer the best
+peformance. Also, you're inline scripts will not benefit from compression or minification. (The `transpiler_pkg` will,
+however, be minified by Sprockets as usual).
+
+### Updating Files and Clearing the Sprockets Cache
+
+You've updated some of your TypeScript files and for some reason the changes aren't appearing. Hate it when that
+happens, right? Do this:
+
+```sh
+    >rake tmp:clear
+```
+
+Then re-load your website. Sprockets will re-compile all of your TypeScript assets.
+
+## Configuration
+
+### App-level Configuration
+
+The common application level configuration options that affect the __TypeScript Monkey__ gem are:
+
+```txt
+    #
+    # Rails options...
+    #
+    config.app_generators.javascript_engine :typescript
+    #
+    # Sprockets options...
+    #
+    config.assets.enabled = true
+    config.assets.js_compressor = :uglifier
+    # set to "true" to disable Sprockets concatenation
+    config.assets.debug = false
+    # set to "true" to generate digests
+    config.assets.digest = true
+```
+
+Since the above configuration options appear at the "app" level, changing these settings can affect gems in addition to
+the __Typescript Monkey__ gem.
+
+#### Setting Typescript as the Default Javascript Engine
+
+If you plan on using TypeScript in your project exclusively (instead of plain `.js` or `.coffee` files), then you might
+want to configure rails so that generators produce TypeScript template files by default. Add the following lines to
+your `config/application.rb` file.
+
+```ruby
+module MyRailsApp
+  class Application < Rails::Application
+    ...
+    # enable typescript in the asset pipeline
+    config.app_generators.javascript_engine :typescript
+    # enable the asset pipeline (!! Make sure assets are enabled !!)
+    config.assets.enabled = true
+    ...
+  end
+end
+```
+
+Alternatively, you can specify the JavaScript engine as a parameter to the rails generator command line:
+
+```sh
+    >rails generate controller MyController --javascript_engine=typescript
+```
+
+### Gem-level Configuration
+
+The __TypeScript Monkey__ gem offers some level of configuration. These settings should be configured from within an
+appropriate initializer. An `example_typescript.rb` initialization file can be found in the [contrib](./contrib/)
+directory. Copy the file to the `app/config/initializers` directory of your Rails project. __Be sure to rename the file
+as simply "typescript.rb".__
+
+<a name="typescript-concatenation"></a>
+
+#### Setting Traditional TypeScript Concatenation
+
+During TypeScript transpilation (conversion of TypeScript to JavaScript), the TypeScript compiler will resolve
+triple-slash directives (dependencies) and as a result transpile and concatenate the dependencies to each file as
+needed. The upside is that each indivual file will contain its dependencies; the downside is that this usually results
+in code duplication in a Rails environment.
+
+__Typescript Monkey__ procedes with transpilation under the notion that all dependencies will be met at runtime. That
+should be the case if you have setup your manifest files correctly (either the single `application.js` manifest file or
+your own additional manifest files).
+
+Still, if you have a reason to revert back to TypeScript's concatenation scheme then you can do so by enabling the
+following __Typescript Monkey__ configuration in an initializer:
+
+```ruby
+Typescript::Monkey.configure do |config|
+  # Configure Typescript::Monkey concatenated compilation
+  config.compile = true
+end
+```
+
+### Configuring a Logger
+
+Adding a logger config is really only useful for debugging. Don't configure logging unless you fully understand the
+paragraph that follows the configuraiton snippet:
+
+```ruby
+Typescript::Monkey.configure do |config|
+  # Configure Typescript::Monkey logging (for debugging your app build)
+  config.logger = Rails.logger
+end
+```
+
+In general, you will see a lot of dependency "errors" generated by the logger. These "errors" (again, in quotes) are
+passed through from the TypeScript compiler which doesn't understand that we're building a web site and that all of the
+"missing" (also, in quotes) dependencies will be resolved at runtime!
+
+<a name="pending-features"></a>
+
+## Features Not Yet Implemented (but on the way)
+
+This is a short-list of planned features:
+
+1. Support for specifying compiler options from initializer.
+2. Support for reading compiler options from `tsconfig.json`.
+3. Support for "import" syntax.
+4. Features I forgot to write down and can't think of right now...
+
+## 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
+
+## Authors
+
+__TypeScript Monkey__ is the work of __Mark Eissler__ based on the original work of others as noted in the
+[Attributions](#attributions) section below.
+
+<a name=attributions></a>
+
+## Attributions
+
+__TypeScript Monkey__ is a fork of [typescript-rails](https://github.com/typescript-ruby/typescript-rails). A lot of
+work has gone into producing __Typescript Monkey__ which offers better support for Sprockets and the way that Rails
+works with assets to provide a more native and familiar experience. Still, without the prior work of __Klaus Zanders__
+([klaus.zanders@gmail.com](klaus.zanders@gmail.com)) and __FUJI Goro__ ([gfuji@cpan.org](gfuji@cpan.org)) and also the
+[coffee-rails](https://github.com/rails/coffee-rails) project, this gem would probably not exist.
+
+## License
+
+__Typescript Monkey__ is licensed under the MIT open source license.
+
+---
+Without open source, there would be no Internet as we know it today.