https://github.com/aws/jsii-compiler

The jsii compiler for TypeScript
https://github.com/aws/jsii-compiler
aws cdk compiler typescript
Last synced: about 2 months ago
JSON representation
The jsii compiler for TypeScript
Host: GitHub
URL: https://github.com/aws/jsii-compiler
Owner: aws
License: apache-2.0
Created: 2023-02-07T08:56:15.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2026-05-04T00:55:52.000Z (about 2 months ago)
Last Synced: 2026-05-04T03:00:14.834Z (about 2 months ago)
Topics: aws, cdk, compiler, typescript
Language: TypeScript
Homepage: https://aws.github.io/jsii/
Size: 8.71 MB
Stars: 44
Watchers: 10
Forks: 20
Open Issues: 16
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Support: SUPPORT.md
- Notice: NOTICE
Awesome Lists containing this project

README

          # ![jsii](https://raw.githubusercontent.com/aws/jsii-compiler/main/logo/png/128.png)

[![Join the chat at https://cdk.Dev](https://img.shields.io/static/v1?label=Slack&message=cdk.dev&color=brightgreen&logo=slack)](https://cdk.dev)

[![All Contributors](https://img.shields.io/github/all-contributors/aws/jsii/main?label=%E2%9C%A8%20All%20Contributors)](#contributors-)

[![Build Status](https://github.com/aws/jsii-compiler/workflows/build/badge.svg)](https://github.com/aws/jsii-compiler/actions?query=workflow%3Abuild+branch%3Amain)

[![npm](https://img.shields.io/npm/v/jsii?logo=npm)](https://www.npmjs.com/package/jsii)

[![docker](https://img.shields.io/badge/docker-jsii%2Fsuperchain-brightgreen?logo=docker)](https://hub.docker.com/r/jsii/superchain)

## Overview

`jsii` allows code in any language to naturally interact with JavaScript classes. It is the technology that enables the

[AWS Cloud Development Kit][cdk] to deliver polyglot libraries from a single codebase!

[cdk]: https://github.com/aws/aws-cdk

A class library written in **TypeScript** can be used in projects authored in **TypeScript** or **Javascript** (as

usual), but also in **Python**, **Java**, **C#** (and other languages from the _.NET_ family), ...

## :question: Documentation

Head over to our [documentation website](https://aws.github.io/jsii)!

The jsii toolchain is spread out on multiple repositories:

- [aws/jsii-compiler](https://github.com/aws/jsii-compiler) is where the `jsii` compiler is maintained (except releases

  in the `1.x` line)

- [aws/jsii-rosetta](https://github.com/aws/jsii-rosetta) is where the `jsii-rosetta` sample code transliteration tool

  is maintained (except releases in the `1.x` line)

- [aws/jsii](https://github.com/aws/jsii) is where the rest of the toolchain is maintained, including:

  - `@jsii/spec`, the package that defines the *`.jsii` assembly* specification

  - `jsii-config`, an interactive tool to help configure your jsii package

  - `jsii-pacmak`, the bindings generator for jsii packages

  - `jsii-reflect`, a higher-level way to process *`.jsii` assemblies*

  - The jsii runtime libraries for the supported jsii target languages

  - `1.x` release lines of `jsii` and `jsii-rosetta`

## :book: Blog Posts

Here's a collection of blog posts (in chronological order) related to `jsii`:

- **2020-01-11:**  [How to Create CDK Constructs][mbonig-2020-01-11], by [Matthew Bonig][@mbonig]

- **2020-05-27:**  [Generate Python, Java, and .NET software libraries from a TypeScript

  source][floydpink-2020-05-27], by [Hari Pachuveetil][@floydpink]

- **2020-12-23:**  [How the jsii open source framework meets developers where they are

  ][romain-2020-12-23], by [Romain Marcadier][@RomainMuller]

[mbonig-2020-01-11]: https://www.matthewbonig.com/2020/01/11/creating-constructs/

[floydpink-2020-05-27]:

  https://aws.amazon.com/fr/blogs/opensource/generate-python-java-dotnet-software-libraries-from-typescript-source/

[romain-2020-12-23]:

  https://aws.amazon.com/blogs/opensource/how-the-jsii-open-source-framework-meets-developers-where-they-are/

[@mbonig]: http://www.matthewbonig.com/

[@floydpink]: https://harimenon.com/

[@romainmuller]: https://github.com/RomainMuller

> :information_source: If you wrote blog posts about `jsii` and would like to have them referenced here, do not hesitate

> to file a pull request to add the links here!

## :gear: Maintenance & Support

The applicable _Maintenance & Support policy_ can be reviewed in [SUPPORT.md](./SUPPORT.md).

The current status of `jsii` compiler releases is:

| Release | Status      | EOS        | Comment                                                                                 |

| ------- | ----------- | ---------- | --------------------------------------------------------------------------------------- |

| `5.9.x` | Current     | TBD        | ![npm](https://img.shields.io/npm/v/jsii/v5.9-latest?label=jsii%40v5.9-latest&logo=npm) |

| `5.8.x` | Unsupported | 2026-02-15 | ![npm](https://img.shields.io/npm/v/jsii/v5.8-latest?label=jsii%40v5.8-latest&logo=npm) |

## :mute: Silencing Warnings

The `--silence-warnings` option allows you to suppress specific warnings from the compiler output. Silenced warnings

are still emitted internally (e.g. they are still part of the assembly), but are not printed to the console. When

`--fail-on-warnings` (`--Werr`) is set, silenced warnings are not treated as errors.

Warnings can be identified by JSII code, number, or diagnostic name:

```sh

# By full JSII code

jsii --silence-warnings JSII5018

# By number only

jsii --silence-warnings 5018

# By specific diagnostic name (the part after the slash)

jsii --silence-warnings reserved-word

# By full diagnostic name

jsii --silence-warnings language-compatibility/reserved-word

# By category (silences ALL warnings in that category)

jsii --silence-warnings language-compatibility

# Multiple warnings

jsii --silence-warnings reserved-word JSII5019

```

### Inline Suppression

Individual warnings can be suppressed directly in source code using the `@jsii suppress` directive. This is useful

when you want `--fail-on-warnings` enabled globally but need to allow specific instances of a warning.

Each directive accepts a single warning identifier using the same formats as `--silence-warnings`. An optional text after

the identifier is treated as an explanation comment. Use multiple directives to suppress multiple warnings:

```ts

export class MyClass {

  /**

   * @jsii suppress JSII5019 this name is intentional

   * @jsii suppress reserved-word

   */

  public myClass(): void { }

}

```

The suppression applies to the annotated declaration and all of its members. For example, a `@jsii suppress`

directive on a class will suppress matching warnings on all methods and properties within that class.

Only warnings that reference a source code location can be suppressed inline. Warnings not tied to a specific node

(e.g. `JSII0003` for a missing README) are not affected.

## :balance_scale: License

**jsii** is distributed under the [Apache License, Version 2.0][apache-2.0].

See [LICENSE](./LICENSE) and [NOTICE](./NOTICE) for more information.

[apache-2.0]: https://www.apache.org/licenses/LICENSE-2.0

## :gear: Contributing

See [CONTRIBUTING](./CONTRIBUTING.md).

### Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
_Aatman
💻

      
_{Aaron Costley}
🐛 💻 🤔 👀

      
_{Abdallah Hodieb}
🐛

      
_{Adam Ruka}
🐛 💻 🚧 👀

      
_{Adrian Dimech}
💻

      
_{Adrian Hesketh}
💻

      
_{Alex Pulver}
🐛

    

    

      
_{Amir Szekely}
💻

      
_{Andi Pabst}
🐛

      
_{Andrew Wason}
🐛 💻

      
_{André Fontenele}
💻

      
_{Andy Slezak}
💻

      
_{Ansgar Mertens}
🚧 💻 🐛

      
_{Anshul Guleria}
🤔

    

    

      
_{Anurag Roy}
💻

      
_{Ari Palo}
🤔

      
_{Armaan Tobaccowalla}
🐛

      
_{Bartłomiej Jurek}
🐛

      
_{Ben Bridts}
📖

      
_{Ben Chaimberg}
📖

      
_{Ben Farr}
📖

    

    

      
_{Ben Walters}
🤔

      
_{Benjamin Macher}
📖

      
_{Benjamin Maizels}
💻 👀

      
_{Bervianto Leo Pratama}
💻

      
_{Bill Cauchois}
🤔

      
_{Bradley Sherman}
💻

      
_{Brecht Verhoeve}
🤔

    

    

      
_{Breland Miley}
💻

      
_{Bryan Moffatt}
💻

      
_CaerusKaru
💻 🚧

      
_{Calvin Combs}
💻 👀

      
_{Camilo Bermúdez}
🐛

      
_{Campion Fellin}
💻

      
_{Carter Van Deuren}
🐛

    

    

      
_{Chris Garvis}
📖

      
_{Christian Moore}
🐛

      
_{Christophe Vico}
🐛

      
_{Christopher Currie}
💻 🤔

      
_{Christopher Rybicki}
📖 🐛 💻

      
_{Colin Francis}
💻

      
_{CommanderRoot}
💻

    

    

      
_{Cory Hall}
🐛

      
_{Cristian Măgherușan-Stanciu}
🐛

      
_{CyrusNajmabadi}
🐛 🤔

      
_{Damian Silbergleith}
💻 🐛

      
_{Daniel Dinu}
🐛 💻

      
_{Daniel Schmidt}
🐛 💻

      
_{Daniel Schroeder}
🐛 💻 📖 🤔 🚧

    

    

      
_{Dave Slotnick}
🐛

      
_{David Bell}
💻

      
_{Donald Stufft}
🐛 💻 🤔 👀

      
_{Dongie Agnir}
💻 👀

      
_{Eduardo Rabelo}
📖

      
_{Eduardo Sena S. Rosa}
🐛

      
_{Elad Ben-Israel}
🐛 💻 🤔 🚧 👀 📢

    

    

      
_{Eli Polonsky}
🐛 💻 🤔 🚧 👀

      
_{Eric Carboni}
💻

      
_{Eric Z. Beard}
📆

      
_{Erik Karlsson}
🐛

      
_{Eugene Kozlov}
💻

      
_{Fabio Gentile}
🐛

      
_{Florian Eitel}
🤔

    

    

      
_{Glib Shpychka}
🐛

      
_{Graham Lea}
🤔 👀

      
_{Greg Lucas}
💻

      
_{Hamza Assyad}
🐛 💻 🤔 👀

      
_{Hari Pachuveetil}
📝 📖

      
_{Hirotaka Tagawa / wafuwafu13}
💻

      
_{Hogan Bobertz}
💻

    

    

      
_{Hsing-Hui Hsu}
💻 📖 🤔 👀

      
_{Huy Phan (Harry)}
💻

      
_{Ikko Ashimine}
📖

      
_James
🐛 💻

      
_{James Kelley}
🐛

      
_{James Mead}
💻

      
_{James Siri}
💻 🚧

    

    

      
_{Jason Del Ponte}
🤔 👀

      
_{Jason Fulghum}
🤔 📆 👀

      
_{Jeff Malins}
💻

      
_{Jerry Kindall}
📖 🤔

      
_{Jimmy Gaussen}
🤔

      
_{Johannes Weber}
📖

      
_{John Pantzlaff}
💻

    

    

      
_{Jon Day}
💻

      
_{Jon Steinich}
🐛 🤔 💻

      
_{Joseph Lawson}
👀

      
_{Joseph Martin}
🐛

      
_Junix
🐛

      
_{Justin Frahm}
🐛

      
_{Justin Taylor}
🐛

    

    

      
_{Kaizen Conroy}
💻

      
_{Kaushik Borra}
🐛

      
_Kayo
💻

      
_{Kendra Neil}
💻

      
_{Knut O. Hellan}
🐛

      
_{Kyle Thomson}
💻 👀

      
_{Leandro Padua}
🐛

    

    

      
_{Liang Zhou}
🐛 💻

      
_{Madeline Kusters}
💻 🐛

      
_{Maja S Bratseth}
🐛

      
_{Marcos Diez}
🐛

      
_{Mark Nielsen}
💻

      
_{Matthew Bonig}
🐛 📝

      
_{Matthew Pirocchi}
💻 🤔 👀

    

    

      
_{Meng Xin Zhu}
🐛

      
_{Michael Neil}
🚧

      
_{Mike Lane}
🐛

      
_{Mitch Garnaat}
🐛 💻 🤔 👀

      
_{Mitchell Valine}
🐛 💻 🤔 🚧 👀

      
_{Mohamad Soufan}
📖

      
_{Mohamed Elasmar}
💻

    

    

      
_{Momo Kornher}
💻

      
_{Mykola Mogylenko}
🐛

      
_Naumel
👀

      
_{Neta Nir}
💻 🤔 🚧 👀

      
_{Nick Lynch}
🐛 💻 🚧 👀

      
_{Niranjan Jayakar}
🐛 💻 🤔 🚧 👀

      
_{Noah Litov}
💻 🚧 👀

    

    

      
_{Otavio Macedo}
💻 🐛

      
_{PIDZ - Bart}
🤔

      
_{Pahud Hsieh}
💻

      
_{Peter Woodworth}
🚧

      
_{Petr Kacer}
🐛

      
_{Petra Barus}
💻

      
_{Philip Cali}
🤔

    

    

      
_{Quentin Loos}
🤔

      
_Raphael
🐛

      
_{Richard H Boyd}
🐛

      
_{Rico Huijbers}
🐛 💻 🤔 🚧 👀

      
_{Romain Marcadier}
🐛 💻 🎨 🤔 🚧 👀 📝

      
_{Ryan Parker}
💻

      
_{SADIK KUZU}
👀

    

    

      
_SK
🤔

      
_{Sam Fink}
💻 👀

      
_{Sam Goodwin}
👀

      
_{Sebastian Korfmann}
🐛 💻 🤔

      
_{Sepehr Laal}
🐛

      
_{Shailja Khurana}
💻

      
_{Shane Witbeck}
🤔

    

    

      
_{Shiv Lakshminarayan}
💻 🚧 👀

      
_Somaya
💻 🤔 🚧 👀

      
_{Stephen Kuenzli}
📖

      
_{Takahiro Sugiura}
📖

      
_{The Gitter Badger}
💻 🚧

      
_{Thomas Matecki}
💻

      
_{Thomas Poignant}
🐛

    

    

      
_{Thomas Steinbach}
🐛

      
_{Thorsten Hoeger}
💻

      
_{Tim Wagner}
🐛 🤔

      
_{Timothy Jones}
💻

      
_{Tobias Lidskog}
💻

      
_{Tom Bonner}
🐛

      
_{Tom Keller}
💻

    

    

      
_{Ty Coghlan}
🐛

      
_{Tyler van Hensbergen}
🤔

      
_{Vinayak Kukreja}
💻

      
_{Vlad Hrybok}
🐛

      
_{Vladimir Shchur}
🐛

      
_{Will Bender}
💻

      
_{Yan Zhulanow}
💻

    

    

      
_Yathi
💻

      
_{Yigong Liu}
🐛 🤔

      
_{Zach Bienenfeld}
🐛

      
_ajnarang
🤔

      
_andyan
💻

      
_aniljava
💻

      
_{arnogeurts-sqills}
🐛 💻

    

    

      
_cn-cit
🐛

      
_deccy-mcc
🐛

      
_{dependabot-preview[bot]}
🐛 🚧

      
_{dependabot[bot]}
🚧

      
_dheffx
🐛

      
_gregswdl
🐛

      
_guyroberts21
📖

    

    

      
_{mattBrzezinski}
📖

      
_mergify
🚧

      
_mergify[bot]
🚧

      
_mikewrighton
💻

      
_nathannaveen
🚧

      
_paulhcsun
💻

      
_seiyashima42
🐛 💻 📖

    

    

      
_sullis
💻

      
_vaneek
🐛

      
_wendysophie
🐛

      
_ysuzuki19
💻

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.

Contributions of any kind welcome!
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/aws/jsii-compiler

Awesome Lists containing this project

README
