Skip to content

Commit 809340a

Browse files
authored
refactor(@angular/cli): rename config file from angular-cli.json to .angular-cli.json (#4681)
BREAKING CHANGE: The configuration file angular-cli.json has been renamed to .angular-cli.json
1 parent 9db71d8 commit 809340a

46 files changed

Lines changed: 266 additions & 54 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/design/docker-deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ If an `env` name is provided, other than "default", generate compose files with
9797

9898
If `--use-image == false` and the selected machine for the environment is a Docker Swarm machine, warn the user. Docker Swarm clusters cannot use the `build:` option in compose, since the resulting built image will not be distributed to other nodes. Swarm requires using the `image:` option in compose, pushing the image to a registry beforehand so that the Swarm nodes have a place to pull the image from (see [Swarm Limitations](https://docs.docker.com/compose/swarm/#building-images)).
9999

100-
Certain configuration values will be stored in the project's ngConfig `angular-cli.json` for use with other docker commands (ie. deploy, logs, exec). See also: [Saved State](#saved-state) section.
100+
Certain configuration values will be stored in the project's ngConfig `.angular-cli.json` for use with other docker commands (ie. deploy, logs, exec). See also: [Saved State](#saved-state) section.
101101

102102
Provide instructions on what the user can do after initialization completes (push, deploy).
103103

docs/design/ngConfig.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ Since the data is static, we only need to keep it in a static store somewhere.
1616

1717
One solution would be to keep the data in the `package.json`. Unfortunately, the metadata contains too much data and the `package.json` file would become unmanageable.
1818

19-
Instead of polluting the package file, a `angular-cli.json` file will be created that contains all the values. Access to that file will be allowed to the user if he knows the structure of the file (unknown keys will be kept but ignored), and it's easy to read and write.
19+
Instead of polluting the package file, a `.angular-cli.json` file will be created that contains all the values. Access to that file will be allowed to the user if he knows the structure of the file (unknown keys will be kept but ignored), and it's easy to read and write.
2020

2121

2222
## Fallback
2323

24-
There should be two `angular-cli.json` files; one for the project and a general one. The general one should contain information that can be useful when scaffolding new apps, or informations about the user.
24+
There should be two `.angular-cli.json` files; one for the project and a general one. The general one should contain information that can be useful when scaffolding new apps, or informations about the user.
2525

26-
The project `angular-cli.json` goes into the project root. The global configuration should live at `$HOME/.angular-cli.json`.
26+
The project `.angular-cli.json` goes into the project root. The global configuration should live at `$HOME/.angular-cli.json`.
2727

2828
## Structure
2929

docs/documentation/build.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The build artifacts will be stored in the `dist/` directory.
1919
environment file to be used with that build (`--environment=dev` or `--environment=prod`).
2020
By default, the development build target and environment are used.
2121

22-
The mapping used to determine which environment file is used can be found in `angular-cli.json`:
22+
The mapping used to determine which environment file is used can be found in `.angular-cli.json`:
2323

2424
```json
2525
"environments": {
@@ -46,7 +46,7 @@ ng build
4646

4747
You can also add your own env files other than `dev` and `prod` by doing the following:
4848
- create a `src/environments/environment.NAME.ts`
49-
- add `{ "NAME": 'src/environments/environment.NAME.ts' }` to the `apps[0].environments` object in `angular-cli.json`
49+
- add `{ "NAME": 'src/environments/environment.NAME.ts' }` to the `apps[0].environments` object in `.angular-cli.json`
5050
- use them via the `--env=NAME` flag on the build/serve commands.
5151

5252
### Base tag handling in index.html

docs/documentation/e2e.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ng e2e
1414
End-to-end tests are run via [Protractor](https://angular.github.io/protractor/).
1515

1616
## Options
17-
`--config` (`-c`) use a specific config file. Defaults to the protractor config file in `angular-cli.json`.
17+
`--config` (`-c`) use a specific config file. Defaults to the protractor config file in `.angular-cli.json`.
1818

1919
`--specs` (`-sp`) override specs in the protractor config.
2020
Can send in multiple specs by repeating flag (`ng e2e --specs=spec1.ts --specs=spec2.ts`).

docs/documentation/stories/asset-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Project assets
22

3-
You use the `assets` array in `angular-cli.json` to list files or folders you want to copy as-is
3+
You use the `assets` array in `.angular-cli.json` to list files or folders you want to copy as-is
44
when building your project.
55

66
By default, the `src/assets/` folder and `src/favicon.ico` are copied over.

docs/documentation/stories/global-lib.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Some javascript libraries need to be added to the global scope, and loaded as if
44
they were in a script tag. We can do this using the `apps[0].scripts` and
5-
`apps[0].styles` properties of `angular-cli.json`.
5+
`apps[0].styles` properties of `.angular-cli.json`.
66

77
As an example, to use [Bootstrap 4](http://v4-alpha.getbootstrap.com/) this is
88
what you need to do:

docs/documentation/stories/global-scripts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Global styles
22

33
You can add Javascript files to the global scope via the `apps[0].scripts`
4-
property in `angular-cli.json`.
4+
property in `.angular-cli.json`.
55
These will be loaded exactly as if you had added them in a `<script>` tag inside `index.html`.
66

77
This is especially useful for legacy libraries or analytic snippets.

docs/documentation/stories/global-styles.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The `styles.css` file allows users to add global styles and supports
66
If the project is created with the `--style=sass` option, this will be a `.sass`
77
file instead, and the same applies to `scss/less/styl`.
88

9-
You can add more global styles via the `apps[0].styles` property in `angular-cli.json`.
9+
You can add more global styles via the `apps[0].styles` property in `.angular-cli.json`.
1010
These will be loaded exactly as if you had added them in a `<link>` tag inside `index.html`.
1111

1212
```json
@@ -25,4 +25,4 @@ You can also rename the output and lazy load it by using the object format:
2525
{ "input": "lazy-style.scss", "lazy": true },
2626
{ "input": "pre-rename-style.scss", "output": "renamed-style" },
2727
],
28-
```
28+
```

docs/documentation/stories/include-bootstrap.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ npm install bootstrap@next --save
3333

3434
Now that the project is set up it must be configured to include the bootstrap CSS.
3535

36-
- Open the file `angular-cli.json` from the root of your project.
36+
- Open the file `.angular-cli.json` from the root of your project.
3737
- Under the property `apps` the first item in that array is the default application.
3838
- There is a property `styles` which allows external global styles to be applied to your application.
3939
- Specify the path to `bootstrap.min.css`
@@ -46,7 +46,7 @@ Now that the project is set up it must be configured to include the bootstrap CS
4646
],
4747
```
4848

49-
**Note:** When you make changes to `angular-cli.json` you will need to re-start `ng serve` to pick up configuration changes.
49+
**Note:** When you make changes to `.angular-cli.json` you will need to re-start `ng serve` to pick up configuration changes.
5050

5151
### Testing Project
5252

docs/documentation/stories/include-font-awesome.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ npm install --save font-awesome
1616

1717
To add Font Awesome CSS icons to your app...
1818
```json
19-
// in angular-cli.json
19+
// in .angular-cli.json
2020

2121
"styles": [
2222
"styles.css",

0 commit comments

Comments
 (0)