prettier

haraka · Apr 18, 2024 · 94fc12a · 94fc12a
1 parent 1b5a7e2
commit 94fc12a
Show file tree

Hide file tree

Showing 12 changed files with 1,186 additions and 1,157 deletions.
diff --git a/.codeclimate.yml b/.codeclimate.yml
@@ -1,13 +1,13 @@
 engines:
   eslint:
     enabled: true
-    channel: "eslint-8"
+    channel: 'eslint-8'
     config:
-      config: ".eslintrc.yaml"
+      config: '.eslintrc.yaml'
 
 ratings:
-   paths:
-   - "**.js"
+  paths:
+    - '**.js'
 
 checks:
   return-statements:

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,10 +1,10 @@
 version: 2
 updates:
-  - package-ecosystem: "npm"
+  - package-ecosystem: 'npm'
     # Look for `package.json` and `lock` files in the `root` directory
-    directory: "/"
+    directory: '/'
     # Check the npm registry for updates every day (weekdays)
     schedule:
-      interval: "monthly"
+      interval: 'monthly'
     allow:
-      - dependency-type: "production"
+      - dependency-type: 'production'
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,6 +1,6 @@
 name: CI
 
-on: [ pull_request, push ]
+on: [pull_request, push]
 
 env:
   CI: true
@@ -14,9 +14,9 @@ jobs:
     secrets: inherit
 
   test:
-    needs: [ lint ]
+    needs: [lint]
     uses: haraka/.github/.github/workflows/ubuntu.yml@master
 
   windows:
-    needs: [ lint ]
+    needs: [lint]
     uses: haraka/.github/.github/workflows/windows.yml@master
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -2,10 +2,10 @@ name: CodeQL
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ master ]
+    branches: [master]
   schedule:
     - cron: '18 7 * * 4'
 

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -13,4 +13,4 @@ env:
 jobs:
   publish:
     uses: haraka/.github/.github/workflows/publish.yml@master
-    secrets: inherit
+    secrets: inherit
diff --git a/.prettierrc.yml b/.prettierrc.yml
@@ -0,0 +1,2 @@
+singleQuote: true
+semi: false
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -2,7 +2,7 @@
 
 This handcrafted artisinal software is brought to you by:
 
-| <img height="80" src="https://avatars.githubusercontent.com/u/261635?v=4"><br><a href="https://github.com/msimerson">msimerson</a> (<a href="https://github.com/haraka/haraka-net-utils/commits?author=msimerson">57</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/662371?v=4"><br><a href="https://github.com/baudehlo">baudehlo</a> (<a href="https://github.com/haraka/haraka-net-utils/commits?author=baudehlo">4</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/918201?v=4"><br><a href="https://github.com/DoobleD">DoobleD</a> (<a href="https://github.com/haraka/haraka-net-utils/commits?author=DoobleD">2</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/203240?v=4"><br><a href="https://github.com/lnedry">lnedry</a> (<a href="https://github.com/haraka/haraka-net-utils/commits?author=lnedry">2</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/791835?v=4"><br><a href="https://github.com/Juerd">Juerd</a> (<a href="https://github.com/haraka/haraka-net-utils/commits?author=Juerd">1</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/5957709?v=4"><br><a href="https://github.com/olsonpm">olsonpm</a> (<a href="https://github.com/haraka/haraka-net-utils/commits?author=olsonpm">1</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/260607?v=4"><br><a href="https://github.com/typingArtist">typingArtist</a> (<a href="https://github.com/haraka/haraka-net-utils/commits?author=typingArtist">1</a>)|
-| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
+| <img height="80" src="https://avatars.githubusercontent.com/u/261635?v=4"><br><a href="https://github.com/msimerson">msimerson</a> (<a href="https://github.com/haraka/haraka-net-utils/commits?author=msimerson">57</a>) | <img height="80" src="https://avatars.githubusercontent.com/u/662371?v=4"><br><a href="https://github.com/baudehlo">baudehlo</a> (<a href="https://github.com/haraka/haraka-net-utils/commits?author=baudehlo">4</a>) | <img height="80" src="https://avatars.githubusercontent.com/u/918201?v=4"><br><a href="https://github.com/DoobleD">DoobleD</a> (<a href="https://github.com/haraka/haraka-net-utils/commits?author=DoobleD">2</a>) | <img height="80" src="https://avatars.githubusercontent.com/u/203240?v=4"><br><a href="https://github.com/lnedry">lnedry</a> (<a href="https://github.com/haraka/haraka-net-utils/commits?author=lnedry">2</a>) | <img height="80" src="https://avatars.githubusercontent.com/u/791835?v=4"><br><a href="https://github.com/Juerd">Juerd</a> (<a href="https://github.com/haraka/haraka-net-utils/commits?author=Juerd">1</a>) | <img height="80" src="https://avatars.githubusercontent.com/u/5957709?v=4"><br><a href="https://github.com/olsonpm">olsonpm</a> (<a href="https://github.com/haraka/haraka-net-utils/commits?author=olsonpm">1</a>) | <img height="80" src="https://avatars.githubusercontent.com/u/260607?v=4"><br><a href="https://github.com/typingArtist">typingArtist</a> (<a href="https://github.com/haraka/haraka-net-utils/commits?author=typingArtist">1</a>) |
+| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
 
 <sub>this file is maintained by [.release](https://github.com/msimerson/.release)</sub>
diff --git a/Changes.md b/Changes.md
@@ -2,7 +2,6 @@
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/).
 
-
 ### Unreleased
 
 ### [1.6.0] - 2024-04-17
@@ -11,10 +10,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
 
 - feat: add timeout to DNS Resolver #83
 - feat: normalizeDomain, for punycode/IDN names
-- feat: get_mx now *also* returns implicit MX records
+- feat: get_mx now _also_ returns implicit MX records
 - feat: added get_implicit_mx
 - feat: added resolve_mx_hosts
 - doc(Changes): fixed broken tag version links
+- doc(CONTRIBUTORS): added
 - chore: populate [files] in package.json. Delete .npmignore
 - chore(lint): remove duplicate / stale rules from .eslintrc
 - dep(punycode): punycode -> punycode.js (avoid name collission)
@@ -28,163 +28,136 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
 
 - dep(stun): use updated @msimerson/stun
 
-
 ### [1.5.1] - 2023-12-03
 
 - feat(is_local_host): also match when
-    - the mx dest is a hostname that matches our hostname
-    - the mx dest matches our public IP (may not be locally bound)
+  - the mx dest is a hostname that matches our hostname
+  - the mx dest matches our public IP (may not be locally bound)
 - bump dep versions #78
 - test update for node v20 #78
 - ci: enable CI tests on PRs #77
 - test: increase DNS timeouts from 3s to 5s #77
 
-
 ### [1.5.0] - 2022-12-20
 
 - feat: add async support for get_public_ip #75
 - dep: replace vs-stun with stun
 - doc: use async/await syntax in examples #74
 
-
 ### [1.4.1] - 2022-07-22
 
 - feat(get_mx): use async/await
 - feat(get_mx): call w/o callback for promise API
 - test(get_mx): expand and improve test coverage
 - chore(ci): use more shared haraka/.github workflows
 
-
 ### [1.3.7] - 2022-06-03
 
 - ci: fix the dependabot allow syntax
 
-
 ### [1.3.6] - 2022-06-01
 
 - chore: replace .release with submodule
 - chore(ci): populate test matrix with Node.js LTS versions
 - chore(ci): limit dependabot updates to production deps
 
-
 #### [1.3.5] - 2022-05-27
 
 - chore(ci): use shared GHA workflows
 - style(es6): use dns.promises internally
 - dep(async): replace async dependency with Promise.all
 - doc(README): use code fences around examples (vs indention)
 
-
 #### [1.3.4] - 2022-01-05
 
 - promisify get_ips_by_host (backwards compatible)
 
-
 #### [1.3.3] - 2020-01-05
 
 - refactored is_local_host function to return a promise instead of using a callback #65
 
-
 #### [1.3.2] - 2021-12-20
 
 - add is_local_host function #63
 
-
 #### [1.3.1] - 2021-10-13
 
 - get_mx: wrap dns.resolveMx in a try haraka/Haraka#2985
 - add .release scripts
 - add GH workflow, publish release to NPM upon merge to master
 
-
 #### 1.3.0 - 2021-01-23
 
 - Support passing an array to ip_in_list #60
 
-
 #### 1.2.4 - 2021-01-14
 
 - add "any" IP to is_local_ip
 - add TEST-NET-[1-3] to is_private_ip
 
-
 #### 1.2.3 - 2020-12-19
 
 - fix: restore the tests wrapping the resolveMX iterable
 
-
 #### 1.2.2 - 2020-12-15
 
 - get_mx: do not include implicit MX
 
-
 #### [1.2.1] - 2020-11-17
 
 - bump ipaddr.js to 2.0.0 #56
 
-
 #### [1.2.0] - 2020-06-23
 
 - added get_mx
 - remove deprecated load_tls_ini
 - remove deprecated tls_ini_section_with_defaults
 
-
 #### 1.1.5 - 2020-04-11
 
 - ipv6_bogus: handle parsing broken ipv6 addresses #49
 - update async to version 3.0.1 #43
 
-
 #### 1.1.4 - 2019-04-04
 
 - stop is_private_ip from checking if the IP is bound to a local network interface
 
-
 #### 1.1.3 - 2019-03-01
 
 - is_local_ip checks local network interfaces too
 
-
 #### 1.1.2 - 2018-11-03
 
 - add is_local_ip
 
-
 #### 1.1.1 - 2018-07-19
 
 - ip_in_list doesn't throw on empty list
 
-
 #### 1.1.0 - 2018-04-11
 
 - add get_primary_host_name haraka/Haraka#2380
 
-
 #### 1.0.14 - 2018-01-25
 
 - restore tls_ini_section_with_defaults function (deprecated since Haraka 2.0.17)
 
-
 #### 1.0.13 - 2018-01-19
 
 - get_public_ip: assign timer before calling connect #29
-    - avoid race where timeout isn't cleared because stun connect errors immediately
+  - avoid race where timeout isn't cleared because stun connect errors immediately
 - remove TLS functions that have been subsumed into Haraka/tls_socket: tls_ini_section_with_defaults, parse_x509_names, parse_x509_expire, parse_x509, load_tls_dir
 - convert concatenated strings to template literals #28
 - eslint updates #25, #27
 - improved x509 parser #22
 
-
 #### 1.0.10 - 2017-07-27
 
 - added vs-stun as optional dep (from Haraka) #21
 
-
 #### 1.0.9 - 2017-06-16
 
-- lint fixes for compat with eslint 4  #18
-
+- lint fixes for compat with eslint 4 #18
 
 #### 1.0.8 - 2017-03-08
 
@@ -193,32 +166,27 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
 - rename certs -> cert (be consistent with haraka/plugins/tls)
 - store cert/key as buffers (was strings)
 
-
 #### 1.0.7 - 2017-03-08
 
 - handle undefined tls.ini section
 
-
 #### 1.0.6 - 2017-03-04
 
 - add tls_ini_section_with_defaults()
 - add load_tls_dir()
 - add parse_x509_names()
 
-
 #### 1.0.5 - 2016-11-20
 
-* add enableSNI TLS option
-
+- add enableSNI TLS option
 
 #### 1.0.4 - 2016-10-25
 
-* initialize TLS opts in (section != main) as booleans
-
+- initialize TLS opts in (section != main) as booleans
 
 #### 1.0.3 - 2016-10-25
 
-* added tls.ini loading
+- added tls.ini loading
 
 [1.2.0]: https://github.com/haraka/haraka-net-utils/releases/tag/1.2.0
 [1.2.1]: https://github.com/haraka/haraka-net-utils/releases/tag/1.2.1