This repository has been archived by the owner on May 15, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
64 changed files
with
1,460 additions
and
3,767 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
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
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 |
---|---|---|
|
@@ -3,6 +3,14 @@ | |
All notable changes to this project will be documented in this file. | ||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. | ||
|
||
## [6.13.5](https://github.com/americanexpress/one-app-cli/compare/@americanexpress/[email protected]...@americanexpress/[email protected]) (2023-06-13) | ||
|
||
**Note:** Version bump only for package @americanexpress/eslint-plugin-one-app | ||
|
||
|
||
|
||
|
||
|
||
## [6.13.4](https://github.com/americanexpress/one-app-cli/compare/@americanexpress/[email protected]...@americanexpress/[email protected]) (2023-03-08) | ||
|
||
**Note:** Version bump only for package @americanexpress/eslint-plugin-one-app | ||
|
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 was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -1,57 +1,4 @@ | ||
# @americanexpress/generator-one-app-module | ||
|
||
> yeoman generator for a bare-bones [One App](https://github.com/americanexpress/one-app#modules) `holocron` Module | ||
# ***@americanexpress/generator-one-app-module is deprecated*** | ||
|
||
## 🤹 Usage | ||
|
||
Assuming you have [npx installed](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) (comes with `npm` on versions 5.2.0 and above): | ||
|
||
```bash | ||
npx -p yo -p @americanexpress/generator-one-app-module -- yo @americanexpress/one-app-module | ||
``` | ||
|
||
The generator will start up and prompt you with the following questions: | ||
- What is the name of your module? | ||
- Is this a [root module or child module](https://github.com/americanexpress/one-app/tree/main/docs/api#modules)? | ||
- Generate with [Parrot Middleware](https://github.com/americanexpress/parrot)? | ||
- Setup with [internationalization](https://github.com/americanexpress/one-app/blob/main/docs/api/modules/Internationalization.md)? | ||
|
||
#### Optional Flags | ||
##### --setupInternationalizationByDefault | ||
If you'd like to include internationalization in your module without being prompted, you can pass in the `--setupInternationalizationByDefault` flag. Your command will look as follows: | ||
``` | ||
yo @americanexpress/one-app-module --setupInternationalizationByDefault | ||
``` | ||
|
||
Alternatively, if you choose to compose `generator-one-app-module` with another generator, you can pass the `setupInternationalizationByDefault` value in an object as the second argument to the Yeoman `ComposeWith` function, like so: | ||
|
||
``` | ||
const CustomExtension = require.resolve('./path-to-custom-extension'); | ||
module.exports = class extends Generator { | ||
initializing() { | ||
this.composeWith(require.resolve('@americanexpress/generator-one-app-module/generators/app'), | ||
{ setupInternationalizationByDefault: true }); | ||
this.composeWith(CustomExtension); | ||
} | ||
}; | ||
``` | ||
|
||
Doing this, you're able to extend the `generator-one-app-module` generator, enable internationalization by default, and add additional prompts and logic in your custom extension. | ||
|
||
[More on composing generators here](https://yeoman.io/authoring/composability.html). | ||
|
||
|
||
### Bundling modules | ||
|
||
For more information about what happens after bundling your module, read [Bundling modules](./docs/Bundling-Modules.md) | ||
|
||
## 🏆 Contributing | ||
|
||
After making changes to the generator, test your changes locally: | ||
1. Install yeoman globally: `npm install --global yo` | ||
2. Link your local generator module so it is used instead of the repo version: `npm link` | ||
3. Switch to a temp directory and run: `yo @americanexpress/one-app-module` | ||
4. When you are done, unlink the local module : `npm unlink` | ||
|
||
Please see our [contributing guide](../../CONTRIBUTING.md) for more details. | ||
> Last relevant release [6.12.0](https://github.com/americanexpress/one-app-cli/releases/tag/v6.12.0) |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.