docs: add linked library story #6292
Merged
Conversation
This file contains 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
sumitarora
suggested changes
May 12, 2017
|
|
||
| ## The library needs to be AOT compatible | ||
|
|
||
| Angular CLI does static analysis even without the `--aot` flag in order to detect lazy-loader routes. |
| ## The library needs to be AOT compatible | ||
|
|
||
| Angular CLI does static analysis even without the `--aot` flag in order to detect lazy-loader routes. | ||
| If your library is not AOT compatible, you will likely get an static analysis error. |
There was a problem hiding this comment.
get a static analysis error.
|
|
||
| Angular libraries are usually built using TypeScript and thus require to be built before they | ||
| are published. | ||
| For simple cases a linked library might work even without a build step, but this is the exception |
| For simple cases a linked library might work even without a build step, but this is the exception | ||
| rather than the norm. | ||
|
|
||
| If a library is not being built using it's own build step, then it is being compiled by the |
|
|
||
| Angular libraries should list all `@angular/*` dependencies as | ||
| [Peer Dependencies](https://nodejs.org/en/blog/npm/peer-dependencies/). | ||
| This insures that, when modules asks for Angular, they all get the exact same module. |
There was a problem hiding this comment.
This ensures that, when modules ask for Angular,
| If a library lists `@angular/core` in `dependencies` instead of `peerDependencies` then it might | ||
| get a *different* Angular module instead, which will cause your application to break. | ||
|
|
||
| While developing a library however, you'll need to have all of your peer dependencies also installed |
|
|
||
| You should list all the peer dependencies that your library uses in `./tsconfig.json`, pointing | ||
| them at the local copy in the apps `node_modules` folder. | ||
| This ensures that your all will always load the local copies of the modules your library asks for. |
clydin
reviewed
May 12, 2017
| # Linked libraries | ||
|
|
||
| While working on a library, it is common to use [npm link](https://docs.npmjs.com/cli/link) to | ||
| have avoid reinstalling the library on every build. |
| "@angular/common": [ | ||
| "../node_modules/@angular/common" | ||
| ], | ||
| "@angular/compiler": [ |
There was a problem hiding this comment.
These could probably be simplified to just one:
"@angular/*": [
"../node_modules/@angular/*"
],
Works with tsc but would need to confirm it works with the CLI.
There was a problem hiding this comment.
Checked it and seems to be fine. Fixed.
sumitarora
previously approved these changes
May 15, 2017
hansl
previously requested changes
May 15, 2017
Blocked on angular#6276.
sumitarora
approved these changes
May 16, 2017
This was referenced May 22, 2017
dond2clouds
pushed a commit
to d2clouds/speedray-cli
that referenced
this pull request
Apr 23, 2018
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Blocked on #6276.
/cc @clydin