Shift.js

Shift.JS is an open source Swift to JavaScript transpiler written in JavaScript. Full documentation can be found at [shiftjs.com] (https://www.shiftjs.com).

Usage

Requires Node 4.0.0 & up.

The command line tool can be installed via npm:

npm install --g TODO: NEED NPM MODULE

To transpile a single Swift file into a JavaScript file:

swiftjs someSwiftFile.swift

To watch a files for changes, running the selected command when a file is updated:

shiftjs -w someSwiftFile.swift

For a full list of commands:

shiftjs -h

Develpoment

The project is in active early development. It currently provides language support for most Swift data & collection types, mathematical & logical operators, control flow, and functions.

Getting Started

Clone down the repo:

https://github.com/shift-js/shift-js.git

Install the required dependencies:

https://github.com/shift-js/shift-js.git

Code Overview

/transpiler contains the two main components of the transpiler:

• Lexer: Generates a stream of tokens representing the lexical parts of the Swift input. The lexer uses a state object to store the token stream and other relevant information related to the Swift input. It is organized into three main files:

  • lexer.js iterates over the Swift code, separating it into individual parts to be evaluated based on their precedence in Swift.
  • lexerFunctions.js contains helper functions to handle particular lexical parts of Swift.
  • lexicalTypes.js contains the valid lexical tokens of Swift, such as keywords, operators, and punctuation.

• Parser

  • the AST is generated into JavaScript using Escodegen

Note about the CLI

Testing

The nature of this project requires extensive tests, which are located in /tests

To run the test suite:

grunt test

The test suite contains unit tests for each of the main parts of the transpiler.

• lexerTests/ : tests to ensure that the lexer is generating the correct token stream

• parserTests/ : tests to ensure that the parser is generating the correct AST based on the token stream

• generatorTests/ : tests to ensure that Escodgen is generating the correct JavaScript based on the AST

• endToEnd/ : tests to ensure that the transpiler as a whole is generating the correct JavaScript based on the Swift input

To run any of these particular tests, rather then the entire test suite, use one of the following:

grunt testLexer

grunt testParser

grunt testGenerator

grunt testEndToEnd

Each Swift language feature should have corresponding lexer, parser, generator, and end to end tests.

Contributing

1. [Check for open issues] (https://github.com/shift-js/shift-js/issues>) or open a fresh issue to start a discussion around a feature idea or a bug.

2. [Fork the shift-js repository on Github] (https://github.com/shift-js/shift-js/issues#fork-destination-box) to start making your changes. Cut a namespaced feature branch from develop that is named appropriately for the feature you plan to work on.

3. Tests are very important for this project. Write tests that show the bug was fixed or that the feature works as expected.

4. Send a pull request. Make sure to add yourself to CONTRIBUTORS.txt.

Please refer to CONTRIBUTING.md and STYLEGUIDE.md in docs/ for detailed contributing guidelines.

License

MIT

See the LICENSE file in docs/

Team

Shift.JS was started by [David Churchill] (https://github.com/webdevdave), [Verlon Smith] (https://github.com/kingedward35), [Rex Souter] (https://github.com/rex-en-abyme), [Don Steinert] (https://github.com/Dnld), and [Max Yazbin] (https://github.com/myazhbin) as their thesis while students at [Hack Reactor] (http://www.hackreactor.com).