Drop node 8 support

.eslintignore

@@ -1,3 +1,4 @@
+# Created by .ignore support plugin (hsz.mobi)
 ### JetBrains template
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
@@ -9,9 +10,6 @@
 .idea/**/dictionaries
 .idea/**/shelf
 
-# AWS User-specific
-.idea/**/aws.xml
-
 # Generated files
 .idea/**/contentModel.xml
 
@@ -62,9 +60,6 @@ atlassian-ide-plugin.xml
 # Cursive Clojure plugin
 .idea/replstate.xml
 
-# SonarLint plugin
-.idea/sonarlint/
-
 # Crashlytics plugin (for Android Studio and IntelliJ)
 com_crashlytics_export_strings.xml
 crashlytics.properties
@@ -85,7 +80,6 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
-.pnpm-debug.log*
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
@@ -134,9 +128,6 @@ web_modules/
 # Optional eslint cache
 .eslintcache
 
-# Optional stylelint cache
-.stylelintcache
-
 # Microbundle cache
 .rpt2_cache/
 .rts2_cache_cjs/
@@ -152,12 +143,9 @@ web_modules/
 # Yarn Integrity file
 .yarn-integrity
 
-# dotenv environment variable files
+# dotenv environment variables file
 .env
-.env.development.local
-.env.test.local
-.env.production.local
-.env.local
+.env.test
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache
@@ -180,12 +168,6 @@ dist
 # vuepress build output
 .vuepress/dist
 
-# vuepress v2.x temp and cache directory
-.temp
-
-# Docusaurus cache and generated files
-.docusaurus
-
 # Serverless directories
 .serverless/
 
@@ -208,6 +190,9 @@ dist
 .yarn/install-state.gz
 .pnp.*
 
+## Custom project exclusions
+*.js
+!src/*
 
 .eslintrc.js
 

.github/workflows/build.yml

@@ -3,7 +3,7 @@ name: Build
 on:
   pull_request:
     branches:
-      - main
+      - next
 
 jobs:
 
@@ -16,14 +16,14 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
           # The Node.js version to configure
           node-version: ${{ matrix.node }}
       - name: Install dependencies
         run: npm ci
       - name: Lint
-        run: npm run lint:all
+        run: npm run lint
       - name: Test
         run: npm test
       - name: Build

.github/workflows/npmpublish.yml → .github/workflows/release.yml

@@ -4,11 +4,12 @@ on:
   push:
     branches:
       - 'main'
+      - 'next'
 
 jobs:
 
-  build:
-    name: Test and Build and Release new candidate
+  bump-version:
+    name: Version increment
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -18,13 +19,9 @@ jobs:
           node-version-file: '.nvmrc'
       - name: Install dependencies
         run: npm ci
-      - name: Lint
-        run: npm run lint:all
       - name: Test
         run: npm test
-      - name: Build
-        run: npm run build
-      - name: Semantic Release
+      - name: Release
         uses: cycjimmy/semantic-release-action@v3
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.huskyrc

@@ -0,0 +1,7 @@
+{
+  "hooks": {
+    "prepare-commit-msg": "exec < /dev/tty && git cz --hook || true",
+    "pre-commit": "npm run format -- --fix && npm run lint",
+    "pre-push":"npm test && npm run build"
+  }
+}

.lintstagedrc.json

@@ -1,5 +1,3 @@
 {
-  "*ts": [
-    "npm run lint -- --fix --"
-  ]
+  "*ts": ["npm run lint -- --fix --"]
 }

.prettierignore

@@ -1,5 +1,13 @@
-coverage
-dist
-gen
-node_modules
-test-reports
+# Created by .ignore support plugin (hsz.mobi)
+**/tests/fixtures/**/*
+**/tests/fixture-project/**/*
+**/dist
+**/coverage
+**/shared-fixtures
+**/.vscode
+**/.nyc_output
+**/.vs
+.github
+
+# Ignore CHANGELOG.md files to avoid issues with automated release job
+CHANGELOG.md

.prettierrc.json

@@ -0,0 +1,15 @@
+{
+  "arrowParens": "avoid",
+  "bracketSpacing": true,
+  "endOfLine": "lf",
+  "jsxBracketSameLine": false,
+  "jsxSingleQuote": false,
+  "printWidth": 80,
+  "proseWrap": "preserve",
+  "quoteProps": "as-needed",
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "useTabs": false
+}

CHANGELOG.md

@@ -0,0 +1,29 @@
+# [2.0.0](https://github.com/nhammond101/cloudfront-ip-ranges/compare/v1.0.1...v2.0.0) (2023-02-15)
+
+
+### Bug Fixes
+
+* **deps:** bump express dependencies ([9ca784d](https://github.com/nhammond101/cloudfront-ip-ranges/commit/9ca784dcd1e428e862a8a03632c867cd2402f8c3))
+* **deps:** update dependency chalk to v4.1.1 ([979aa8d](https://github.com/nhammond101/cloudfront-ip-ranges/commit/979aa8ded650f3026a0f6728de3a31d432654798))
+* **deps:** update dependency chalk to v4.1.1 ([b7fba7d](https://github.com/nhammond101/cloudfront-ip-ranges/commit/b7fba7d820930b8356f9220d1341111beffa10d9))
+* **deps:** update dependency chalk to v4.1.2 ([37ed375](https://github.com/nhammond101/cloudfront-ip-ranges/commit/37ed3751de2087412cd7397c63d9dacf373f60a1))
+* **deps:** update dependency chalk to v4.1.2 ([61f9416](https://github.com/nhammond101/cloudfront-ip-ranges/commit/61f9416dc67d30f5d80ba4a511619529ee0a77af))
+* **deps:** update dependency debug to v4.3.2 ([eeba573](https://github.com/nhammond101/cloudfront-ip-ranges/commit/eeba573081258eb6c5444c5cb05731dba506567f))
+* **deps:** update dependency debug to v4.3.2 ([cd22e4a](https://github.com/nhammond101/cloudfront-ip-ranges/commit/cd22e4a4826c663e92645d7f0e14791f922a8588))
+* **deps:** update dependency debug to v4.3.3 ([0b500a4](https://github.com/nhammond101/cloudfront-ip-ranges/commit/0b500a4f3f21909c0ca7bf0673f6f4f66ff542d2))
+* **deps:** update dependency debug to v4.3.3 ([3f28f86](https://github.com/nhammond101/cloudfront-ip-ranges/commit/3f28f8679058eee47452ba11c012499d512406e3))
+
+
+### Documentation
+
+* Demonstrate ES6 usage ([426dd07](https://github.com/nhammond101/cloudfront-ip-ranges/commit/426dd07894dd3bf19451f48f5bcbf4f4c5d5ca4c))
+
+
+### Features
+
+* v1.1.0 ([2ce059d](https://github.com/nhammond101/cloudfront-ip-ranges/commit/2ce059dc2ddb2060bdc8d3258441f93fea451b4e))
+
+
+### BREAKING CHANGES
+
+* Node 8 no longer supported

README.md

@@ -9,55 +9,68 @@ Get Cloudfront IPs for use in trust proxy configurations.
 
 This package will be updated if Cloudfront ever decides to change the endpoints for retrieving current IPs. We will most likely never see a breaking change for this package.
 
+_V2 drops support for Node v8_
+
 <br>
 <p align="center">
   <img width="460" src="https://github.com/nhammond101/cloudfront-ip-ranges/raw/main/README-image.png?raw=true">
 </p>
 
 ## Install
 
-Requires node `8` or newer.
+Requires node `10` or newer, but only [LTS](https://nodejs.org/en/about/releases/) are officially supported .
 
-    npm install --save cloudfront-ip-ranges
+```shell
+npm install --save cloudfront-ip-ranges
+```
 
 ## Usage
 
 For use in an Express environment please see [Express documentation on trust proxies](https://expressjs.com/en/guide/behind-proxies.html).
 
 It is recommended to use `setInterval` for updating the IP list periodically.
 
-#### Directly update trust proxies for an Express app
+### Directly update trust proxies for an Express app
+
+```javascript
+const cfIPranges = require('cloudfront-ip-ranges');
 
-    const cfIPranges = require('cloudfront-ip-ranges')
+cfIPranges.updateTrustProxy(app);
 
-    cfIPranges.updateTrustProxy(app)
-
-    setInterval(() => {
-      cfIPranges.updateTrustProxy(app)
-    }, 1000*60*60*12)
+setInterval(() => {
+  cfIPranges.updateTrustProxy(app);
+}, 1000 * 60 * 60 * 12);
+```
 
-#### Getting a list of IPs and updating trust proxies manually
+### Getting a list of IPs and updating trust proxies manually
 
 Useful if you need to list other proxies alongside the Cloudfront ones.
 
-    const cfIPranges = require('cloudfront-ip-ranges')
-
-    cfIPranges.updateIPs()
-      .then((ips) => {
-        app.set('trust proxy', ['loopback', ...ips])
-      })
+```javascript
+const cfIPranges = require('cloudfront-ip-ranges');
+
+cfIPranges.updateIPs().then((ips) => {
+  app.set('trust proxy', ['loopback', ...ips]);
+});
+```
+
+### ES6
+
+You can import the module like so:
+
+```javascript
+import {CloudfrontService} from "cloudfront-ip-ranges";
+
+new CloudfrontService().getIpRange().then( (ips)=> ...);
+```
 
 ## API
 
-Method | Info
------------- | -------------
-getIpRange | By default returns `Promise<string[]>`.
-updateTrustProxy | Takes an Express app instance as an argument. Returns `Promise<void>`.
+| Method           | Info                                                                   |
+| ---------------- | ---------------------------------------------------------------------- |
+| getIpRange       | By default returns `Promise<string[]>`.                                |
+| updateTrustProxy | Takes an Express app instance as an argument. Returns `Promise<void>`. |
 
 ## Changelog
 
-Version | Release notes
------------- | -------------
-0.1.2 | Dependency updates
-0.1.1 | Added local IP to trust proxy
-0.1.0 | Initial release.
+see [CHANGELOG.md](./CHANGELOG.md)

jest.config.js

@@ -1,27 +1,18 @@
 module.exports = {
   collectCoverage: false,
-  coverageReporters: [
-    "json-summary",
-    "lcov",
-    "text"
-  ],
-  moduleFileExtensions: [
-    "ts",
-    "tsx",
-    "js",
-    "json"
-  ],
-  preset: "ts-jest",
+  coverageReporters: ['json-summary', 'lcov', 'text'],
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'json'],
+  preset: 'ts-jest',
   reporters: [
-    "default",
+    'default',
     [
-      "jest-junit",
+      'jest-junit',
       {
-        output: "./test-reports/junit.xml"
-      }
-    ]
+        output: './test-reports/junit.xml',
+      },
+    ],
   ],
-  testRegex: "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
-  testEnvironment: "node",
-  verbose: true
+  testRegex: '(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$',
+  testEnvironment: 'node',
+  verbose: true,
 };