funcity 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Kouji Matsui (@kekyo@mi.kekyo.net)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,109 @@
+# funcity
+
+A functional language interpreter with text processing.
+
+[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+---
+
+## What is this?
+
+This is a lightweight functional language processor implemented in TypeScript, featuring syntax extensions for text processing.
+It includes a CLI application and a library package containing only the core engine.
+
+funcity can be considered a type of [text template processor](https://en.wikipedia.org/wiki/Template_processor).
+For example, entering code like this:
+
+```funcity
+Today is {{if weather.sunny}}nice{{else}}bad{{end}}weather.
+```
+
+Evaluates the value of the `weather` variable manually bound to the core engine beforehand and generates different text outputs:
+
+```
+Today is bad weather.
+```
+
+The `if ... else ... end` statements in the text indicate that the script is being executed.
+So, you might ask, what makes this a "Functional language"?
+Or how is it different from existing text processors?
+
+Let me show you another equivalent example:
+
+```funcity
+Today is {{cond weather.sunny 'nice' 'bad'}} weather.
+```
+
+This is an example of function application,
+inserting the result of applying three arguments to the `cond` function.
+The first argument is a conditional expression.
+
+The following code may further interest you:
+
+```funcity
+{{
+set printWeather (fun w cond w.sunny 'nice' 'bad')
+}}
+Today is {{printWeather weather}} weather.
+```
+
+- `fun` defines an anonymous lambda function.
+- `set` performs a mutable binding in the current scope.
+
+In other words, funcity is an interpreter that brings the power of functional programming to text template processors, making them easier to handle!
+
+### Features
+
+- A lightweight functional language processor for handling untyped lambda calculus.
+  Adopted the simplest possible syntax.
+  Additionally, selected the syntax extensions that should be prioritized for text processing.
+- All function objects are treated as asynchronous functions.
+  You do not need to be aware that they are asynchronous functions when applying them.
+- There is also a CLI using the core engine.
+  The CLI has both REPL mode and text processing mode.
+- The core engine includes a tokenizer, parser, and reducer (interpreter).
+- The core engine library is highly independent,
+  requiring no dependencies on other libraries or packages.
+  It can be easily integrated into your application.
+- Parsers and interpreters support both interpreting pure expressions and interpreting full text-processing syntax.
+  This means that even when an interpreter for a purely functional language is required,
+  it is possible to completely ignore the (somewhat incongruous) syntax of text processing.
+- Allows pre-binding of useful standard function implementations.
+
+---
+
+## Installation (CLI)
+
+```bash
+npm install -D funcity-cli
+```
+
+Or, global installation:
+
+```bash
+npm install -g funcity-cli
+```
+
+## Installation (Library)
+
+```bash
+npm install funcity
+```
+
+---
+
+## Documentation
+
+For detailed documentation and advanced features, please visit our [GitHub repository](https://github.com/kekyo/funcity).
+
+## Note
+
+funcity was separated from the document site generator [mark-the-ripper](https://github.com/kekyo/mark-the-ripper) during its design phase,
+as it seemed better suited to function as an independent scripting engine.
+
+Therefore, mark-the-ripper can leverage the power of funcity's functional language.
+
+## License
+
+Under MIT.