@kipper/target-ts

Kipper TypeScript Target - @kipper/target-ts 🦊⌨️

The TypeScript target for the Kipper 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 whole Kipper package with its CLI, run the following command:

npm i @kipper/target-ts

If you are using pnpm or yarn, use pnpm i @kipper/target-ts or yarn add @kipper/target-ts.

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

Usage

If you are using @kipper/cli then this package is automatically installed and compiling to JavaScript can be done using the --target=js flag, for example:

kipper compile example-script.kip --target=js

Otherwise, simply import the target and specify it in the compilerOptions field of KipperCompiler.compile(), for example:

• JavaScript (CommonJS):

  const fs = require("fs").promises;
  const kipper = require("@kipper/core");
  const kipperTS = require("@kipper/target-ts");
  
  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 kipperTS.TargetTS() });
  	let jsCode = result.write();
  
  	// Running the Kipper program
  	eval(jsCode);
  });

• TypeScript (CommonJS):

  import { promises as fs } from "fs";
  import { KipperCompiler } from "@kipper/core";
  import { TargetTS } from "@kipper/target-ts";
  
  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 TargetTS() });
  	let tsCode = result.write();
  });

Kipper Docs

Proper documentation for the Kipper language is available at https://docs.kipper-lang.org!

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-2023 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