Create doc of prefer-collections-with-pagination

Author: utarwyn

eslint-plugin/README.md

@@ -65,9 +65,10 @@ to have more information about the integration.
 ⚠️ Configurations set to warn in.\
 ✅ Set in the `recommended` configuration.
 
-| Name                                                                           | Description                                   | ⚠️ |
-| :----------------------------------------------------------------------------- | :-------------------------------------------- | :- |
-| [no-multiple-access-dom-element](docs/rules/no-multiple-access-dom-element.md) | Disallow multiple access of same DOM element. | ✅  |
+| Name                                                                                   | Description                                   | ⚠️ |
+| :------------------------------------------------------------------------------------- | :-------------------------------------------- | :- |
+| [no-multiple-access-dom-element](docs/rules/no-multiple-access-dom-element.md)         | Disallow multiple access of same DOM element. | ✅  |
+| [prefer-collections-with-pagination](docs/rules/prefer-collections-with-pagination.md) | Prefer API collections with pagination        | ✅  |
 
 <!-- end auto-generated rules list -->
 

eslint-plugin/docs/rules/prefer-collections-with-pagination.md

@@ -0,0 +1,40 @@
+# Prefer API collections with pagination (`@ecocode/prefer-collections-with-pagination`)
+
+⚠️ This rule _warns_ in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
+
+## Rule details
+
+This rule aims to reduce the size and thus the network weight of API returns that may contain many elements. This rule
+is built for the NestJS framework but can work with a controller @Controller() and a decorated method @Get().
+
+## Examples
+
+Examples of **incorrect** code for this rule:
+
+```ts
+@Controller()
+class Test {
+    @Get()
+    public find(): Promise<string[]> {
+    }
+}
+```
+
+Examples of **correct** code for this rule:
+
+```ts
+interface Pagination {
+    items: string[];
+    currentPage: number;
+    totalPages: number;
+}
+
+@Controller()
+class Test {
+    @Get()
+    public find(): Promise<Pagination> {
+    }
+}
+```

eslint-plugin/lib/rules/prefer-collections-with-pagination.js

@@ -63,7 +63,7 @@ const rule = createRule({
   name: "prefer-collections-with-pagination",
   meta: {
     docs: {
-      description: "TODO",
+      description: "Prefer API collections with pagination",
       category: "eco-design",
       recommended: "warn",
     },