Skip to content

Commit

Permalink
feat(jsii): do not perform api compatibility check by default
Browse files Browse the repository at this point in the history
  • Loading branch information
Elad Ben-Israel committed Jul 14, 2020
1 parent ceb82a7 commit aefe376
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@ new JsiiProject(options: JsiiProjectOptions)
* **authorEmail** (<code>string</code>) *No description* __*Optional*__
* **authorOrganization** (<code>boolean</code>) *No description* __*Optional*__
* **authorUrl** (<code>string</code>) *No description* __*Optional*__
* **compat** (<code>boolean</code>) Automatically run API compatibility test against the latest version published to npm after compilation. __*Default*__: true
* **compat** (<code>boolean</code>) Automatically run API compatibility test against the latest version published to npm after compilation. __*Default*__: false
* **compatIgnore** (<code>string</code>) Name of the ignore file for API compatibility tests. __*Default*__: .compatignore
* **description** (<code>string</code>) *No description* __*Optional*__
* **docgen** (<code>boolean</code>) Automatically generate API.md from jsii. __*Default*__: true
Expand Down Expand Up @@ -1137,7 +1137,7 @@ Name | Type | Description
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true
**bundledDependencies**?🔹 | <code>Array<string></code> | __*Optional*__
**compat**?🔹 | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation.<br/>__*Default*__: true
**compat**?🔹 | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation.<br/>__*Default*__: false
**compatIgnore**?🔹 | <code>string</code> | Name of the ignore file for API compatibility tests.<br/>__*Default*__: .compatignore
**copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
**copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"test": "yarn eslint && rm -fr lib/ && jest --passWithNoTests",
"bump": "standard-version",
"release": "yarn bump && git push --follow-tags origin master",
"compile": "jsii --silence-warnings=reserved-word && jsii-docgen && yarn compat",
"compile": "jsii --silence-warnings=reserved-word && jsii-docgen",
"watch": "jsii -w --silence-warnings=reserved-word",
"package": "jsii-pacmak",
"build": "yarn test && yarn compile && yarn run package",
Expand Down
4 changes: 2 additions & 2 deletions src/jsii-project.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export interface JsiiProjectOptions extends CommonOptions {
* - You can manually run compatbility tests using `yarn compat` if this feature is disabled.
* - You can ignore compatibility failures by adding lines to a ".compatignore" file.
*
* @default true
* @default false
*/
readonly compat?: boolean;

Expand Down Expand Up @@ -222,7 +222,7 @@ export class JsiiProject extends TypeScriptLibraryProject {
new JsiiDocgen(this);
}

const compat = options.compat ?? true;
const compat = options.compat ?? false;
if (compat) {
this.addCompileCommand('yarn compat');
}
Expand Down

0 comments on commit aefe376

Please sign in to comment.