Elgato_dark/angular
1
0
Fork 0
mirror of https://github.com/angular/angular synced 2026-05-24 09:28:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: move angular-compiler-options tsconfig snippets to external file (#43545)

Browse source 
Moving angular-compiler-options docs inline code to external file of tsconfig.json and tsconfig.app.json.

closes #43336

PR Close #43545
This commit is contained in:
iRealNirmal 2021-09-23 12:44:24 +05:30 committed by Dylan Hunn
parent dbfb2d20b3
commit e5c3017df3
15 changed files with 218 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.pullapprove.yml
View file

@ -237,6 +237,7 @@ groups:
contains_any_globs(files.exclude('packages/compiler-cli/ngcc/**'), [
'packages/compiler/**',
'packages/examples/compiler/**',
'aio/content/examples/angular-compiler-options/**',
'packages/compiler-cli/**',
'aio/content/guide/angular-compiler-options.md',
'aio/content/guide/aot-compiler.md',

4
aio/content/examples/.gitignore vendored
View file

@ -99,3 +99,7 @@ upgrade-phonecat-3-final/rollup-config.js
# schematics
!schematics-for-libraries/projects/my-lib/package.json
#angular-compiler-options
!angular-compiler-options/tsconfig.json
!angular-compiler-options/tsconfig.app.json

20
aio/content/examples/angular-compiler-options/e2e/src/app.e2e-spec.ts Normal file
View file

@ -0,0 +1,20 @@
import { AppPage } from './app.po';
import { browser, logging } from 'protractor';
describe('workspace-project App', () => {
let page: AppPage;
beforeEach(() => {
page = new AppPage();
});
// Add your e2e tests here
afterEach(async () => {
// Assert that there are no errors emitted from the browser
const logs = await browser.manage().logs().get(logging.Type.BROWSER);
expect(logs).not.toContain(jasmine.objectContaining({
level: logging.Level.SEVERE,
} as logging.Entry));
});
});

19
aio/content/examples/angular-compiler-options/example-config.json Normal file
View file

@ -0,0 +1,19 @@
{
"projectType": "cli",
"overrideBoilerplate": [
"tsconfig.json",
"tsconfig.app.json"
],
"tests": [
{
"cmd": "yarn",
"args": [
"e2e",
"--protractor-config=e2e/protractor-puppeteer.conf.js",
"--no-webdriver-update",
"--port={PORT}"
]
}
]
}

0
aio/content/examples/angular-compiler-options/src/app/app.component.css Normal file
View file

1
aio/content/examples/angular-compiler-options/src/app/app.component.html Normal file
View file

@ -0,0 +1 @@
<h1>Replace the src folder in this {{title}} with yours.</h1>

20
aio/content/examples/angular-compiler-options/src/app/app.component.spec.ts Normal file
View file

@ -0,0 +1,20 @@
import { TestBed } from '@angular/core/testing';
import { AppComponent } from './app.component';
describe('AppComponent', () => {
beforeEach(async () => {
await TestBed.configureTestingModule({
declarations: [
AppComponent
],
}).compileComponents();
});
it('should create the app', () => {
const fixture = TestBed.createComponent(AppComponent);
const app = fixture.componentInstance;
expect(app).toBeTruthy();
});
// Add your unit tests here
});

10
aio/content/examples/angular-compiler-options/src/app/app.component.ts Normal file
View file

@ -0,0 +1,10 @@
import { Component } from '@angular/core';
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css'],
})
export class AppComponent {
title = 'example';
}

16
aio/content/examples/angular-compiler-options/src/app/app.module.ts Normal file
View file

@ -0,0 +1,16 @@
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }

13
aio/content/examples/angular-compiler-options/src/index.html Normal file
View file

@ -0,0 +1,13 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Ponyracer</title>
<base href="/">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="favicon.ico">
</head>
<body>
<app-root></app-root>
</body>
</html>

12
aio/content/examples/angular-compiler-options/src/main.ts Normal file
View file

@ -0,0 +1,12 @@
import { enableProdMode } from '@angular/core';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { AppModule } from './app/app.module';
import { environment } from './environments/environment';
if (environment.production) {
enableProdMode();
}
platformBrowserDynamic().bootstrapModule(AppModule)
.catch(err => console.error(err));

18
aio/content/examples/angular-compiler-options/stackblitz.json Normal file
View file

@ -0,0 +1,18 @@
{
"description": "Angular Compiler Options",
"files": [
"!**/*.d.ts",
"!**/*.js",
"!**/*.[1,2].*",
"!doc-files/**/*",
"!tsconfig.json",
"!tsconfig.app.json"
],
"tags": [
[
"angular",
"compiler",
"options"
]
]
}

45
aio/content/examples/angular-compiler-options/tsconfig.app.json Normal file
View file

@ -0,0 +1,45 @@
// #docplaster ...
/* To learn more about this file see: https://angular.io/config/tsconfig. */
// #docregion angular-compiler-options-app
{
"extends": "./tsconfig.json",
"compilerOptions": {
"outDir": "./out-tsc/app",
// #enddocregion angular-compiler-options-app
"types": []
},
"files": [
"src/main.ts",
"src/polyfills.ts"
],
"include": [
"src/**/*.d.ts"
],
"exclude": [
"src/test.ts",
"src/**/*.spec.ts",
"src/**/*-specs.ts",
"src/**/*.avoid.ts",
"src/**/*.0.ts",
"src/**/*.1.ts",
"src/**/*.1b.ts",
"src/**/*.2.ts",
"src/**/*.3.ts",
"src/**/*.4.ts",
"src/**/*.5.ts",
"src/**/*.6.ts",
"src/**/*.7.ts",
"src/**/testing"
],
// #docregion angular-compiler-options-app
"angularCompilerOptions": {
"strictTemplates": true,
"preserveWhitespaces": true,
// #enddocregion angular-compiler-options-app
"sourceMap": true,
"declaration": false
// #docregion angular-compiler-options-app
},
}
// #enddocregion angular-compiler-options-app

37
aio/content/examples/angular-compiler-options/tsconfig.json Normal file
View file

@ -0,0 +1,37 @@
// #docplaster ...
/* To learn more about this file see: https://angular.io/config/tsconfig. */
// #docregion angular-compiler-options
{
"compileOnSave": false,
"compilerOptions": {
"baseUrl": "./",
// #enddocregion angular-compiler-options
"outDir": "./dist/out-tsc",
"forceConsistentCasingInFileNames": true,
"strict": true,
"noImplicitReturns": true,
"noFallthroughCasesInSwitch": true,
"sourceMap": true,
"declaration": false,
"downlevelIteration": true,
"experimentalDecorators": true,
"moduleResolution": "node",
"importHelpers": true,
"target": "es2017",
"module": "es2020",
"lib": [
"es2018",
"dom"
]
// #docregion angular-compiler-options
},
"angularCompilerOptions": {
"enableI18nLegacyMessageIdFormat": false,
"strictInjectionParameters": true,
// #enddocregion angular-compiler-options
"strictInputAccessModifiers": true,
"strictTemplates": true
// #docregion angular-compiler-options
}
}
// #enddocregion angular-compiler-options

33
aio/content/guide/angular-compiler-options.md
View file

@ -4,21 +4,7 @@ When you use [AOT compilation](guide/aot-compiler), you can control how your app
The template options object, `angularCompilerOptions`, is a sibling to the `compilerOptions` object that supplies standard options to the TypeScript compiler.
<code-example language="json">
{
"compilerOptions": {
"experimentalDecorators": true,
...
},
"angularCompilerOptions": {
"fullTemplateTypeCheck": true,
"preserveWhitespaces": true,
...
}
}
</code-example>
<code-example language="json" header="tsconfig.json" path="angular-compiler-options/tsconfig.json" region="angular-compiler-options"></code-example>
{@a tsconfig-extends}
@ -32,22 +18,7 @@ The configuration options from the base file are loaded first, then overridden b
For example:
<code-example language="json">
{
"extends": "../tsconfig.json",
"compilerOptions": {
"experimentalDecorators": true,
...
},
"angularCompilerOptions": {
"fullTemplateTypeCheck": true,
"preserveWhitespaces": true,
...
}
}
</code-example>
<code-example language="json" header="tsconfig.app.json" path="angular-compiler-options/tsconfig.app.json" region="angular-compiler-options-app"></code-example>
For more information, see the [TypeScript Handbook](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html).