https://github.com/trustmaster/noflo-api-updater

A tool to update legacy NoFlo code with the latest APIs
https://github.com/trustmaster/noflo-api-updater

Last synced: 23 days ago
JSON representation

A tool to update legacy NoFlo code with the latest APIs

• Host: GitHub
• URL: https://github.com/trustmaster/noflo-api-updater
• Owner: trustmaster
• Created: 2014-06-03T18:06:36.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-09-17T17:31:41.000Z (over 7 years ago)
• Last Synced: 2024-10-15T21:29:43.575Z (2 months ago)
• Language: CoffeeScript
• Size: 11.7 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# NoFlo API Updater

This command-line tool automates some tasks on updating legacy NoFlo libraries with the latest APIs.

## Features

Currently this tool supports:

 - Semi-automatic update of the old CoffeeScript components to the new Ports API introduced in NoFlo 0.5.

## Installation

If you don't have CoffeeScript installed, then first install the latest CoffeeScript:

```

# npm install -g coffee-script

```

Then install the updater tool

```

# npm install -g noflo-api-updater

```

## Usage

_Note: the tool assumes that components are written in CoffeeScript indented correctly with 2 spaces. Tab or 4-space indentation, or JavaScript components are not supported at this time._

Updating a single `*.coffee` file:

```

$ noflo-api-updater components/MyComponent.coffee

```

Updating all components in the folder:

```

$ noflo-api-updater components

```

There is a `--pretend` option that prints the result on screen rather than overwriting original files:

```

$ noflo-api-updater --pretend components/MyComponent.coffee

```

## Disclaimer

This tool comes with absolutely NO WARRANTY and it is not designed to result into 100% bugproof working code. Use it to aid your manual code refactoring and don't forget to backup / git commit before running this tool.