feat: add secondary entrypoint schematic #28723

Jefiozie · 2024-10-28T05:18:10Z

PR Checklist

Please check to confirm your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/angular/angular-cli/blob/main/CONTRIBUTING.md#-commit-message-guidelines
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

What is the current behavior?

There is no easy way to generate a secondary entrypoint

Issue Number: #19070

What is the new behavior?

This PR adds the ability to generate a secondary entrypoint in a library project. It cannot be used without a library project.

Does this PR introduce a breaking change?

Yes
No

Other information

I've copied some helper utils from other schematics. I'm happy to make a other PR to add these to the utility parts with proper tests on it. Not updated the docs as this is I think in a other repo?

Pinging @SanderElias he mentioned there was nothing in the cli and encourage me to make this change 👍

Closes #19070

SanderElias

Looks good to me! Ship It!

alan-agius4

Thank you for this. We discussed this during yesterday's meeting and agreed to proceed with adding a schematic to generate additional library entry points.

As a side note, it would be great if the library schematic could also leverage this schematic to generate its own entry point.

I’ve completed an initial review and left a few minor comments. Let me know if you have any questions!

alan-agius4 · 2025-01-09T08:19:21Z

packages/schematics/angular/collection.json

@@ -117,6 +117,12 @@
      "schema": "./library/schema.json",
      "description": "Generate a library project for Angular."
    },
+    "library-secondary-entrypoint": {


Suggested change

"library-secondary-entrypoint": {

"library-entrypoint": {

alan-agius4 · 2025-01-09T08:19:45Z

packages/schematics/angular/collection.json

@@ -117,6 +117,12 @@
      "schema": "./library/schema.json",
      "description": "Generate a library project for Angular."
    },
+    "library-secondary-entrypoint": {
+      "aliases": ["secondary"],
+      "factory": "./secondary-entrypoint",


NIT: name the directory the same as the schematic.

alan-agius4 · 2025-01-09T08:20:01Z

packages/schematics/angular/collection.json

@@ -117,6 +117,12 @@
      "schema": "./library/schema.json",
      "description": "Generate a library project for Angular."
    },
+    "library-secondary-entrypoint": {
+      "aliases": ["secondary"],


Suggested change

"aliases": ["secondary"],

"aliases": ["lib-entry"],

alan-agius4 · 2025-01-09T08:20:53Z

packages/schematics/angular/collection.json

+      "aliases": ["secondary"],
+      "factory": "./secondary-entrypoint",
+      "schema": "./secondary-entrypoint/schema.json",
+      "description": "Generate a secondary-entrypoint in a library project for Angular."


Suggested change

"description": "Generate a secondary-entrypoint in a library project for Angular."

"description": "Generate an entrypoint in an Angular library project."

alan-agius4 · 2025-01-09T08:27:23Z

packages/schematics/angular/secondary-entrypoint/index.ts

+      const distRoot = `dist/${folderName}/${options.name}`;
+
+      const templateSource = apply(url('./files'), [
+        applyTemplates({


Some of the below are unused.

alan-agius4 · 2025-01-09T08:29:07Z

packages/schematics/angular/secondary-entrypoint/schema.json

+  "$id": "SchematicsLibrary",
+  "title": "Secondary Entrypoint Schema",
+  "type": "object",
+  "description": "Creates a secondary entrypoint in a library project in a project.",


Suggested change

"description": "Creates a secondary entrypoint in a library project in a project.",

"description": "Generate an entrypoint in an Angular library project.",

alan-agius4 · 2025-01-09T08:29:19Z

packages/schematics/angular/secondary-entrypoint/schema.json

+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "SchematicsLibrary",
+  "title": "Secondary Entrypoint Schema",


Suggested change

"title": "Secondary Entrypoint Schema",

"title": "Library Secondary Entrypoint Schema",

alan-agius4 · 2025-01-09T08:29:32Z

packages/schematics/angular/secondary-entrypoint/schema.json

+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the library.",


Suggested change

"description": "The name of the library.",

"description": "The name of the entrypoint to create.",

alan-agius4 · 2025-01-09T08:32:46Z

packages/schematics/angular/secondary-entrypoint/schema.json

+    "name": {
+      "type": "string",
+      "description": "The name of the library.",
+      "pattern": "^(?:@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*/)?[a-zA-Z0-9-~][a-zA-Z0-9-._~]*$",


The name should likely be just the name of the entry-point and not a combination of the library and entrypoint.

ng g library-entrypoint --project="@foo/bar" --name="buz"

Suggested change

"pattern": "^(?:@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*/)?[a-zA-Z0-9-~][a-zA-Z0-9-._~]*$",

"pattern": "^[a-zA-Z0-9-._~]+/?[a-zA-Z0-9-._~]+$",

alan-agius4 · 2025-01-09T08:36:33Z

packages/schematics/angular/secondary-entrypoint/index_spec.ts

@@ -0,0 +1,164 @@
+/**
+ * @license


Can you please update https://github.com/angular/angular-cli/blob/main/tests/legacy-cli/e2e/tests/build/library-with-demo-app.ts to use the new schematic? so that we actually have an e2e that tests the generated code.

alan-agius4 · 2025-01-09T09:08:31Z

packages/schematics/angular/collection.json

@@ -117,6 +117,12 @@
      "schema": "./library/schema.json",
      "description": "Generate a library project for Angular."
    },
+    "library-secondary-entrypoint": {


Add a reference to https://github.com/angular/angular-cli/blob/a8335cf950510eec70c77e541ca996431931b00f/packages/angular/cli/lib/config/workspace-schema.json#L162C1-L164C11 and

angular-cli/packages/angular/cli/BUILD.bazel

Line 75 in a8335cf

CLI_SCHEMA_DATA = [

alan-agius4 · 2025-01-09T09:11:28Z

packages/schematics/angular/secondary-entrypoint/schema.json

+        "$source": "projectName"
+      }
+    },
+    "entryFile": {


We probably can opt this option as I doubt it's actually used.

alan-agius4 · 2025-01-09T09:13:16Z

packages/schematics/angular/secondary-entrypoint/schema.json

+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the secondary entrypoint?"


Suggested change

"x-prompt": "What name would you like to use for the secondary entrypoint?"

"x-prompt": "What name would you like to use for the entrypoint?"

angular-robot bot added the detected: feature PR contains a feature commit label Oct 28, 2024

SanderElias approved these changes Oct 28, 2024

View reviewed changes

alan-agius4 added the needs: discussion On the agenda for team meeting to determine next steps label Oct 28, 2024

alan-agius4 self-assigned this Oct 28, 2024

This comment was marked as outdated.

Sign in to view

Jefiozie force-pushed the secondaryEntrypoint branch from acc6219 to 6d617b8 Compare November 4, 2024 13:32

This comment was marked as outdated.

Sign in to view

feat: add secondary entrypoint schematic

6392681

Jefiozie force-pushed the secondaryEntrypoint branch from 6d617b8 to 6392681 Compare November 10, 2024 18:42

This comment was marked as outdated.

Sign in to view

Merge branch 'angular:main' into secondaryEntrypoint

15c1b3d

This comment was marked as outdated.

Sign in to view

alan-agius4 requested changes Jan 9, 2025

View reviewed changes

alan-agius4 added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews target: minor This PR is targeted for the next minor release and removed needs: discussion On the agenda for team meeting to determine next steps labels Jan 9, 2025

alan-agius4 reviewed Jan 9, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add secondary entrypoint schematic #28723

feat: add secondary entrypoint schematic #28723

Jefiozie commented Oct 28, 2024 •

edited by alan-agius4

Loading

SanderElias left a comment

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

alan-agius4 left a comment

alan-agius4 Jan 9, 2025

alan-agius4 Jan 9, 2025

alan-agius4 Jan 9, 2025

alan-agius4 Jan 9, 2025

alan-agius4 Jan 9, 2025

alan-agius4 Jan 9, 2025

alan-agius4 Jan 9, 2025

alan-agius4 Jan 9, 2025

alan-agius4 Jan 9, 2025

alan-agius4 Jan 9, 2025

alan-agius4 Jan 9, 2025 •

edited

Loading

alan-agius4 Jan 9, 2025

alan-agius4 Jan 9, 2025

	"description": "Generate a secondary-entrypoint in a library project for Angular."
	"description": "Generate an entrypoint in an Angular library project."

	"description": "Creates a secondary entrypoint in a library project in a project.",
	"description": "Generate an entrypoint in an Angular library project.",

	"title": "Secondary Entrypoint Schema",
	"title": "Library Secondary Entrypoint Schema",

	"description": "The name of the library.",
	"description": "The name of the entrypoint to create.",

	"pattern": "^(?:@[a-zA-Z0-9-~][a-zA-Z0-9-._~]/)?[a-zA-Z0-9-~][a-zA-Z0-9-._~]$",
	"pattern": "^[a-zA-Z0-9-._~]+/?[a-zA-Z0-9-._~]+$",

	"x-prompt": "What name would you like to use for the secondary entrypoint?"
	"x-prompt": "What name would you like to use for the entrypoint?"

feat: add secondary entrypoint schematic #28723

Are you sure you want to change the base?

feat: add secondary entrypoint schematic #28723

Conversation

Jefiozie commented Oct 28, 2024 • edited by alan-agius4 Loading

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

SanderElias left a comment

Choose a reason for hiding this comment

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

alan-agius4 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alan-agius4 Jan 9, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jefiozie commented Oct 28, 2024 •

edited by alan-agius4

Loading

alan-agius4 Jan 9, 2025 •

edited

Loading