Skip to content

docs(@schematics/angular): correct directory and entryFile option descriptions - #34364

Merged
dgp1130 merged 3 commits into
angular:mainfrom
MeAkib:docs/schematic-option-descriptions
Oct 16, 2026
Merged

dgp1130 merged 3 commits into
angular:mainfrom
MeAkib:docs/schematic-option-descriptions

Conversation

@MeAkib

@MeAkib MeAkib commented Oct 15, 2026

Copy link
Copy Markdown
Contributor

The ng new directory option claimed the workspace is created in the current directory when the option is omitted, but a new directory named after the workspace is created instead. The library entryFile option described a path relative to the workspace root, but the value is a file name without the .ts extension that is placed in the library's src directory.

… descriptions

The `ng new` `directory` option claimed the workspace is created in the current
directory when the option is omitted, but a new directory named after the
workspace is created instead. The library `entryFile` option described a path
relative to the workspace root, but the value is a file name without the `.ts`
extension that is placed in the library's `src` directory.
@angular-robot angular-robot Bot added area: docs Related to the documentation area: @schematics/angular labels Oct 15, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the descriptions of schema properties in Angular schematics to clarify their behavior: entryFile in the library schema is now described as a file name without the .ts extension, and directory in the ng-new schema clarifies that a new directory is created if not specified. Feedback suggests removing the "format": "path" attribute from entryFile since it no longer represents a standard path, preventing potential issues with IDEs and GUI tools.

Comment thread packages/schematics/angular/library/schema.json
Comment thread packages/schematics/angular/library/schema.json Outdated
Comment thread packages/schematics/angular/ng-new/schema.json Outdated
@alan-agius4 alan-agius4 added the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Oct 16, 2026
@MeAkib
MeAkib requested a review from alan-agius4 October 16, 2026 09:26
@alan-agius4 alan-agius4 added target: patch This PR is targeted for the next patch release and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Oct 16, 2026

@alan-agius4 alan-agius4 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks

@alan-agius4 alan-agius4 added action: merge The PR is ready for merge by the caretaker merge: squash commits When the PR is merged, a squash and merge should be performed and removed merge: squash commits When the PR is merged, a squash and merge should be performed labels Oct 16, 2026
MeAkib and others added 2 commits October 16, 2026 09:31
… option descriptions

Co-authored-by: Alan Agius <alan.agius4@gmail.com>
… option descriptions

Co-authored-by: Alan Agius <alan.agius4@gmail.com>
@alan-agius4
alan-agius4 force-pushed the docs/schematic-option-descriptions branch from a4a19d1 to 8602c39 Compare October 16, 2026 09:32
@dgp1130
dgp1130 merged commit 0608ebf into angular:main Oct 16, 2026
39 checks passed
@dgp1130

dgp1130 commented Oct 16, 2026

Copy link
Copy Markdown
Collaborator

This PR was merged into the repository. The changes were merged into the following branches:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

action: merge The PR is ready for merge by the caretaker area: docs Related to the documentation area: @schematics/angular target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants