MOT & Support ESM

.eslintignore

@@ -1,5 +1 @@
-build/
-dist/
-node_modules/
-.snapshots/
-*.min.js
+dist

.eslintrc.json

@@ -0,0 +1,9 @@
+{
+  "extends": ["@etchteam"],
+  "rules": {
+    "@next/next/no-html-link-for-pages": ["error", "example/pages/"]
+  },
+  "env": {
+    "jest": true
+  }
+}

.github/mergify.yml

@@ -0,0 +1,26 @@
+---
+pull_request_rules:
+  - name: Automerge when checks pass and reviews are approved
+    conditions:
+      - and:
+          - author~=!^dependabot(|-preview)\[bot\]$
+          - label!=wontfix
+          - check-success=build
+          - check-success=test
+          - check-success=megalinter
+          - check-success=SonarCloud Code Analysis
+          - "#approved-reviews-by>=1"
+    actions:
+      merge:
+        method: merge
+  - name: Automerge security updates when checks pass
+    conditions:
+      - author~=^dependabot(|-preview)\[bot\]$
+      - label!=wontfix
+      - check-success=build
+      - check-success=test
+      - check-success=megalinter
+      - check-success=SonarCloud Code Analysis
+    actions:
+      merge:
+        method: merge

.github/semantic.yml

@@ -0,0 +1,9 @@
+---
+# Always validate the PR title AND all the commits
+titleAndCommits: true
+# Allows use of Merge commits (eg on github: "Merge branch 'main' into feature/ride-unicorns")
+# this is only relevant when using commitsOnly: true (or titleAndCommits: true)
+allowMergeCommits: true
+# Allow use of Revert commits (eg on github: "Revert "feat: ride unicorns"")
+# this is only relevant when using commitsOnly: true (or titleAndCommits: true)
+allowRevertCommits: true

.github/workflows/ci.yml

@@ -1,19 +1,38 @@
+---
 name: CI
-
 on:
-  push:
   pull_request:
-
+    branches:
+      - main
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+permissions:
+  contents: read
 jobs:
+  test:
+    strategy:
+      matrix:
+        version: [18, 20]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.version }}
+          cache: 'npm'
+      - run: npm ci
+      - run: npm test
   build:
+    strategy:
+      matrix:
+        version: [18, 20]
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - name: Setup node
-      uses: actions/setup-node@v3
-      with:
-        node-version: 16.18.1
-        cache: 'npm'
-    - run: npm ci --no-audit --prefer-offline
-    - run: npm run build
-    - run: npm test
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.version }}
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run build

.github/workflows/mega-linter.yml

@@ -0,0 +1,34 @@
+---
+name: MegaLinter
+on:
+  pull_request:
+    branches:
+      - main
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+permissions:
+  contents: read
+  pull-requests: write
+jobs:
+  megalinter:
+    name: MegaLinter
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm ci
+      - name: MegaLinter
+        uses: oxsecurity/megalinter/flavors/[email protected]
+        id: ml
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/publish.yml

@@ -0,0 +1,36 @@
+---
+name: 🚀 Publish
+on:
+  push:
+    branches:
+      - main
+env:
+  HUSKY: 0
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+jobs:
+  publish:
+    name: Publish
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm ci
+      - name: Build
+        run: npm run build
+      - name: Publish
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm run release

.gitignore

@@ -22,3 +22,5 @@ yarn-debug.log*
 yarn-error.log*
 
 .next
+
+megalinter-reports/

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit ${1}

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no -- lint-staged

.mega-linter.yml

@@ -0,0 +1,46 @@
+# Configuration file for MegaLinter
+#
+# See all available variables at https://megalinter.io/latest/config-file/ and in
+# linters documentation
+
+# all, none, or list of linter keys
+APPLY_FIXES: none
+
+# If you use ENABLE variable, all other languages/formats/tooling-formats will
+# be disabled by default
+# ENABLE:
+
+# If you use ENABLE_LINTERS variable, all other linters will be disabled by
+# default
+# ENABLE_LINTERS:
+
+DISABLE:
+  - COPYPASTE
+  - SPELL
+
+DISABLE_LINTERS:
+  # Disable scss-lint in favour of stylelint
+  - CSS_SCSS_LINT
+  # Disable standard style linters in favour of eslint
+  - JAVASCRIPT_STANDARD
+  - TYPESCRIPT_STANDARD
+  # Not needed in this repository
+  - REPOSITORY_TRIVY
+  # We have secret scanning enabled and set to block pushes with secrets
+  - REPOSITORY_GITLEAKS
+    # We use dependabot for vulnerability monitoring and patching
+  - REPOSITORY_GRYPE
+
+SHOW_ELAPSED_TIME: true
+
+FILEIO_REPORTER: false
+
+# Uncomment if you want MegaLinter to detect errors but not block CI to pass
+# DISABLE_ERRORS: true
+
+# Config paths
+CSS_STYLELINT_CONFIG_FILE: stylelint.config.js
+JAVASCRIPT_ES_CONFIG_FILE: .eslintrc.json
+
+# Override linter executables
+CSS_STYLELINT_CLI_EXECUTABLE: ['./node_modules/.bin/stylelint']

.nvmrc

@@ -1 +1 @@
-16.18.1
+20.11.0

.stylelintignore

@@ -0,0 +1,5 @@
+dist
+node_modules
+*.*
+!*.css
+!*.scss

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "editor.formatOnSave": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.fixAll.stylelint": "explicit"
+  },
+  "sonarlint.connectedMode.project": {
+    "connectionId": "etchteam",
+    "projectKey": "etchteam_next-pagination"
+  }
+}

LICENSE.md

@@ -0,0 +1,7 @@
+ISC License
+
+Copyright 2023 Etch Software Limited
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

README.md

@@ -27,7 +27,7 @@ npm install --save @etchteam/next-pagination
 This component is fairly self contained. You will need to pass the **total number of potential results** in order to calculate the number of pages to show.
 
 ```jsx
-import React, { Component } from 'react'
+import { Component } from 'react'
 
 import Pagination from '@etchteam/next-pagination'
 

commitlint.config.js

@@ -0,0 +1,5 @@
+const config = {
+  extends: ['@commitlint/config-conventional'],
+};
+
+export default config;

example/next.config.js

@@ -1,9 +1,6 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const withSourceMaps = require('@zeit/next-source-maps')()
+const isProd = (process.env.NODE_ENV || 'production') === 'production';
 
-const isProd = (process.env.NODE_ENV || 'production') === 'production'
-
-module.exports = withSourceMaps({
+module.exports = {
   assetPrefix: isProd ? '/next-pagination' : undefined,
-  basePath: isProd ? '/next-pagination' : undefined
-})
+  basePath: isProd ? '/next-pagination' : undefined,
+};