koi-lang / nishi Goto Github PK

View Code? Open in Web Editor NEW

1.0 1.0 0.0 135 KB

An easy, clean language that transpiles to C#.

License: BSD 3-Clause "New" or "Revised" License

ANTLR 36.98% Batchfile 0.76% Python 62.26%

nishi's Introduction

Nishi

An easy, clean language that transpiles to C#.

What is Nishi?

Nishi is a new, clean coding language that transpiles to C# code. It is inspired by languages such as Red, Python and Kotlin.

Why is Nishi?

The name "Nishi" is a slice of the name of a type of Koi, called "Nishikigoi".

Nishi is intended to be an easier language for those getting into mid-tier programming.

Using the Nishi transpiler

The Nishi transpiler is the program that turns Nishi code into C# code. You can download it from the releases page, or get the latest version by building from the source.

Once you have the transpiler program, simply open a terminal and type: nishi.exe --help. The program will then tell you the accepted arguments and what they do.

If you would like to transpile a file, you give it the file argument and then the file you want, by entering: nishi.exe --file=file.nishi or nishi.exe -f=file.nishi, where "file.nishi" is your Nishi script.

Building from source

To build the transpiler from source, you will need:

Python 3.6
ANTLR4
PyInstaller

After installing those, you just need to run nishi.bat to generate the ANTLR lexer and parser, and then run build.bat to build the binary with PyInstaller.

File Extensions:

.nishi
.nish
.goi
.lel

Inspired By:

C#
C++
Java
Python
Kotlin
Red
Go

nishi's People

Contributors

Stargazers

Watchers

nishi's Issues

Enums

enum MyEnum {
    One: 1
    Two: 2
    Three: 3
}

List comprehension

It would be nice to have list comprehension like in Python.

Multi-line strings

The language obviously needs multi-line strings.

Can't assign to class variables

Variables can't be assigned to class functions or variables.

Code outside of classes

Code should not have to just be in classes, functions and variables should be able to be defined outside of them.

Try/catch statements

try {
    this.my_empty: "This causes an error!"
}
catch TypeError {
    this.my_empty: 5
}

Improved public and private

There needs to be public and private keywords for classes, methods and variables.

Undeclared variables

Variables should not have to be declared to be used. Variable creation should be dynamic.

Many types can't be used for printing, etc

Since all reformatting of syntax and conversion takes place in the assignment methods, many types such as multiline strings can't be printed.

Statically typed variables

The type of variables can be grabbed from how they are used, so they don't need to be set.

my_int = 0;

For loops

for num in numbers {
    print("Hello, World!")
}

Classes

class MyClass {
    fun MyClass() {
    }
}

Access modifier blocks

Access blocks would allow you to define the access modifier of multiple variables when defining them.

public {
    string my_var;
    int my_number = 0;
}

private {
    float my_float = 0.0f;
}

Functions

fun hello() -> Void {
    print("Hello, World!")
}

Class method keyword

Class methods should have a different keyword than functions.

Logical operators

The language needs logical operators such as "and", "not" and "or".

Automatic return types

Return types should be able to be determined automatically.

HereDocs

It might be nice to have Ruby-like HereDocs as an alternative to multi-line strings.

# Where "END" is what stops the HereDoc
string <<END
This is a
  multiline,
as is String!
END

Import blocks

The language should have import blocks, like in Go.

import {
    System
}

Docstrings

The language should have simple and easy docstrings, such as:

doc {
    The description of what the docstring is for.
}

Dictionaries/HashMaps

my_dict: {key1: "str", key2: 5}

Words instead of symbols

Instead of using symbols such as "!" and "||", the language should use "not" and "or".

Switch/case statements

number: 5
switch number {
    case 1 { print("It's one!") }
    case 2 { print("It's two!") }
    case "Hello" { print("I don't know how this happened!") }
    case 3 + 1 { print("It's four!") }
    case 5 { print("It's five!") }

    else { print("I don't know what it is!") }
}

if one = two {
	print("I don't know how that happened.")
}
elf one != two {
	print("That's more like it.")
}
else {
	print("This also shouldn't happen.")
}

print(MyClass()@myfunc()) # Not supported by the grammar!

Variable types prefixed with var

When setting the type of a variable in a function, the variable is prefixed by "var" as well as the type.

Broken variable class access

Fixing #33 broke accessing functions from variables that hold classes.