Skip to content

castleadmin/nx-plugins

Repository files navigation

NxPlugins

Monorepo for Nx plugins

nx-serverless-cdk is an Nx plugin for creating AWS CDK applications and construct libraries inside an Nx monorepo. It offers the possibility to test and debug infrastructure code and AWS Lambda functions locally. The plugin provides the full flexibility of the AWS CDK CLI and the local AWS SAM CLI commands. It aims to make the usage of these tools as easy as possible inside an Nx monorepo.

Plugin Commands

Lint a plugin

The lint command is used to lint a plugin with ESLint.

nx run <PluginName>:lint

Test a plugin

The test command is used to execute the test cases with Jest.

nx run <PluginName>:test

Add the --codeCoverage option to enable code coverage.

nx run <PluginName>:test --codeCoverage

Build a plugin

The build command is used to build a plugin with the TypeScript compiler.

nx run <PluginName>:build

Run the pre-commit checks

To run the pre-commit checks execute

npm run pre:commit

Publish a plugin

The publish command is used to publish a plugin to npm.

nx run <PluginName>:publish --ver <PluginVersion> --tag <PluginVersionTag>

Options:

  • --ver
    • Plugin version
  • --tag
    • Tag of the version (e.g. latest)

Run the Unix E2E tests

The e2e command is used to execute the Unix E2E tests with Jest.

nx run <PluginName>-unix-e2e:e2e

Add the --codeCoverage option to enable code coverage.

nx run <PluginName>-unix-e2e:e2e --codeCoverage

Note: The Unix E2E tests must be executed on a Unix system.

Run the Windows E2E tests

The e2e command is used to execute the Windows E2E tests with Jest.

nx run <PluginName>-windows-e2e:e2e

Add the --codeCoverage option to enable code coverage.

nx run <PluginName>-windows-e2e:e2e --codeCoverage

Note: The Windows E2E tests must be executed on a Windows system.

About

Monorepo for nx plugin development

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages