<commit_before>FiMScript: Friendscript is Magic
================================

"Friendscript/FiMscript" is a FiM++ inspired extension to CoffeeScript, based on
[<NAME>'s Kickstarted rewrite of CoffeeScript](https://github.com/michaelficarra/CoffeeScriptRedux).

Friendscript allows CoffeeScript to include
blocks containing a Javascript-suitable variation on
[the Friendship Reports 1.0 language specification](https://docs.google.com/document/d/1gU-ZROmZu0Xitw_pfC1ktCDvJH5rM85TxxQf5pg_xmg/edit#):

> FiM++ is an esoteric programming language inspired by the “friendship
> reports” written by <NAME> in the 2010 television show My
> Little Pony: Friendship is Magic. It follows the same general
> structure as Java, but uses full English, generally past-tense words
> and sentence structure.

Friendscript intends to make this into a full-featured programming language
suitable for production use in web clients and on Node.JS.
Therefore, important changes have been made to the FiM++ syntax to support
first-class functions, prototypes, and dynamic typing.

All source map and JS pretty printing support 
present in CoffeeScript 2 will be present in Friendscript,
and development will track the bleeding edge of CS2.

Practically any existing CoffeeScript file will compile without changes.
However, if a valid Friendscript block is detected
(between a "Dear" salutation and a "Your faithful student" valediction),
it is interpreted as Friendscript.
To remove ambiguity regarding apostrophes, and for more informative syntax errors,
a Friendscript block can be surrounded in triple-backticks.
Thus, Friendscript/FiM++ and CoffeeScript can be interspersed.
In fact, Friendscript can be used as an rvalue!

An example and test suite is at [test/friendscript.coffee](friendscript/blob/master/test/friendscript.coffee).

### Getting Started
<commit_msg>FiM: adding links to readme<commit_after>FiMScript: Friendscript is Magic
================================

"Friendscript/FiMscript" is a FiM++ inspired extension to CoffeeScript, based on
[<NAME>'s Kickstarted rewrite of CoffeeScript](https://github.com/michaelficarra/CoffeeScriptRedux).

Friendscript allows CoffeeScript to include
blocks containing a Javascript-suitable variation on
[the Friendship Reports 1.0 language specification](https://docs.google.com/document/d/1gU-ZROmZu0Xitw_pfC1ktCDvJH5rM85TxxQf5pg_xmg/edit#):

> FiM++ is an esoteric programming language inspired by the “friendship
> reports” written by <NAME> in the 2010 television show My
> Little Pony: Friendship is Magic. It follows the same general
> structure as Java, but uses full English, generally past-tense words
> and sentence structure.

(For more information, see the 
[Scala reference implementation](https://github.com/KarolS/fimpp)
and the [original post on Equestria Daily that launched the craze](http://www.equestriadaily.com/2012/10/editorial-fim-pony-programming-language.html))

Friendscript intends to make this into a full-featured programming language
suitable for production use in web clients and on Node.JS.
Therefore, important changes have been made to the FiM++ syntax to support
first-class functions, prototypes, and dynamic typing.

All source map and JS pretty printing support 
present in CoffeeScript 2 will be present in Friendscript,
and development will track the bleeding edge of CS2.

Practically any existing CoffeeScript file will compile without changes.
However, if a valid Friendscript block is detected
(between a "Dear" salutation and a "Your faithful student" valediction),
it is interpreted as Friendscript.
To remove ambiguity regarding apostrophes, and for more informative syntax errors,
a Friendscript block can be surrounded in triple-backticks.
Thus, Friendscript/FiM++ and CoffeeScript can be interspersed.
In fact, Friendscript can be used as an rvalue!

An example and test suite is at [test/friendscript.coffee](friendscript/blob/master/test/friendscript.coffee).

### Getting Started

{'fraction_non_alphanumeric': 0.0777749811225774, 'fraction_numerical': 0.009061162849232317, 'mean_word_length': 5.656616415410385, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 17, 'https://': 5, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1475839', 'n_tokens_mistral': 1110, 'n_tokens_neox': 1049, 'n_words': 463}