@kipper/core

Kipper Core Package - @kipper/core 🦊✨

The core module for Kipper, which contains the primary language and compiler. ⌨️✨

Kipper is a JavaScript-like strongly and strictly typed language with Python flavour. It aims to provide straightforward, simple, secure and type-safe coding with better efficiency and developer satisfaction!

It compiles to both JavaScript and TypeScript, and can be set up in your terminal, Node.js or ES6+ browser. 🦊💻

For more details, you can read more about this project on the project repository and the Kipper website.

Installation

To install the package, run the following command:

npm i @kipper/core

If you are using pnpm or yarn, use pnpm i @kipper/core or yarn add @kipper/core.

General Information

• Website: https://kipper-lang.org
• Docs: https://docs.kipper-lang.org
• Playground: https://play.kipper-lang.org
• Issue Tracker: https://issues.kipper-lang.org
• Roadmap: View Kipper Roadmap 🦊🚧
• Changelog: View CHANGELOG.md

How to use Kipper?

To use Kipper you have three options:

• Run it in the browser using the CDN kipper-standalone.min.js file, which bundles the entire compiler for your browser.
• Run it using the NodeJS CLI @kipper/cli.
• Import the package @kipper/core in NodeJS or Deno.

In a browser with @kipper/web 🦊🌐

For running Kipper in the browser, you will have to include the kipper-standalone.js file, which provides the Kipper Compiler for the browser and enables the compilation of Kipper code to JavaScript.

Simple example of compiling and running Kipper code in a browser:

<!-- Kipper dependency -->
<script src="https://cdn.jsdelivr.net/npm/@kipper/web@latest/kipper-standalone.min.js"></script>

<!-- You won't have to define Kipper or anything after including the previous file. It will be defined per default  -->
<!-- with the global 'Kipper' -->
<script type="module">
	const compiler = new Kipper.KipperCompiler();

	// Compile the code to JavaScript
	// Top-level await ref: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await#top_level_await
	const result = await compiler.compile(`print("Hello world!");`, { target: new KipperJS.TargetJS() });
	const jsCode = result.write();

	// Finally, run your program
	eval(jsCode);
</script>

Locally using Node.js with @kipper/cli 🦊🖥️

This is to recommend way to use Kipper if you want to dive deeper into Kipper, as it allows you to locally use and run kipper, without depending on a browser.

For example:

• Compiling a Kipper program:

  kipper compile file.kip

• Executing a Kipper program using Node.js:

  kipper run file.kip

This also enables the usage of Kipper files with the .kip extension, which can be read and compiled to TypeScript, without having to configure anything yourself. This also allows the input of data over the console and file-interactions, which are not supported inside a browser.

For more info go to the @kipper/cli README.

Locally in your own code with @kipper/core 🦊⌨️

This is the recommended way if you intend to use kipper in a workflow or write code yourself to manage the compiler. This also allows for special handling of logging and customising the compilation process.

Simple example of using the Kipper Compiler in Node.js:

• JavaScript (CommonJS):

  const fs = require("fs").promises;
  const kipper = require("@kipper/core");
  const kipperJS = require("@kipper/target-js");
  
  const path = "INSERT_PATH";
  fs.readFile(path, "utf8").then(async (fileContent) => {
  	const compiler = new kipper.KipperCompiler();
  
  	// Compile the code string or stream
  	let result = await compiler.compile(fileContent, { target: new kipperJS.TargetJS() });
  	let jsCode = result.write();
  
  	// Running the Kipper program
  	eval(jsCode);
  });

• TypeScript (CommonJS):

  import { promises as fs } from "fs";
  import { KipperCompiler } from "@kipper/core";
  import { TargetJS } from "@kipper/target-js";
  
  const path = "INSERT_PATH";
  fs.readFile(path, "utf8" as BufferEncoding).then(async (fileContent: string) => {
  	const compiler = new KipperCompiler();
  
  	// Compile the code string or stream
  	let result = await compiler.compile(fileContent, { target: new TargetJS() });
  	let jsCode = result.write();
  
  	// Running the Kipper program
  	eval(jsCode);
  });

Contributing to Kipper

If you want to contribute to Kipper, we have a full guide explaining the structure of Kipper and how to use GitHub issues and pull requests. Check it out here!

If you have any questions or concerns, you can open up a discussion page here!

We appreciate any feedback or help! Kipper is open-source and free for anyone, help us make it even better! 🦊❤️

Copyright and License

Copyright (C) 2021-2024 Luna Klatzer

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

See the LICENSE for information on terms & conditions for usage.

FOSSA License Report