refactor(shared): normalize directory structure

meteorlxy · meteorlxy · commit cf035327dd20 · 2024-05-21T00:35:58.000+08:00
diff --git a/packages/shared/src/utils/index.ts b/packages/shared/src/utils/index.ts
@@ -1,18 +1,12 @@
+export * from './links/index.js'
+export * from './routes/index.js'
+
 export * from './dedupeHead.js'
 export * from './ensureLeadingSlash.js'
 export * from './ensureEndingSlash.js'
 export * from './formatDateString.js'
-export * from './inferRoutePath.js'
-export * from './isLinkExternal.js'
-export * from './isLinkHttp.js'
-export * from './isLinkWithProtocol.js'
-export * from './isPlainObject.js'
-export * from './inferRoutePath.js'
-export * from './normalizeRoutePath.js'
 export * from './omit.js'
 export * from './removeEndingSlash.js'
 export * from './removeLeadingSlash.js'
 export * from './resolveHeadIdentifier.js'
-export * from './resolveLocalePath.js'
-export * from './resolveRoutePathFromUrl.js'
 export * from './typeGuards.js'
diff --git a/packages/shared/src/utils/isPlainObject.ts b/packages/shared/src/utils/isPlainObject.ts
diff --git a/packages/shared/src/utils/links/index.ts b/packages/shared/src/utils/links/index.ts
@@ -0,0 +1,3 @@
+export * from './isLinkExternal.js'
+export * from './isLinkHttp.js'
+export * from './isLinkWithProtocol.js'
diff --git a/packages/shared/src/utils/links/isLinkExternal.ts b/packages/shared/src/utils/links/isLinkExternal.ts
diff --git a/packages/shared/src/utils/links/isLinkHttp.ts b/packages/shared/src/utils/links/isLinkHttp.ts
diff --git a/packages/shared/src/utils/links/isLinkWithProtocol.ts b/packages/shared/src/utils/links/isLinkWithProtocol.ts
diff --git a/packages/shared/src/utils/routes/index.ts b/packages/shared/src/utils/routes/index.ts
@@ -0,0 +1,4 @@
+export * from './inferRoutePath'
+export * from './normalizeRoutePath.js'
+export * from './resolveLocalePath.js'
+export * from './resolveRoutePathFromUrl.js'
diff --git a/packages/shared/src/utils/routes/inferRoutePath.ts b/packages/shared/src/utils/routes/inferRoutePath.ts
diff --git a/packages/shared/src/utils/routes/normalizeRoutePath.ts b/packages/shared/src/utils/routes/normalizeRoutePath.ts
diff --git a/packages/shared/src/utils/routes/resolveLocalePath.ts b/packages/shared/src/utils/routes/resolveLocalePath.ts
@@ -1,4 +1,4 @@
-import type { LocaleConfig } from '../types/index.js'
+import type { LocaleConfig } from '../../types/index.js'
 
 /**
  * Resolve the matched locale path of route path
diff --git a/packages/shared/src/utils/routes/resolveRoutePathFromUrl.ts b/packages/shared/src/utils/routes/resolveRoutePathFromUrl.ts
@@ -1,3 +1,6 @@
+/**
+ * For a give URL, remove the origin and the site base to get the route path
+ */
 export const resolveRoutePathFromUrl = (url: string, base = '/'): string => {
   const pathname = url
     // remove url origin
diff --git a/packages/shared/src/utils/typeGuards.ts b/packages/shared/src/utils/typeGuards.ts
@@ -5,6 +5,13 @@
 export const isFunction = (val: unknown): val is Function =>
   typeof val === 'function'
 
+/**
+ * Check if a value is plain object, with generic type support
+ */
+export const isPlainObject = <T extends Record<any, any> = Record<any, any>>(
+  val: unknown,
+): val is T => Object.prototype.toString.call(val) === '[object Object]'
+
 /**
  * Check if a value is a string
  */
diff --git a/packages/shared/tests/isPlainObject.spec.ts b/packages/shared/tests/isPlainObject.spec.ts
diff --git a/packages/shared/tests/links/isLinkExternal.spec.ts b/packages/shared/tests/links/isLinkExternal.spec.ts
@@ -1,5 +1,5 @@
 import { expect, it } from 'vitest'
-import { isLinkExternal } from '../src/index.js'
+import { isLinkExternal } from '../../src/index.js'
 
 const testCases: [
   Parameters<typeof isLinkExternal>,
diff --git a/packages/shared/tests/links/isLinkHttp.spec.ts b/packages/shared/tests/links/isLinkHttp.spec.ts
@@ -1,5 +1,5 @@
 import { expect, it } from 'vitest'
-import { isLinkHttp } from '../src/index.js'
+import { isLinkHttp } from '../../src/index.js'
 
 const testCases: [string, ReturnType<typeof isLinkHttp>][] = [
   ['https://foobar.com', true],
diff --git a/packages/shared/tests/links/isLinkWithProtocol.spec.ts b/packages/shared/tests/links/isLinkWithProtocol.spec.ts
@@ -1,5 +1,5 @@
 import { expect, it } from 'vitest'
-import { isLinkWithProtocol } from '../src/index.js'
+import { isLinkWithProtocol } from '../../src/index.js'
 
 const testCases: [string, ReturnType<typeof isLinkWithProtocol>][] = [
   // with protocol
diff --git a/packages/shared/tests/routes/inferRoutePath.spec.ts b/packages/shared/tests/routes/inferRoutePath.spec.ts
@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { inferRoutePath } from '../src/index.js'
+import { inferRoutePath } from '../../src/index.js'
 
 const testCases = [
   // absolute index
diff --git a/packages/shared/tests/routes/normalizeRoutePath.spec.ts b/packages/shared/tests/routes/normalizeRoutePath.spec.ts
@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { normalizeRoutePath } from '../src/index.js'
+import { normalizeRoutePath } from '../../src/index.js'
 
 const testCases = [
   // absolute index
diff --git a/packages/shared/tests/routes/resolveLocalePath.spec.ts b/packages/shared/tests/routes/resolveLocalePath.spec.ts
@@ -1,6 +1,6 @@
 import { expect, it } from 'vitest'
-import { resolveLocalePath } from '../src/index.js'
-import type { LocaleConfig } from '../src/index.js'
+import type { LocaleConfig } from '../../src/index.js'
+import { resolveLocalePath } from '../../src/index.js'
 
 const locales: LocaleConfig = {
   '/': {
diff --git a/packages/shared/tests/routes/resolveRoutePathFromUrl.spec.ts b/packages/shared/tests/routes/resolveRoutePathFromUrl.spec.ts
@@ -1,5 +1,5 @@
 import { expect, it } from 'vitest'
-import { resolveRoutePathFromUrl } from '../src/index.js'
+import { resolveRoutePathFromUrl } from '../../src/index.js'
 
 const testCases: [
   Parameters<typeof resolveRoutePathFromUrl>,
diff --git a/packages/shared/tests/typeGuards.spec.ts b/packages/shared/tests/typeGuards.spec.ts
@@ -0,0 +1,23 @@
+import { describe, expect, it } from 'vitest'
+import { isPlainObject } from '../src/index.js'
+
+describe('isPlainObject', () => {
+  const testCases: [unknown, boolean][] = [
+    [true, false],
+    [false, false],
+    ['', false],
+    ['foobar', false],
+    [0, false],
+    [1, false],
+    [[], false],
+    [{}, true],
+    [{ foo: 'bar' }, true],
+    [Object.create(null), true],
+  ]
+
+  it('should determine plain object correctly', () => {
+    testCases.forEach(([source, expected]) => {
+      expect(isPlainObject(source)).toBe(expected)
+    })
+  })
+})

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export * from './isLinkExternal.js'`
	`2`	`+export * from './isLinkHttp.js'`
	`3`	`+export * from './isLinkWithProtocol.js'`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { LocaleConfig } from '../types/index.js'`
	`1`	`+import type { LocaleConfig } from '../../types/index.js'`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`* Resolve the matched locale path of route path`