diff --git a/fixtures/@fixtures/jsii-composite/.gitignore b/fixtures/@fixtures/jsii-composite/.gitignore new file mode 100644 index 00000000..e8e1fb9b --- /dev/null +++ b/fixtures/@fixtures/jsii-composite/.gitignore @@ -0,0 +1,14 @@ +tsconfig.json +dist +.jsii +*.tgz + +*.js +*.d.ts +*.tsbuildinfo +node_modules/ +.nyc_output/ +coverage/ +*.d.ts.map + +build/ diff --git a/fixtures/@fixtures/jsii-composite/.npmignore b/fixtures/@fixtures/jsii-composite/.npmignore new file mode 100644 index 00000000..2f2ad532 --- /dev/null +++ b/fixtures/@fixtures/jsii-composite/.npmignore @@ -0,0 +1,16 @@ +# Don't include original .ts files when doing `npm pack` +*.ts +!*.d.ts +*.tgz + + +# Include .jsii and .jsii.gz +!.jsii +!.jsii.gz + + +# Exclude jsii outdir +dist + +tsconfig.json +*.tsbuildinfo diff --git a/fixtures/@fixtures/jsii-composite/LICENSE b/fixtures/@fixtures/jsii-composite/LICENSE new file mode 100644 index 00000000..129acd53 --- /dev/null +++ b/fixtures/@fixtures/jsii-composite/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/fixtures/@fixtures/jsii-composite/NOTICE b/fixtures/@fixtures/jsii-composite/NOTICE new file mode 100644 index 00000000..dc4ac3f8 --- /dev/null +++ b/fixtures/@fixtures/jsii-composite/NOTICE @@ -0,0 +1,2 @@ +jsii +Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/fixtures/@fixtures/jsii-composite/lib/index.ts b/fixtures/@fixtures/jsii-composite/lib/index.ts new file mode 100644 index 00000000..c9d0031e --- /dev/null +++ b/fixtures/@fixtures/jsii-composite/lib/index.ts @@ -0,0 +1,25 @@ +export interface IVeryBaseInterface { + foo(): void; +} + +export interface VeryBaseProps { + readonly foo: Very; +} + +/** + * Something here + * @experimental + */ +export class Very { + public hey() { + return 42; + } +} + +export class StaticConsumer { + private constructor() {} + + public static consume(..._args: any[]): void { + return; + } +} diff --git a/fixtures/@fixtures/jsii-composite/package.json b/fixtures/@fixtures/jsii-composite/package.json new file mode 100644 index 00000000..f87183a3 --- /dev/null +++ b/fixtures/@fixtures/jsii-composite/package.json @@ -0,0 +1,34 @@ +{ + "name": "@fixtures/jsii-composite", + "version": "0.19.0", + "private": true, + "license": "Apache-2.0", + "author": { + "name": "Amazon Web Services", + "url": "https://aws.amazon.com" + }, + "homepage": "https://github.com/aws/jsii", + "bugs": { + "url": "https://github.com/aws/jsii/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/aws/jsii.git", + "directory": "packages/@fixtures/jsii-composite" + }, + "engines": { + "node": ">= 14.6.0" + }, + "main": "build/lib/index.js", + "types": "build/lib/index.d.ts", + "jsii": { + "projectReferences": true, + "outdir": "dist", + "tsc": { + "outDir": "./build", + "rootDir": ".", + "types": [] + }, + "versionFormat": "short" + } +} diff --git a/src/compiler.ts b/src/compiler.ts index 0c90ff5e..ec5921cd 100644 --- a/src/compiler.ts +++ b/src/compiler.ts @@ -81,7 +81,6 @@ export class Compiler implements Emitter { const configFileName = options.typeScriptConfig ?? options.generateTypeScriptConfig ?? 'tsconfig.json'; this.configPath = path.join(this.projectRoot, configFileName); this.userProvidedTypeScriptConfig = Boolean(options.typeScriptConfig); - this.tsconfig = this.configureTypeScript(); this.system = { ...ts.sys, @@ -99,6 +98,7 @@ export class Compiler implements Emitter { ts.sys.writeFile(path.resolve(this.projectRoot, pth), data, writeByteOrderMark), }; + this.tsconfig = this.configureTypeScript(); this.compilerHost = ts.createIncrementalCompilerHost(this.tsconfig.compilerOptions, this.system); } diff --git a/test/compiler.test.ts b/test/compiler.test.ts index f9fc6b56..29f70924 100644 --- a/test/compiler.test.ts +++ b/test/compiler.test.ts @@ -1,7 +1,8 @@ -import { mkdirSync, existsSync, mkdtempSync, rmSync, writeFileSync, readFileSync } from 'node:fs'; +import { mkdirSync, existsSync, mkdtempSync, rmSync, writeFileSync, readFileSync, symlinkSync } from 'node:fs'; import { tmpdir } from 'node:os'; -import { join } from 'node:path'; +import { dirname, join } from 'node:path'; import { loadAssemblyFromPath, SPEC_FILE_NAME, SPEC_FILE_NAME_COMPRESSED } from '@jsii/spec'; +import { compile, Lock } from './fixtures'; import { Compiler } from '../src/compiler'; import { TYPES_COMPAT } from '../src/downlevel-dts'; import { ProjectInfo } from '../src/project-info'; @@ -170,6 +171,59 @@ describe(Compiler, () => { rmSync(sourceDir, { force: true, recursive: true }); } }); + + describe('project references', () => { + let lock: Lock | undefined; + + beforeAll(async () => { + lock = await Lock.acquire(); + }, 120_000); + + afterAll(async () => { + await lock?.release(); + lock = undefined; + }, 120_000); + + test('can resolve project references', async () => { + const sourceDir = mkdtempSync(join(tmpdir(), 'jsii-compiler-project-refs')); + + // link the composite package + const fixture = '@fixtures/jsii-composite'; + const fixtureLocation = compile(lock!, fixture, false); + const linkLocation = join(sourceDir, 'node_modules', fixture); + mkdirSync(dirname(linkLocation), { recursive: true }); + symlinkSync(fixtureLocation, linkLocation, 'dir'); + + // Add some files to the parent project + writeFileSync(join(sourceDir, 'index.ts'), 'export class MarkerA {}'); + writeFileSync(join(sourceDir, 'README.md'), '# Test Package'); + + const compiler = new Compiler({ + projectInfo: { + ..._makeProjectInfo(sourceDir, 'index.d.ts'), + packageJson: { + devDependencies: { + '@fixtures/jsii-composite': '*', + }, + }, + }, + projectReferences: true, + }); + + compiler.emit(); + + expect(JSON.parse(readFileSync(join(sourceDir, 'tsconfig.json'), 'utf-8'))).toMatchObject({ + compilerOptions: { + composite: true, + }, + references: [ + { + path: expect.stringMatching('fixtures/@fixtures/jsii-composite'), + }, + ], + }); + }, 120_000); + }); }); describe('user-provided tsconfig', () => {