docs: update READMEs

Author: getlarge

README.md

@@ -18,6 +18,7 @@ This repository contains several helpful packages for NestJS that I have develop
 | [AMQP-Transport](./packages/amqp-transport/README.md)           | A NestJS microservice adapter around [AMQPlib] supporting exchanges. | [![npm](https://img.shields.io/npm/v/@getlarge/nestjs-tools-amqp-transport.svg?style=flat)](https://npmjs.org/package/@getlarge/nestjs-tools-amqp-transport)       |
 | [Async-Local-Storage](./packages/async-local-storage/README.md) | A NestJS module to track context with [AsyncLocalStorage].           | [![npm](https://img.shields.io/npm/v/@getlarge/nestjs-tools-async-local-storage?style=flat)](https://npmjs.org/package/@getlarge/nestjs-tools-async-local-storage) |
 | [Cluster](./packages/cluster/README.md)                         | A class to manage workers' lifecycle in a (Node.js) [cluster].       | [![npm](https://img.shields.io/npm/v/@getlarge/nestjs-tools-cluster?style=flat)](https://npmjs.org/package/@getlarge/nestjs-tools-cluster)                         |
+| [ESLint-Rules](./packages/eslint-rules/README.md)               | A set of ESLint rules for NestJS applications.                       | [![npm](https://img.shields.io/npm/v/@getlarge/nestjs-tools-eslint-rules?style=flat)](https://npmjs.org/package/@getlarge/nestjs-tools-eslint-rules)               |
 | [File-Storage](./packages/file-storage/README.md)               | A NestJS module supporting [FS], [S3] and [GCP] strategies.          | [![npm](https://img.shields.io/npm/v/@getlarge/nestjs-tools-file-storage?style=flat)](https://npmjs.org/package/@getlarge/nestjs-tools-file-storage)               |
 | [Lock](./packages/lock/README.md)                               | A NestJS module to provide a distributed lock for your application.  | [![npm](https://img.shields.io/npm/v/@getlarge/nestjs-tools-lock?style=flat)](https://npmjs.org/package/@getlarge/nestjs-tools-lock)                               |
 | [Fastify-Upload](./packages/fastify-upload/README.md)           | A NestJS module to provide file upload support for Fastify.          | [![npm](https://img.shields.io/npm/v/@getlarge/nestjs-tools-fastify-upload?style=flat)](https://npmjs.org/package/@getlarge/nestjs-tools-fastify-upload)           |

packages/amqp-transport/README.md

@@ -12,6 +12,12 @@ A custom AMQP strategy for Nest microservice transport, which extends NestJS AMQ
 
 By enabling exchanges you can broadcast messages to multiple queues, and by asserting reply queue you can ensure that reply queue with static name exists.
 
+## Installation
+
+```bash
+npm install --save @getlarge/nestjs-tools-amqp-transport
+```
+
 ## Example
 
 The integration tests contain an [example consumer](./test/dummy-consumer.controller.mock.ts) and [example producer](./test/dummy-producer.service.mock.ts) that demonstrate how to use this library.

packages/async-local-storage/README.md

@@ -8,7 +8,7 @@
 ## Installation
 
 ```bash
-$ npm install --save @getlarge/nestjs-tools-async-local-storage
+npm install --save @getlarge/nestjs-tools-async-local-storage
 ```
 
 ## Usage

packages/cluster/README.md

@@ -11,7 +11,7 @@ The `ClusterService` class is a wrapper around the native `cluster` module and p
 ## Installation
 
 ```bash
-$ npm install --save @getlarge/nestjs-tools-cluster
+npm install --save @getlarge/nestjs-tools-cluster
 ```
 
 ## Example

packages/eslint-rules/README.md

@@ -1,7 +1,29 @@
 # eslint-rules
 
-This library was generated with [Nx](https://nx.dev).
+[![npm][npm-image]][npm-url]
 
-## Running unit tests
+[npm-image]: https://img.shields.io/npm/v/@getlarge/nestjs-tools-eslint-rules.svg?style=flat
+[npm-url]: https://npmjs.org/package/@getlarge/nestjs-tools-eslint-rules
 
-Run `nx test eslint-rules` to execute the unit tests via [Jest](https://jestjs.io).
+This set of ESLint rules is provided to enforce a consistent patterns and practices across all NestJS projects.
+
+## Installation
+
+```bash
+npm install --save @getlarge/nestjs-tools-eslint-rules
+```
+
+## Usage
+
+### return-class-instance
+
+This rule enforces that all public Service methods return a class instance of the same return type.
+The purpose of this rule is to ensure you return class instances instead of plain objects, which is essentials when using the [`ClassSerializerInterceptor`](https://docs.nestjs.com/techniques/serialization#class-serializer-interceptor).
+
+```json
+{
+  "rules": {
+    "@getlarge/nestjs-tools-eslint-rules/return-class-instance": "error",
+  }
+}
+```

packages/eslint-rules/package.json

@@ -17,6 +17,9 @@
     "access": "public"
   },
   "dependencies": {},
+  "peerDependencies": {
+    "eslint": "7 || 8 || 9"
+  },
   "type": "commonjs",
   "main": "./src/index.js",
   "typings": "./src/index.d.ts"

packages/eslint-rules/src/lib/return-class-instance.ts

@@ -18,7 +18,7 @@
 import { ESLintUtils } from '@typescript-eslint/utils';
 
 // NOTE: The rule will be available in ESLint configs as "@nx/workspace/return-class-instance"
-export const RULE_NAME = 'return-class-instance';
+export const RULE_NAME = '@getlarge/nestjs-tools-eslint-rules/return-class-instance';
 
 const getTypeNameFromReturnType = (rawReturnType: string) => {
   return rawReturnType.replaceAll(/Promise<([^<>]*)>/g, '$1').replace(': ', '');

packages/fastify-upload/README.md

@@ -15,7 +15,7 @@ Read [this issue](https://github.com/getlarge/nestjs-tools/issues/71) to underst
 ## Installation
 
 ```bash
-$ npm install --save @getlarge/nestjs-tools-fastify-upload
+npm install --save @getlarge/nestjs-tools-fastify-upload
 ```
 
 ## Usage

packages/file-storage/README.md

@@ -16,7 +16,7 @@ Supoorted backends:
 ## Installation
 
 ```bash
-$ npm install --save @getlarge/nestjs-tools-file-storage
+npm install --save @getlarge/nestjs-tools-file-storage
 ```
 
 ## Example
@@ -122,7 +122,7 @@ The recommended approach is to setup [Application Default Credentials](https://c
 
 If, after upgrading, you get the following error:
 
-```
+```sh
 /usr/local/bin/node[57897]: ../src/node_http_parser.cc:517:static void node::(anonymous namespace)::Parser::Execute(const FunctionCallbackInfo<v8::Value> &): Assertion `parser->current_buffer_.IsEmpty()' failed.
 ```
 

packages/lock/README.md

@@ -11,7 +11,7 @@ It is based on [Redlock](https://www.npmjs.com/package/redlock) module.
 ## Installation
 
 ```bash
-$ npm install --save @getlarge/nestjs-tools-lock
+npm install --save @getlarge/nestjs-tools-lock
 ```
 
 ## Usage