Skip to content

Commit cbb3134

Browse files
committed
fix: remove confusing aws-export.js description
1 parent 79c0e69 commit cbb3134

File tree

1 file changed

+2
-12
lines changed
  • src/pages/gen1/[platform]/tools/cli/reference/files

1 file changed

+2
-12
lines changed

src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -117,25 +117,15 @@ Because one category might create multiple services within one project (e.g. the
117117

118118
The metadata for each service is first logged into the meta file after the `amplify <category> add` command is executed, containing some general information that indicates one service of the category has been added locally. Then, on the successful execution of the `amplify push` command, the `output` object will be added/updated in the service's metadata with information that describes the actual cloud resources that have been created or updated.
119119

120-
### aws-exports.js
121-
122-
> Manual edits okay: NO
123-
124-
> Add to version control: NO
125-
126-
This file is generated only for JavaScript projects. It contains the consolidated outputs from all the categories and is placed under the `src` directory specified during the `init` process. It is updated after `amplify push`.
127-
128-
This file is consumed by the [Amplify](https://github.com/aws-amplify/amplify-js) JavaScript library for configuration. It contains information which is non-sensitive and only required for external, unauthenticated actions from clients (such as user registration or sign-in flows in the case of Auth) or for constructing appropriate endpoint URLs after authorization has taken place.
129-
130120
### amplifyconfiguration.json
131121

132122
> Manual edits okay: NO
133123
134124
> Add to version control: NO
135125
136-
This file is generated by Amplify CLI for Swift and Android projects. It contains the consolidated outputs from all the categories and is updated after `amplify push`. It is consumed by the [Amplify Swift](https://github.com/aws-amplify/amplify-swift/) and [Amplify Android](https://github.com/aws-amplify/amplify-android) libraries for configuration.
126+
This file is generated by Amplify CLI for JavaScript or Typescript, Swift and Android projects. It contains the consolidated outputs from all the categories and is updated after `amplify push`. It is consumed by the [Amplify JS](https://github.com/aws-amplify/amplify-js), [Amplify Swift](https://github.com/aws-amplify/amplify-swift/) and [Amplify Android](https://github.com/aws-amplify/amplify-android) libraries for configuration.
137127

138-
Note: `amplifyconfiguration.json` is the equivalent of `aws-exports.js` generated for JavaScript projects.
128+
Note: You may also find a `aws-exports.js` file generated by Amplify CLI for JavaScript or Typescript projects. This file is generated for backward compatibility. It is recommended to use `amplifyconfiguration.json`. Same as the `amplifyconfiguration.json` file, you should not manually edit this file, or add it to version control.
139129

140130
### .gitignore
141131

0 commit comments

Comments
 (0)