feat: introduce CompositeProject #289

misterjoshua · 2020-11-08T22:39:00Z

Introduces a CompositeProject type that allows multiple projects to be added with a relative directory and synthesized into a single tree.

const comp = new CompositeProject();
comp.addProject('packages/foo', new NodeProject(...));
comp.addProject('packages/bar', new NextjsProject(...));

comp.synth();

See also #284

misterjoshua · 2020-11-08T22:52:58Z

@eladb @hoegertn Fresh PR for CompositeProject here.

src/composite-project.ts

misterjoshua · 2020-11-09T00:02:30Z

src/composite-project.ts

+export class SubProjectComponent extends Component {
+  constructor(project: Project, private readonly options: SubProjectComponentOptions) {
+    super(project);
+  }


Maybe we could also offer access to the parent root then for .github stuff etc

@hoegertn I was thinking that there's a design decision to be made about how a project can know the parent root so that it knows the right place to put the .github stuff. Given that a sub-project is instantiated before it knows that it's a sub-project, it seems to me that there's a need to inform the sub-project of that. I could call back to the project to inform it here, for instance.

misterjoshua · 2020-11-09T03:47:59Z

I'm starting to wonder if I like ProjectComponent more than everything else I've written here. 🤣 Well anyway, I'll leave this now for your guys' review.

eladb

Looks promising!

src/composite-project.ts

…ojectChild

eladb

Please add composite-project.ts to index.ts

src/composite-project.ts

eladb · 2020-11-10T19:33:46Z

src/composite-project.ts

+   * ]
+   * ```
+   */
+  projects?: CompositeProjectChild[];


Suggested change

projects?: CompositeProjectChild[];

readonly projects?: CompositeProjectChild[];

test/composite-project.test.ts

src/composite-project.ts

eladb

A couple of minor tweaks and we are ready

Co-authored-by: Elad Ben-Israel <benisrae@amazon.com>

misterjoshua · 2020-11-11T18:37:38Z

A couple of minor tweaks and we are ready

@eladb Cool. The changes you requested are in now.

misterjoshua · 2020-11-11T19:07:14Z

@eladb It looks like the build broke in master because after a version bump, NodeProject is looking for the not-yet-released projen version in npm during the tests. I'll see if I can figure out how to work around this.

… bump (#300) This should fix the build in master when bumping versions after #289. `NodeProject` in the tests wanted to pull the not-yet-released projen packages after the bump. This fix addresses the issue by changing the tests not to depend on any project type that needs to know Projen's version.

Introduce an optional `parent` option to `Project` and `outdir` to allow implementing project trees. The `CompositeProject` approach which was introduced in #289 has a limitation in which projects could not query who is their parent (because potentially a child can be added at any time). Also, it technically allowed the same child project to be added to multiple parents. Therefore, these classes are no longer available. This change also moves `outdir` from the various `synth()` methods to `ProjectOptions`. This early-binding approach is also more in-line with how CDK code is written, whereas during initialization it is possible to reason about the full synthesis context. Additional APIs introduced in this change are `project.files` and `project.findFile(path)` which can be used to inspect the project's contents. `findFile()` can find files in projects and subprojects. BREAKING CHANGE: The `CompositeProject` and `ProjectComponent` classes have been superseded by subprojects in order to allow safely accessing the parent project during subproject initialization phase. Use `new Project({ parent, outdir })` to define this relationship. * The various `synth()` methods no longer accept an `outdir`. Instead, specify `outdir` in the project options.

resistdesign · 2021-07-31T14:57:23Z

Am I allowed to cheer for a PR? 😛 🎉

feat: introduce CompositeProject

84b070c

misterjoshua marked this pull request as draft November 8, 2020 22:42

hoegertn reviewed Nov 8, 2020

View reviewed changes

misterjoshua added 3 commits November 8, 2020 16:14

refactor: store the project component instead of boolean

6826597

refactor: change sub-project component option names

6ef3cf1

refactor: use less exotic syntax to delcare os-specific paths

8af4e0b

misterjoshua commented Nov 9, 2020

View reviewed changes

misterjoshua added 2 commits November 8, 2020 19:30

fix: missing doc comment

4ccd595

refactor: change to ProjectComponent

98809a2

misterjoshua marked this pull request as ready for review November 9, 2020 03:28

chore: add test to show ProjectComponent is general-use

0fe0f4d

eladb suggested changes Nov 10, 2020

View reviewed changes

src/composite-project.ts Outdated Show resolved Hide resolved

src/composite-project.ts Outdated Show resolved Hide resolved

misterjoshua added 2 commits November 10, 2020 08:51

refactor: rename CompositeProjectDeclarativeSubProject -> CompositePr…

9dc7cf9

…ojectChild

refactor: make ProjectComponent et al private

ef30293

misterjoshua requested a review from eladb November 10, 2020 15:58

eladb suggested changes Nov 10, 2020

View reviewed changes

misterjoshua added 2 commits November 10, 2020 12:46

fix: add CompositeProject to index

3975684

refactor: use CompositeProjectChild as ProjectComponent options

db183f2

Chriscbr reviewed Nov 10, 2020

View reviewed changes

test/composite-project.test.ts Outdated Show resolved Hide resolved

chore: path.join in test for consistency

f03d6c7

misterjoshua requested a review from eladb November 10, 2020 22:16

eladb reviewed Nov 11, 2020

View reviewed changes

src/composite-project.ts Outdated Show resolved Hide resolved

eladb reviewed Nov 11, 2020

View reviewed changes

src/composite-project.ts Outdated Show resolved Hide resolved

eladb reviewed Nov 11, 2020

View reviewed changes

misterjoshua and others added 2 commits November 11, 2020 11:28

Apply suggestions from code review

76b2234

Co-authored-by: Elad Ben-Israel <benisrae@amazon.com>

chore: apply changes entailed by code review

9ed6bff

eladb approved these changes Nov 11, 2020

View reviewed changes

Merge branch 'master' into f-composite

950bc59

mergify bot merged commit d606b3d into projen:master Nov 11, 2020

misterjoshua deleted the f-composite branch November 11, 2020 18:55

misterjoshua mentioned this pull request Nov 11, 2020

fix: CompositeProject tests reference unreleased projen version after bump #300

Merged

eladb mentioned this pull request Nov 23, 2020

feat: subprojects #332

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: introduce CompositeProject #289

feat: introduce CompositeProject #289

misterjoshua commented Nov 8, 2020 •

edited

Loading

misterjoshua commented Nov 8, 2020

misterjoshua Nov 9, 2020

misterjoshua commented Nov 9, 2020

eladb left a comment

eladb left a comment

eladb Nov 10, 2020

eladb left a comment

misterjoshua commented Nov 11, 2020

misterjoshua commented Nov 11, 2020 •

edited

Loading

resistdesign commented Jul 31, 2021

	projects?: CompositeProjectChild[];
	readonly projects?: CompositeProjectChild[];

feat: introduce CompositeProject #289

feat: introduce CompositeProject #289

Conversation

misterjoshua commented Nov 8, 2020 • edited Loading

misterjoshua commented Nov 8, 2020

misterjoshua Nov 9, 2020

Choose a reason for hiding this comment

misterjoshua commented Nov 9, 2020

eladb left a comment

Choose a reason for hiding this comment

eladb left a comment

Choose a reason for hiding this comment

eladb Nov 10, 2020

Choose a reason for hiding this comment

eladb left a comment

Choose a reason for hiding this comment

misterjoshua commented Nov 11, 2020

misterjoshua commented Nov 11, 2020 • edited Loading

resistdesign commented Jul 31, 2021

misterjoshua commented Nov 8, 2020 •

edited

Loading

misterjoshua commented Nov 11, 2020 •

edited

Loading