forked from angular/angular-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(aot): adding README and type checking.
Close angular#2527
- Loading branch information
1 parent
afb36e8
commit 8a5b265
Showing
8 changed files
with
311 additions
and
153 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Angular Ahead-of-Time Webpack Plugin | ||
|
||
Webpack plugin that AoT compiles your Angular components and modules. | ||
|
||
## Usage | ||
In your webpack config, add the following plugin and loader: | ||
|
||
```typescript | ||
import {AotPlugin} from '@ngtools/webpack' | ||
|
||
exports = { /* ... */ | ||
module: { | ||
rules: [ | ||
{ | ||
test: /\.ts$/, | ||
loader: '@ngtools/webpack', | ||
} | ||
] | ||
}, | ||
|
||
plugins: [ | ||
new AotPlugin({ | ||
tsConfigPath: 'path/to/tsconfig.json', | ||
entryModule: 'path/to/app.module#AppModule' | ||
}) | ||
] | ||
} | ||
``` | ||
|
||
The loader works with the webpack plugin to compile your TypeScript. It's important to include both, and to not include any other TypeScript compiler loader. | ||
|
||
## Options | ||
|
||
* `tsConfigPath`. The path to the `tsconfig.json` file. This is required. In your `tsconfig.json`, you can pass options to the Angular Compiler with `angularCompilerOptions`. | ||
* `basePath`. Optional. The root to use by the compiler to resolve file paths. By default, use the `tsConfigPath` root. | ||
* `entryModule`. Optional if specified in `angularCompilerOptions`. The path and classname of the main application module. This follows the format `path/to/file#ClassName`. | ||
* `mainPath`. Optional if `entryModule` is specified. The `main.ts` file containing the bootstrap code. The plugin will use AST to determine the `entryModule`. | ||
* `genDir`. Optional. The output directory of the offline compiler. The files created by the offline compiler will be in a virtual file system, but the import paths might change. This can also be specified in `angularCompilerOptions`, and by default will be the same as `basePath`. | ||
* `typeChecking`. Optional, defaults to true. Enable type checking through your application. This will slow down compilation, but show syntactic and semantic errors in webpack. |
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
Oops, something went wrong.