Skip to content

Commit 9c2d0d0

Browse files
jbogarthydekara
authored andcommitted
docs: edit file structure page (angular#26552)
PR Close angular#26552
1 parent 64647af commit 9c2d0d0

File tree

1 file changed

+8
-21
lines changed

1 file changed

+8
-21
lines changed

aio/content/guide/file-structure.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,15 @@ The top level of the workspace contains a number of workspace-wide configuration
2020
| :--------------------- | :------------------------------------------|
2121
| `.editorconfig` | Configuration for code editors. See [EditorConfig](https://editorconfig.org/). |
2222
| `.gitignore` | Specifies intentionally untracked files that [Git](https://git-scm.com/) should ignore. |
23-
| `angular.json` | CLI configuration for all projects in the workspace, including configuration options for build, serve, and test tools that the CLI uses, such as [Karma](https://karma-runner.github.io/) and [Protractor](http://www.protractortest.org/). |
23+
| `angular.json` | CLI configuration defaults for all projects in the workspace, including configuration options for build, serve, and test tools that the CLI uses, such as [TSLint](https://palantir.github.io/tslint/), [Karma](https://karma-runner.github.io/), and [Protractor](http://www.protractortest.org/). For details, see [Angular Workspace Configuration](guide/workspace-config). |
2424
| `node_modules` | Provides [npm packages](guide/npm-packages) to the entire workspace. |
25-
| `package.json` | Lists package dependencies. See [npm documentation](https://docs.npmjs.com/files/package.json) for the specific format and contents of this file.|
26-
| `tsconfig.app.json` | Default [TypeScript](https://www.typescriptlang.org/) configuration for apps in the workspace. |
27-
| `tsconfig.spec.json` | Default TypeScript configuration for e2e test apps in the workspace. |
28-
| `tslint.json` | Default [TSLint](https://palantir.github.io/tslint/) configuration for apps in the workspace. |
29-
| `README.md` | Introductory documentation. |
25+
| `package.json` | Configures [npm package dependencies](guide/npm-packages) that are available to all projects in the workspace. See [npm documentation](https://docs.npmjs.com/files/package.json) for the specific format and contents of this file. |
3026
| `package-lock.json` | Provides version information for all packages installed into `node_modules` by the npm client. See [npm documentation](https://docs.npmjs.com/files/package-lock.json) for details. If you use the yarn client, this file will be [yarn.lock](https://yarnpkg.com/lang/en/docs/yarn-lock/) instead. |
27+
| `tsconfig.json` | Default [TypeScript](https://www.typescriptlang.org/) configuration for apps in the workspace, including TypeScript and Angular template compiler options. See [TypeScript Configuration](guide/typescript-configuration). |
28+
| `tslint.json` | Default [TSLint](https://palantir.github.io/tslint/) configuration for apps in the workspace. |
29+
| `README.md` | Introductory documentation. |
3130

32-
All projects within a workspace share this configuration context.
31+
All projects within a workspace share a [CLI configuration context](guide/workspace-config).
3332
Project-specific [TypeScript](https://www.typescriptlang.org/) configuration files inherit from the workspace-wide `tsconfig.*.json`, and app-specific [TSLint](https://palantir.github.io/tslint/) configuration files inherit from the workspace-wide `tslint.json`.
3433

3534
### Default app project files
@@ -40,9 +39,9 @@ This initial app is the *default app* for CLI commands (unless you change the de
4039
A newly generated app contains the source files for a root module, with a root component and template.
4140
When the workspace file structure is in place, you can use the `ng generate` command on the command line to add functionality and data to the initial app.
4241

43-
<div class="alert is-helpful>
42+
<div class="alert is-helpful">
4443

45-
Besides using the CLI on the command line, You can also use an interactive development environment like [Angular Console](https://angular.console.com), or manipulate files directly in the app's source folder and configuration files.
44+
Besides using the CLI on the command line, you can also use an interactive development environment like [Angular Console](https://angular.console.com), or manipulate files directly in the app's source folder and configuration files.
4645

4746
</div>
4847

@@ -104,18 +103,6 @@ my-app/
104103

105104
Inside the `src/` folder, the `app/` folder contains your app's logic and data. Angular components, templates, and styles go here. An `assets/` subfolder contains images and anything else your app needs. Files at the top level of `src/` support testing and running your app.
106105

107-
<code-example language="none" linenums="false">
108-
src/
109-
app/
110-
app.component.css
111-
app.component.html
112-
app.component.spec.ts
113-
app.component.ts
114-
app.module.ts
115-
assets/...
116-
...
117-
</code-example>
118-
119106
| APP SOURCE FILES | PURPOSE |
120107
| :-------------------------- | :------------------------------------------|
121108
| `app/app.component.ts` | Defines the logic for the app's root component, named `AppComponent`. The view associated with this root component becomes the root of the [view hierarchy](guide/glossary#view-hierarchy) as you add components and services to your app. |

0 commit comments

Comments
 (0)