feat: add an option to number first page. (#114)

* feat: add an option to number first page. * test case * update README
hexojs · May 17, 2024 · 449d59c · 449d59c
1 parent bf9f3e2
commit 449d59c
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -8,49 +8,50 @@ Pagination utilities for [Hexo] generator plugins.
 
 ## Installation
 
-``` bash
+```bash
 $ npm install hexo-pagination --save
 ```
 
 ## Usage
 
 ### pagination(base, posts, [options])
 
-Option | Description | Default
---- | --- | ---
-`perPage` | Posts displayed per page | 10
-`format` | URL format | page/%d/
-`layout` | Layout. This value can be a string or an array. | ['archive', 'index']
-`data` | Extra data |
+| Option           | Description                                     | Default                |
+| ---------------- | ----------------------------------------------- | ---------------------- |
+| `perPage`        | Posts displayed per page                        | `10`                   |
+| `format`         | URL format                                      | `page/%d/`             |
+| `layout`         | Layout. This value can be a string or an array. | `['archive', 'index']` |
+| `data`           | Extra data                                      | `{}`                   |
+| `explicitPaging` | Number the first page. e.g. `page/1/index.html` | `false`                |
 
 For example:
 
-``` js
-var pagination = require('hexo-pagination');
+```js
+var pagination = require("hexo-pagination");
 
-pagination('/tags/hexo', [], {
+pagination("/tags/hexo", [], {
   perPage: 10,
-  format: 'page/%d/',
-  layout: ['archive', 'index'],
+  format: "page/%d/",
+  layout: ["archive", "index"],
   data: {
-    tag: 'hexo'
-  }
+    tag: "hexo",
+  },
 });
 ```
 
 This function returns an array containing objects with 3 properties: `path`, `layout`, `data`.
 
-Data | Description
---- | --- 
-`base` | Base URL
-`total` | Total pages
-`current` | Current page number
-`current_url` | Path of the current page (which equals to `path`)
-`posts` | The slice of posts for the current page
-`prev` | Previous page number
-`prev_link` | The path to the previous page
-`next` | Next page number
-`next_link` | The path to the next page
+| Data          | Description                                       |
+| ------------- | ------------------------------------------------- |
+| `base`        | Base URL                                          |
+| `total`       | Total pages                                       |
+| `current`     | Current page number                               |
+| `current_url` | Path of the current page (which equals to `path`) |
+| `posts`       | The slice of posts for the current page           |
+| `prev`        | Previous page number                              |
+| `prev_link`   | The path to the previous page                     |
+| `next`        | Next page number                                  |
+| `next_link`   | The path to the next page                         |
 
 ## License
 

diff --git a/lib/pagination.js b/lib/pagination.js
@@ -10,11 +10,12 @@ function pagination(base, posts, options = {}) {
 
   const { length } = posts;
 
-  const { format: _format, layout, data, perPage } = Object.assign({
+  const { format: _format, layout, data, perPage, explicitPaging } = Object.assign({
     format: 'page/%d/',
     layout: ['archive', 'index'],
     data: {},
-    perPage: 10
+    perPage: 10,
+    explicitPaging: false
   }, options);
 
   const total = perPage ? Math.ceil(length / perPage) : 1;
@@ -24,7 +25,12 @@ function pagination(base, posts, options = {}) {
   function formatURL(i) {
     if (urlCache.has(i)) return urlCache.get(i);
 
-    const url = i > 1 ? base + format(_format, i) : base;
+    let url;
+    if (!explicitPaging) {
+      url = i > 1 ? base + format(_format, i) : base;
+    } else {
+      url = base + format(_format, i);
+    }
     urlCache.set(i, url);
 
     return url;

diff --git a/test/index.js b/test/index.js
@@ -141,4 +141,15 @@ describe('pagination', () => {
       result[i].data.tag.should.eql('test');
     }
   });
+
+  it('explicitPaging', () => {
+    const result = pagination('/', posts, {
+      explicitPaging: true
+    });
+
+    for (let i = 0, len = result.length; i < len; i++) {
+      const pageNum = i + 1;
+      result[i].path.should.eql(`/page/${pageNum}/`);
+    }
+  });
 });