https://github.com/Hacker0x01/coffee-to-es2015-codemod

A set of JSCodeshift transforms that will help you transform your CoffeeScript codebase to ES2015
https://github.com/Hacker0x01/coffee-to-es2015-codemod

Last synced: about 1 month ago
JSON representation

A set of JSCodeshift transforms that will help you transform your CoffeeScript codebase to ES2015

• Host: GitHub
• URL: https://github.com/Hacker0x01/coffee-to-es2015-codemod
• Owner: Hacker0x01
• License: mit
• Created: 2015-12-16T15:38:04.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-03-04T14:13:44.000Z (almost 9 years ago)
• Last Synced: 2024-08-02T07:14:10.606Z (4 months ago)
• Language: JavaScript
• Size: 42 KB
• Stars: 36
• Watchers: 28
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-codemods - coffee-to-es2015-codemod - A set of JSCodeshift transforms that will help you transform your CoffeeScript codebase to ES2015. (JavaScript)
• awesome-jscodeshift - coffee-to-es2015-codemod - A set of JSCodeshift transforms that will help you transform your CoffeeScript codebase to ES2015 (Table of Contents / Codemods)

README

        
## coffee-to-es2015-codemod

[![Build Status](https://travis-ci.org/Hacker0x01/coffee-to-es2015-codemod.svg?branch=master)](https://travis-ci.org/Hacker0x01/coffee-to-es2015-codemod)

This repository contains a collection of codemod scripts that should help you convert your CoffeeScript codebase to ES2015.

This project requires [JSCodeshift](https://github.com/facebook/jscodeshift) to perform the transforms.

### Setup & run

  * `npm install -g jscodeshift`

  * `git clone https://github.com/Hacker0x01/coffee-to-es2015-codemod`

  * `jscodeshift -t  `

  * Use the `-d` option for a dry-run and use `-p` to print the output for comparison

### Motivation

Because of the nature of the transforms (reverse engineering CoffeeScript patterns from the ES5 output), I don't think that it would ever be wise to run all transforms at once without reviewing. There's simply too much assumptions in the transforms that can go wrong for other codebases. Because of this I decided to split off this repository from the [espresso](https://github.com/HipsterBrown/espresso) repository, and try very carefully to document all the specific assumptions. In the hope that these transforms can help other people as well.

### Proposed steps to convert your CoffeeScript codebase

At HackerOne we decided to convert our codebase through the following steps:

1. Convert all CoffeeScript to ES5 by running the CoffeeScript compiler

2. Replace the CoffeeScript with the ES5 output

3. Run the first transform (TODO: define preferred order of transforms)

4. Create a PR/diff for the code change

5. After the change has been accepted go back to step 3 and start the next transformation

I know that it probably goes against the nature of a lot of people to review these changes (as they tend to get very big), but it's the only way I trust to make sure nothing gets lost. Once we completed the process @Hacker0x01 I will make sure to document how everything went, and what we've learned, but until then I suggest that everybody takes precaution in using these transforms.

### Thanks

A big thanks to @HipsterBrown for setting up [espresso](https://github.com/HipsterBrown/espresso) and writing the first set of transforms.

Another big thanks to @fkling for setting up JSCodeshift and to @cpojer for his [awesome JSConf.EU talk](https://www.youtube.com/watch?v=d0pOgY8__JM).