docs(installer): correct the stale @dignite/ng.flex-fields installation note - #60
Merged
Merged
Conversation
…on note AngularInstallationInfo.json told consumers the package is "Not published to npm" and must be consumed as a file: dependency pointing at the sibling repo's built output, with preserveSymlinks set in tsconfig and angular.json. Both halves are wrong now. The package reached public npmjs at rc.11/rc.13 and is a plain registry dependency of @dignite/ng.site, so it arrives transitively when a host installs the library - the same way ng-zorro-antd and @angular/cdk do, which the neighbouring notes already say. The preserveSymlinks half was never about this package. symlink-config.ps1 lists no @dignite scope at all - only the @angular/@abp/@volo set the ABP template ships with - and its $PackageDirectories is empty, so the setting in angular.json and tsconfig.prod.json serves that unrelated workflow. Replaced with what a consumer actually needs: that it installs with the library, and that it must resolve to exactly one copy, because FLEX_FIELD_TYPES is a module-scoped InjectionToken and a second copy silently unregisters every field type at runtime.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
AngularInstallationInfo.jsondescribed a way of consuming@dignite/ng.flex-fieldsthat no longerexists. Both halves of the note were wrong.
"Not published to npm. Consumed as a
file:dependency pointing at the sibling repo's builtoutput" — the package reached public npmjs at
rc.11/rc.13and is a plain registry dependencyof
@dignite/ng.site, so it arrives transitively when a host installs the library. That is exactlywhat the neighbouring
ng-zorro-antdand@angular/cdknotes already say about themselves."requires
preserveSymlinksin tsconfig and angular.json" — never true of this package.angular/scripts/symlink-config.ps1lists no@dignitescope at all (only the@angular/@abp/@voloset the ABP template ships with) and its$PackageDirectoriesis empty,so the setting in
angular.jsonandtsconfig.prod.jsonis inherited template configurationserving an unrelated workflow.
Replaced with what a consumer actually needs to know: that it installs with the library, and that it
must resolve to exactly one copy —
FLEX_FIELD_TYPESis a module-scopedInjectionToken, so asecond copy is a second DI key and every field type registered against one is invisible to the
resolver reading the other, absent at runtime with nothing failing at install or build time.
Documentation only — no code, no dependency, no behaviour change.
Dignite.Site.Installerbuildsclean (0 warnings, 0 errors) and the file's existing BOM is preserved.