Skip to content

Commit bc685ce

Browse files
authored
chore(core): nx plugin submission @aws/nx-plugin (#30545)
<!-- _[Please make sure you have read the submission guidelines before posting an PR](https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#submit-pr)_ # Community Plugin Submission Thanks for submitting your Nx Plugin to our community plugins list. Make sure to follow these steps to ensure that your PR is approved in a timely manner. ## Plugin Requirements Before you submit your plugin to be listed in our registry, it needs to meet the following requirements: - Run some kind of automated e2e tests in your repository - Include `@nx/devkit` as a `dependency` in the plugin's `package.json` - List a `repository.url` in the plugin's `package.json` i.e. ``` { "repository": { "type": "git", "url": "https://github.com/nrwl/nx.git", "directory": "packages/web" } } ``` Note: We reserve the right to remove unmaintained plugins from the registry. If the plugins become maintained again, they can be resubmitted to the registry. ## Steps to Submit Your Plugin - Use the following commit message template: `chore(core): nx plugin submission [PLUGIN_NAME]` - Update the `community/approved-plugins.json` file with a new entry for your plugin that includes `name`, `url`, `description`: Example: ```json // community/approved-plugins.json [{ "name": "@community/plugin", "url": "https://github.com/community/plugin", "description": "This plugin provides the following capabilities." }] ``` Once merged, your plugin will be available when running the `nx list` command, and will also be available in the Plugin Registry on [nx.dev](https://nx.dev/plugin-registry) --> # Community Plugin Submission ## Nx Plugin for AWS (@aws/nx-plugin) <!-- Describe what your plugin is and what is its goal or issues it addresses. If you don't provide a description, we will not merge your PR. Is it focused on a technology, tooling or behaviour? Does the plugin provide generators, executors or graph support? Do you know who is already using the plugin? Mention who is the author of the plugin. --> This plugin is for building cloud-native applications with AWS. At present it provides the following generators: - `ts#project` - Generate a new TypeScript library. - `ts#infra` - Generate a Typescript AWS CDK infrastructure project for your application. - `ts#cloudscape-website` - Generate a new Cloudscape/React/Vite based web application. - `ts#cloudscape-website#auth` - Add AWS Cognito authentication to your Cloudscape website. - `ts#trpc-api` - Generate a tRPC backend service with Amazon API Gateway/AWS Lambda integration and [AWS Powertools](https://github.com/aws-powertools/powertools-lambda-typescript) pre-configured. - `py#project` - Generate a uv based Python project. - `py#fast-api` - Generate a FastAPI backend service with [AWS Powertools](https://github.com/aws-powertools/powertools-lambda-python) pre-configured. - `api-connection` - Connect frontend applications to backend APIs. - `license` - Automatically manage LICENSE files and source code headers in your workspace. (Note that the ts/py project generators are our simplified/opinionated generators for base projects in TypeScript and Python, eg enforcing ESM for TypeScript etc) Our prototyping organisation here at AWS uses the plugin to quickly bootstrap and build prototypes for various AWS customers in different industries. The primary authors are Adrian Dimech @agdimech and myself (Jack Stevenson).
1 parent 5f3e946 commit bc685ce

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

community/approved-plugins.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -513,5 +513,10 @@
513513
"name": "nx-foundry",
514514
"description": "Foundry generators and inferred tasks for Nx",
515515
"url": "https://github.com/juliangsibecas/nx-foundry"
516+
},
517+
{
518+
"name": "@aws/nx-plugin",
519+
"description": "Nx Plugin for AWS: Accelerate building cloud-native applications with AWS",
520+
"url": "https://github.com/awslabs/nx-plugin-for-aws"
516521
}
517522
]

0 commit comments

Comments
 (0)