Restructure & Introduce Address Formatting

lucemans · lucemans · commit e5aa58b8dfdc · 2023-04-29T14:42:04.000Z
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/format/address/index.ts b/src/format/address/index.ts
@@ -0,0 +1,12 @@
+export const AddressRegex = /^0x[\dA-Fa-f]{40}$/;
+
+/**
+ * Formats the address from 0x225f137127d9067788314bc7fcc1f36746a3c3B5 to 0x225f...c3B5
+ * Returns the address if it doesn't match the address pattern
+ * @param address The address to format
+ */
+export const formatAddress = (address: string) => {
+    if (address.match(AddressRegex) === null) return address;
+
+    return `${address.slice(0, 5)}...${address.slice(-4)}`;
+};
diff --git a/src/format/index.ts b/src/format/index.ts
@@ -1,3 +1,4 @@
+export * from './address';
 export { formatRecord } from './records';
 export { formatDiscordRules } from './records/discord/discord';
 export { formatLinkedinRules } from './records/linkedin/linkedin';
diff --git a/src/format/records/discord/discord.ts b/src/format/records/discord/discord.ts
@@ -1,4 +1,4 @@
-import { formatter } from '../../formatter';
+import { formatter } from '../formatter';
 
 export const formatDiscordRules = formatter([
     (record) =>
diff --git a/src/format/records/formatter.ts b/src/format/records/formatter.ts
diff --git a/src/format/records/github/github.ts b/src/format/records/github/github.ts
@@ -1,4 +1,4 @@
-import { formatter } from '../../formatter';
+import { formatter } from '../formatter';
 
 export const formatGithubRules = formatter([
     (record) => record.replace(/^(https?:\/\/)?(www\.)?github\.com\//, ''),
diff --git a/src/format/records/index.ts b/src/format/records/index.ts
@@ -1,11 +1,11 @@
-import { formatDiscordRules } from './records/discord/discord';
-import { formatGithubRules } from './records/github/github';
-import { formatLinkedinRules } from './records/linkedin/linkedin';
-import { formatRedditRules } from './records/reddit/reddit';
-import { formatTelegramRules } from './records/telegram/telegram';
-import { formatTwitterRules } from './records/twitter/twitter';
-import { formatWebsiteRules } from './records/website/website';
+import { formatDiscordRules } from './discord/discord';
+import { formatGithubRules } from './github/github';
+import { formatLinkedinRules } from './linkedin/linkedin';
+import { formatRedditRules } from './reddit/reddit';
 import { Rule } from './rule';
+import { formatTelegramRules } from './telegram/telegram';
+import { formatTwitterRules } from './twitter/twitter';
+import { formatWebsiteRules } from './website/website';
 
 type Types =
     | 'com.twitter'
diff --git a/src/format/records/linkedin/linkedin.ts b/src/format/records/linkedin/linkedin.ts
@@ -1,4 +1,4 @@
-import { formatter } from '../../formatter';
+import { formatter } from '../formatter';
 
 export const formatLinkedinRules = formatter([
     (record) =>
diff --git a/src/format/records/reddit/reddit.ts b/src/format/records/reddit/reddit.ts
@@ -1,4 +1,4 @@
-import { formatter } from '../../formatter';
+import { formatter } from '../formatter';
 
 export const formatRedditRules = formatter([
     (record) => record.replace(/^(https?:\/\/)?(www\.)?reddit\.com\//, ''),
diff --git a/src/format/records/rule.ts b/src/format/records/rule.ts
diff --git a/src/format/records/telegram/telegram.ts b/src/format/records/telegram/telegram.ts
@@ -1,4 +1,4 @@
-import { formatter } from '../../formatter';
+import { formatter } from '../formatter';
 
 export const formatTelegramRules = formatter([
     (record) => record.replace(/^(https?:\/\/)?(www\.)?(mobile\.)?t\.me\//, ''),
diff --git a/src/format/records/twitter/twitter.ts b/src/format/records/twitter/twitter.ts
@@ -1,4 +1,4 @@
-import { formatter } from '../../formatter';
+import { formatter } from '../formatter';
 
 export const formatTwitterRules = formatter([
     (record) =>
diff --git a/src/format/records/website/website.ts b/src/format/records/website/website.ts
@@ -1,4 +1,4 @@
-import { formatter } from '../../formatter';
+import { formatter } from '../formatter';
 
 export const formatWebsiteRules = formatter([
     (record) => record.match(/^(.+?:\/\/)?(([^.]+\.)+[^./]+)/)?.[2],
diff --git a/src/index.ts b/src/index.ts
@@ -1 +1 @@
-export * from './format/records';
+export * from './format';
diff --git a/tests/format/address/address.spec.ts b/tests/format/address/address.spec.ts
@@ -0,0 +1,9 @@
+import { formatAddress } from '../../../src/index';
+
+it('Address Default', () => {
+    expect(formatAddress('0x225f137127d9067788314bc7fcc1f36746a3c3B5')).toBe('0x225f...c3B5');
+});
+
+it('ENS Name', () => {
+    expect(formatAddress('luc.eth')).toBe('luc.eth');
+});
diff --git a/tests/format/records/discord.spec.ts b/tests/format/records/discord.spec.ts
@@ -1,4 +1,4 @@
-import { formatRecord } from '../../src/index';
+import { formatRecord } from '../../../src/index';
 
 it('Discord Default', () => {
     expect(formatRecord('com.discord', 'Lucemans#2066')).toBe('Lucemans#2066');
diff --git a/tests/format/records/github.spec.ts b/tests/format/records/github.spec.ts
@@ -1,4 +1,4 @@
-import { formatRecord } from '../../src/index';
+import { formatRecord } from '../../../src/index';
 
 it('Github Default', () => {
     expect(formatRecord('com.github', 'lucemans')).toBe('lucemans');
diff --git a/tests/format/records/linkedin.spec.ts b/tests/format/records/linkedin.spec.ts
@@ -1,4 +1,4 @@
-import { formatRecord } from '../../src/index';
+import { formatRecord } from '../../../src/index';
 
 it('Linkedin Default', () => {
     expect(formatRecord('com.linkedin', 'in/lucemans')).toBe('lucemans');
diff --git a/tests/format/records/reddit.spec.ts b/tests/format/records/reddit.spec.ts
@@ -1,4 +1,4 @@
-import { formatRecord } from '../../src/index';
+import { formatRecord } from '../../../src/index';
 
 it('Reddit Default', () => {
     expect(formatRecord('com.reddit', 'robi0t')).toBe('robi0t');
diff --git a/tests/format/records/telegram.spec.ts b/tests/format/records/telegram.spec.ts
@@ -1,4 +1,4 @@
-import { formatRecord } from '../../src/index';
+import { formatRecord } from '../../../src/index';
 
 it('Telegram Default', () => {
     expect(formatRecord('org.telegram', 'lucemansnl')).toBe('lucemansnl');
diff --git a/tests/format/records/twitter.spec.ts b/tests/format/records/twitter.spec.ts
@@ -1,4 +1,4 @@
-import { formatRecord } from '../../src/index';
+import { formatRecord } from '../../../src/index';
 
 it('Twitter Default', () => {
     expect(formatRecord('com.twitter', 'lucemansnl')).toBe('@lucemansnl');
diff --git a/tsconfig.json b/tsconfig.json
@@ -12,6 +12,6 @@
         "outDir": "lib",
         "esModuleInterop": true
     },
-    "include": ["src", "tests/records/discord.spec.js"],
+    "include": ["src", "tests/format/records/discord.spec.js"],
     "exclude": ["node_modules", "tests", "lib"]
 }

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+export * from './address';`
`1`	`2`	`export { formatRecord } from './records';`
`2`	`3`	`export { formatDiscordRules } from './records/discord/discord';`
`3`	`4`	`export { formatLinkedinRules } from './records/linkedin/linkedin';`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { formatter } from '../../formatter';`
	`1`	`+import { formatter } from '../formatter';`
`2`	`2`
`3`	`3`	`export const formatDiscordRules = formatter([`
`4`	`4`	`(record) =>`