Add youtube mentions

Author: gregjacobs

README.md

@@ -1,7 +1,7 @@
 # Autolinker.js
 
 Because I had so much trouble finding a good auto-linking implementation out in
-the wild, I decided to roll my own. It  seemed that everything I found out there
+the wild, I decided to roll my own. It seemed that everything I found out there
 was either an implementation that didn't cover every case, or was just limited
 in one way or another.
 
@@ -27,27 +27,34 @@ Full API Docs: [http://gregjacobs.github.io/Autolinker.js/api/](http://gregjacob
 Live Example: [http://gregjacobs.github.io/Autolinker.js/examples/live-example/](http://gregjacobs.github.io/Autolinker.js/examples/live-example/)
 
 
-## v4.0 released September 2022
+## Upgrading from a previous major version of Autolinker?
 
-See [Upgrading from v3.x -> v4.x (Breaking Changes)](#upgrading-from-v3x---v4x-breaking-changes) at the bottom of this readme.
+See [Breaking Changes](#upgrading-from-v3x---v4x-breaking-changes) at the bottom of this readme.
 
 ## Installation
 
-#### Installing with the [npm](https://www.npmjs.org/) package manager:
+#### Installing with [npm](https://www.npmjs.org/):
 
 ```shell
 npm install autolinker --save
 ```
 
 
-#### Installing with the [Yarn](https://yarnpkg.com/) package manager:
+#### Installing with [Yarn](https://yarnpkg.com/):
 
 ```shell
 yarn add autolinker
 ```
 
 
-#### Installing with the [Bower](http://bower.io) package manager:	
+#### Installing with [pnpm](https://pnpm.io/):
+
+```shell
+pnpm add autolinker
+```
+
+
+#### Installing with [Bower](http://bower.io):	
 
 ```shell
 bower install Autolinker.js --save
@@ -57,18 +64,18 @@ bower install Autolinker.js --save
 #### Direct download
 
 Simply clone this repository or download a zip of the project, and link to 
-either `dist/Autolinker.js` or `dist/Autolinker.min.js` with a script tag.
+either `dist/Autolinker.js` or `dist/Autolinker.min.js` with a `<script>` tag.
 
 
 ## Importing Autolinker
 
-#### ES6/TypeScript/Webpack:
+#### ES6+/TypeScript/Webpack/Node.js ESM:
 
 ```ts
 import Autolinker from 'autolinker';
 ```
 
-#### Node.js:
+#### Node.js CommonJS:
 
 ```javascript
 const Autolinker = require('autolinker');
@@ -159,14 +166,10 @@ These include:
   phone numbers. Defaults to `true`.
 
 - [mention](http://gregjacobs.github.io/Autolinker.js/api/#!/api/Autolinker-cfg-mention) : string<br />
-  A string for the service name to have mentions (@username) auto-linked to. Supported
-  values at this time are 'twitter', 'soundcloud', 'instagram' and 'tiktok'. Pass `false` to skip
-  auto-linking of mentions. Defaults to `false`.
+  A string for the service name to have mentions (@username) auto-linked to. Supported values at this time are 'twitter', 'soundcloud', 'instagram', 'tiktok', and 'youtube'. Pass `false` to skip auto-linking of mentions. Defaults to `false`.
 
 - [hashtag](http://gregjacobs.github.io/Autolinker.js/api/#!/api/Autolinker-cfg-hashtag) : boolean/string<br />
-  A string for the service name to have hashtags auto-linked to. Supported
-  values at this time are 'twitter', 'facebook', 'instagram' and 'tiktok'. Pass `false` to skip
-  auto-linking of hashtags. Defaults to `false`.
+  A string for the service name to have hashtags auto-linked to. Supported values at this time are 'twitter', 'facebook', 'instagram', 'tiktok', and 'youtube'. Pass `false` to skip auto-linking of hashtags. Defaults to `false`.
 
 - [stripPrefix](http://gregjacobs.github.io/Autolinker.js/api/#!/api/Autolinker-cfg-stripPrefix) : boolean<br />
   `true` to have the `'http://'` (or `'https://'`) and/or the `'www.'` 

live-example/src/main.ts

@@ -60,7 +60,7 @@ $(document).ready(function () {
         mentionOption = new RadioOption({
             name: 'mention',
             description: 'Mentions',
-            options: [false, 'twitter', 'instagram', 'soundcloud', 'tiktok'],
+            options: [false, 'twitter', 'instagram', 'soundcloud', 'tiktok', 'youtube'],
             defaultValue: false,
         }).onChange(autolink);
 

src/autolinker.ts

@@ -282,6 +282,7 @@ export default class Autolinker {
      * - 'instagram'
      * - 'soundcloud'
      * - 'tiktok'
+     * - 'youtube'
      *
      * Defaults to `false` to skip auto-linking of mentions.
      */

src/match/mention-match.ts

@@ -1,4 +1,5 @@
 import { MentionService } from '../parser/mention-utils';
+import { assertNever } from '../utils';
 import { AbstractMatch, AbstractMatchConfig } from './abstract-match';
 
 /**
@@ -91,9 +92,12 @@ export class MentionMatch extends AbstractMatch {
                 return 'https://soundcloud.com/' + this.mention;
             case 'tiktok':
                 return 'https://www.tiktok.com/@' + this.mention;
+            case 'youtube':
+                return 'https://youtube.com/@' + this.mention;
 
             default:
                 // Shouldn't happen because Autolinker's constructor should block any invalid values, but just in case.
+                assertNever(this.serviceName);
                 throw new Error('Unknown service name to point mention to: ' + this.serviceName);
         }
     }

src/parser/mention-utils.ts

@@ -6,6 +6,11 @@ const mentionRegexes: { [serviceName in MentionService]: RegExp } = {
     // TikTok usernames are 1-24 characters containing letters, numbers, underscores
     // and periods, but cannot end in a period: https://support.tiktok.com/en/getting-started/setting-up-your-profile/changing-your-username
     tiktok: /^@[.\w]{1,23}[\w]$/,
+
+    // Youtube usernames are 3-30 characters containing letters, numbers, underscores,
+    // dashes, or latin middle dots ('·').
+    // https://support.google.com/youtube/answer/11585688?hl=en&co=GENIE.Platform%3DAndroid#tns
+    youtube: /^@[-.·\w]{3,30}$/,
 };
 
 // Regex that allows for all possible mention characters for any service. We'll
@@ -29,5 +34,11 @@ export function isValidMention(mention: string, serviceName: MentionService): bo
     return re.test(mention);
 }
 
-export type MentionService = 'twitter' | 'instagram' | 'soundcloud' | 'tiktok';
-export const mentionServices: MentionService[] = ['twitter', 'instagram', 'soundcloud', 'tiktok'];
+export type MentionService = 'twitter' | 'instagram' | 'soundcloud' | 'tiktok' | 'youtube';
+export const mentionServices: MentionService[] = [
+    'twitter',
+    'instagram',
+    'soundcloud',
+    'tiktok',
+    'youtube',
+];

tests/autolinker-mention.spec.ts

@@ -20,6 +20,10 @@ describe('Autolinker Mention Matching >', () => {
         mention: 'tiktok',
         newWindow: false,
     });
+    const youtubeAutolinker = new Autolinker({
+        mention: 'youtube',
+        newWindow: false,
+    });
 
     const services: MentionTestService[] = [
         {
@@ -42,6 +46,11 @@ describe('Autolinker Mention Matching >', () => {
             urlPrefix: 'https://www.tiktok.com/@',
             autolinker: tiktokAutolinker,
         },
+        {
+            serviceName: 'youtube',
+            urlPrefix: 'https://youtube.com/@',
+            autolinker: youtubeAutolinker,
+        },
     ];
 
     interface MentionTestService {