npmpackage.info

@ns3/nx-serverless

5.6.0

MIT

TypeScript

28.92 kB

Installations

npm install @ns3/nx-serverless

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=16.6.0

Node Version

20.18.0

NPM Version

10.8.2 Pull Requests

Open

0

Total

74

Closed

9

Merged

65

Issues

Open

4

Total

38

Closed

34

Releases

v5.6.0

Updated on Oct 23, 2024

v5.5.0

Updated on Oct 10, 2024

v5.4.0

Updated on Sep 05, 2024

v5.3.0

Updated on Jul 03, 2024

v5.2.0

Updated on Feb 08, 2024

v5.1.0

Updated on Dec 19, 2023

View All 87 releases

Contributors

Unable to fetch Contributors

View All 8 Contributors

Languages

TypeScript

JavaScript

Shell

TypeScript (99.37%)

JavaScript (0.32%)

Shell (0.31%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

Bielik20

Download Statistics

Total Downloads

1,361,384

Last Day

937

Last Week

4,786

Last Month

19,849

Last Year

461,905

GitHub Statistics

MIT License

62 Stars

314 Commits

22 Forks

6 Watchers

1 Branches

8 Contributors

Updated on Jan 12, 2025

Bundle Size

96.39 kB

Minified

28.92 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

5.6.0

Package Id

@ns3/nx-serverless@5.6.0

Unpacked Size

75.80 kB

Size

20.80 kB

File Count

NPM Version

10.8.2

Node Version

20.18.0

Published on

Oct 23, 2024

Total Downloads

Cumulative downloads

Total Downloads

1,361,384

Last Day

10.8%

937

Compared to previous day

Last Week

11.7%

4,786

Compared to previous week

Last Month

23.7%

19,849

Compared to previous month

Last Year

-31.8%

461,905

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@ns3/nx-core fs-extra bestzip glob execa @nx/devkit @nx/jest tslib dotenv webpack @nx/eslint @nx/webpack

NX Serverless

A simple plugin for running sls commands in nx monorepo. It executes serverless commands in specific app directory. It is configured to support nx cache out of the box for build and deploy commands.

Install

npm i -D @ns3/nx-serverless

Generate

`serverless-esbuild`

Default plugin used in generation is serverless-esbuild. It supports all providers, nx cache as far as output of serverless is concerned, but it doesn't work with incremental builds.

nx generate @ns3/nx-serverless:app my-app-name

`@ns3/nx-serverless/plugin`

⚠️ Warning: this plugin is experimental and can change without major version bump.

You can opt in to use experimental @ns3/nx-serverless/plugin. It supports only aws as a provider, but works both with nx cache and incremental build. It uses @nx/webpack:webpack executor to compile the code and is independent of serverless framework. To achieve that it uses withPatterns plugin to find which files to compile. It means that you need to create and follow file naming pattern for your handlers. The default one is './src/handlers/**/handler.ts' You can use withExternals plugin to exclude certain dependencies from the bundle (default /^@aws-sdk\// excludes aws sdk in v3).

nx generate @ns3/nx-serverless:app my-app-name --plugin @ns3/nx-serverless/plugin

Rationale: making build step independent of serverless framework allows us to cache build process. This means that changing serverless config won't trigger rebuild of the whole app. It makes it also easy to replace webpack with other bundler like rspack etc.

Webpack Alternative

If you want to use executor for build other than @nx/webpack you can. The only requirement is for build executor to have outputPath option defined and support for --watch flag. Of course, you will have to provide equivalent of withPatterns and withExternals plugins.

Available commands

nx run my-app-name:package
nx run my-app-name:serve
nx run my-app-name:deploy
nx run my-app-name:remove
nx run my-app-name:lint
nx run my-app-name:test

Stage

To control Serverless stage param you can use

⚠️ Flag

--stage flag, but that won't get forwarded to dependant tasks.

1nx run my-app-name:deploy --stage my-stage

✅ Env Variable

STAGE env variable, package and deploy targets are configured to take it into account. As a bonus you can use it later to also configure e2e tests for your service etc.

1STAGE=my-stage nx run my-app-name:deploy

Custom commands

Should you need a more specific command that is not included you can run it like:

nx run my-app-name:sls logs
nx run my-app-name:sls invoke local

All arguments are forwarded. If there is an argument that conflicts with Nx or this executor simply suffix it with _. For example:

instead of --help
use --help_

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3

/10

Last Scanned on 2025-02-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More