deps(dev): bump aegir from 40.0.13 to 41.1.8 (#18)

Bumps [aegir](https://github.com/ipfs/aegir) from 40.0.13 to 41.1.8.
- [Release notes](https://github.com/ipfs/aegir/releases)
- [Changelog](https://github.com/ipfs/aegir/blob/master/CHANGELOG.md)
- [Commits](ipfs/aegir@v40.0.13...v41.1.8)

---
updated-dependencies:
- dependency-name: aegir
  dependency-type: direct:development
  update-type: version-update:semver-major
...

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: achingbrain <[email protected]>

Author: dependabot[bot]

.github/workflows/semantic-pull-request.yml

@@ -0,0 +1,12 @@
+name: Semantic PR
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    uses: pl-strflt/.github/.github/workflows/[email protected]

.github/workflows/stale.yml

@@ -0,0 +1,13 @@
+name: Close and mark stale issue
+
+on:
+  schedule:
+    - cron: '0 0 * * *'
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  stale:
+    uses: pl-strflt/.github/.github/workflows/[email protected]

README.md

@@ -1,44 +1,66 @@
-# @multiformats/multiaddr-matcher <!-- omit in toc -->
-
 [![multiformats.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://multiformats.io)
 [![codecov](https://img.shields.io/codecov/c/github/multiformats/js-multiaddr-matcher.svg?style=flat-square)](https://codecov.io/gh/multiformats/js-multiaddr-matcher)
 [![CI](https://img.shields.io/github/actions/workflow/status/multiformats/js-multiaddr-matcher/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/multiformats/js-multiaddr-matcher/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
 
 > Match different multiaddr formats
 
-## Table of contents <!-- omit in toc -->
+# About
+
+This module exports various matchers that can be used to infer the type of a
+passed multiaddr.
+
+## Example
+
+```ts
+import { multiaddr } from '@multiformats/multiaddr'
+import { DNS } from '@multiformats/multiaddr-matcher'
+
+const ma = multiaddr('/dnsaddr/example.org')
+
+DNS.matches(ma) // true - this is a multiaddr with a DNS address at the start
+```
+
+## Example
+
+The default matching behaviour ignores any subsequent tuples in the multiaddr.
+If you want stricter matching you can use `.exactMatch`:
 
-- [Install](#install)
-  - [Browser `<script>` tag](#browser-script-tag)
-- [API Docs](#api-docs)
-- [License](#license)
-- [Contribution](#contribution)
+```ts
+import { multiaddr } from '@multiformats/multiaddr'
+import { DNS, Circuit } from '@multiformats/multiaddr-matcher'
+
+const ma = multiaddr('/dnsaddr/example.org/p2p/QmFoo/p2p-circuit/p2p/QmBar')
+
+DNS.exactMatch(ma) // false - this address has extra tuples after the DNS component
+Circuit.matches(ma) // true
+Circuit.exactMatch(ma) // true - the extra tuples are circuit relay related
+```
 
-## Install
+# Install
 
 ```console
 $ npm i @multiformats/multiaddr-matcher
 ```
 
-### Browser `<script>` tag
+## Browser `<script>` tag
 
 Loading this module through a script tag will make it's exports available as `MultiformatsMultiaddrMatcher` in the global namespace.
 
 ```html
 <script src="https://unpkg.com/@multiformats/multiaddr-matcher/dist/index.min.js"></script>
 ```
 
-## API Docs
+# API Docs
 
 - <https://multiformats.github.io/js-multiaddr-matcher>
 
-## License
+# License
 
 Licensed under either of
 
 - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
 - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
-## Contribution
+# Contribution
 
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

package.json

@@ -31,6 +31,7 @@
   "eslintConfig": {
     "extends": "ipfs",
     "parserOptions": {
+      "project": true,
       "sourceType": "module"
     }
   },
@@ -141,6 +142,6 @@
     "multiformats": "^12.0.1"
   },
   "devDependencies": {
-    "aegir": "^40.0.8"
+    "aegir": "^41.1.8"
   }
 }

src/index.ts

@@ -49,7 +49,7 @@ const toParts = (ma: Multiaddr): string[] => {
  * false or returns a sublist of unmatched components
  */
 interface Matcher {
-  match: (parts: string[]) => string[] | false
+  match(parts: string[]): string[] | false
   pattern: string
 }
 
@@ -255,13 +255,13 @@ export interface MultiaddrMatcher {
    * Returns true if the passed multiaddr can be treated as this type of
    * multiaddr
    */
-  matches: (ma: Multiaddr) => boolean
+  matches(ma: Multiaddr): boolean
 
   /**
    * Returns true if the passed multiaddr terminates as this type of
    * multiaddr
    */
-  exactMatch: (ma: Multiaddr) => boolean
+  exactMatch(ma: Multiaddr): boolean
 }
 
 /**