diff --git a/README.md b/README.md index edd2674666..cffc3dbeb2 100644 --- a/README.md +++ b/README.md @@ -21,25 +21,25 @@ usual), but also in **Python**, **Java**, **C#** (and other languages from the _ 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 - [aws/jsii-rosetta](https://github.com/aws/jsii-rosetta) is where the `jsii-rosetta` sample code transliteration tool is maintained - [aws/jsii](https://github.com/aws/jsii) is where the rest of the toolchain is maintained, including: - The jsii runtime libraries for the supported jsii target languages - - `@jsii/spec`, the package that defines the *`.jsii` assembly* specification + - `@jsii/spec`, the package that defines the _`.jsii` assembly_ specification - `jsii-pacmak`, the bindings generator for jsii packages - - `jsii-reflect`, a higher-level way to process *`.jsii` assemblies* + - `jsii-reflect`, a higher-level way to process _`.jsii` assemblies_ - `jsii-config`, an interactive tool to help configure your jsii package -# :book: Blog Posts +## :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] +- **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]: @@ -53,7 +53,7 @@ Here's a collection of blog posts (in chronological order) related to `jsii`: > :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: Contributing +## :gear: Contributing See [CONTRIBUTING](./CONTRIBUTING.md). diff --git a/packages/jsii-diff/test/diagnostics.test.ts b/packages/jsii-diff/test/diagnostics.test.ts index 2540caf1f2..e8dbda439e 100644 --- a/packages/jsii-diff/test/diagnostics.test.ts +++ b/packages/jsii-diff/test/diagnostics.test.ts @@ -1,5 +1,6 @@ import { Stability } from '@jsii/spec'; +import { compare } from './util'; import { classifyDiagnostics, treatAsError, @@ -8,7 +9,6 @@ import { onlyWarnings, ErrorClass, } from '../lib/diagnostics'; -import { compare } from './util'; // ---------------------------------------------------------------------- test('experimental stability violations lead to warnings', () => { diff --git a/tools/jsii-compliance/README.md b/tools/jsii-compliance/README.md index 895ef22835..56dccbf2e3 100644 --- a/tools/jsii-compliance/README.md +++ b/tools/jsii-compliance/README.md @@ -2,9 +2,9 @@ This directory contains scripts and resources to create and validate the jsii compliance suite. -### Compliance Suite +## Compliance Suite -The compliance suite is defined as a collection of abstract test cases, that each language binding must implement individualy. +The compliance suite is defined as a collection of abstract test cases, that each language binding must implement individually. Language specific exclusions may be added to each test separately, or to the entire suite. > See [suite.ts](./suite.ts).