polen 0.11.0-next.14 → 0.11.0-next.15

package/src/lib/change/criticality.ts

@@ -0,0 +1,53 @@
+import { Level } from '#lib/change/level'
+import { S } from '#lib/kit-temp/effect'
+
+// ============================================================================
+// Schema
+// ============================================================================
+
+export const Criticality = S.Struct({
+  level: Level,
+  reason: S.optional(S.String),
+}).annotations({
+  identifier: 'Criticality',
+  title: 'Change Criticality',
+  description: 'The criticality assessment of a GraphQL schema change',
+})
+
+export type Level = S.Schema.Type<typeof Level>
+export type Criticality = S.Schema.Type<typeof Criticality>
+
+// ============================================================================
+// Constructors
+// ============================================================================
+
+export const make = Criticality.make
+
+// ============================================================================
+// Guards
+// ============================================================================
+
+export const is = S.is(Criticality)
+
+// ============================================================================
+// State Predicates
+// ============================================================================
+
+export const isBreaking = (criticality: Criticality): boolean => criticality.level === 'BREAKING'
+
+export const isDangerous = (criticality: Criticality): boolean => criticality.level === 'DANGEROUS'
+
+export const isSafe = (criticality: Criticality): boolean => criticality.level === 'NON_BREAKING'
+
+// ============================================================================
+// Codecs
+// ============================================================================
+
+export const decode = S.decode(Criticality)
+export const encode = S.encode(Criticality)
+
+// ============================================================================
+// Equivalence
+// ============================================================================
+
+export const equivalence = S.equivalence(Criticality)

package/src/lib/change/level.ts

@@ -0,0 +1,3 @@
+import { S } from '#lib/kit-temp/effect'
+
+export const Level = S.Literal('BREAKING', 'DANGEROUS', 'NON_BREAKING')

package/src/lib/date-only/$.ts

@@ -0,0 +1 @@
+export * as DateOnly from './date-only.js'

package/src/lib/date-only/date-only.ts

@@ -0,0 +1,112 @@
+import { S } from '#lib/kit-temp/effect'
+import { Order } from 'effect'
+
+// ============================================================================
+// Schema
+// ============================================================================
+
+export const DateOnly = S.String.pipe(
+  S.pattern(/^\d{4}-\d{2}-\d{2}$/),
+  S.annotations({
+    identifier: 'DateOnly',
+    title: 'Date Only',
+    description: 'A date-only value in YYYY-MM-DD format',
+    examples: ['2024-01-15', '2023-12-31'],
+  }),
+  S.brand('DateOnly'),
+)
+
+// ============================================================================
+// Type
+// ============================================================================
+
+export type DateOnly = S.Schema.Type<typeof DateOnly>
+
+// ============================================================================
+// Constructors
+// ============================================================================
+
+export const make = DateOnly.make
+
+// ============================================================================
+// Ordering
+// ============================================================================
+
+export const order: Order.Order<DateOnly> = Order.mapInput(Order.string, (date) => date)
+
+export const min = Order.min(order)
+
+export const max = Order.max(order)
+
+export const lessThan = Order.lessThan(order)
+
+export const greaterThan = Order.greaterThan(order)
+
+// ============================================================================
+// Equivalence
+// ============================================================================
+
+export const equivalence = S.equivalence(DateOnly)
+
+// ============================================================================
+// Type Guard
+// ============================================================================
+
+export const is = S.is(DateOnly)
+
+// ============================================================================
+// Codec
+// ============================================================================
+
+export const decode = S.decode(DateOnly)
+
+export const decodeSync = S.decodeSync(DateOnly)
+
+export const encode = S.encode(DateOnly)
+
+// ============================================================================
+// Importers
+// ============================================================================
+
+export const fromDate = (date: Date): DateOnly => {
+  const dateString = date.toISOString().split('T')[0]!
+  return make(dateString)
+}
+
+// ============================================================================
+// Exporters
+// ============================================================================
+
+export const toDate = (date: DateOnly): Date => new Date(date + 'T00:00:00.000Z')
+
+// ============================================================================
+// Domain Logic
+// ============================================================================
+
+/**
+ * Get the year from a date
+ */
+export const getYear = (date: DateOnly): number => parseInt(date.substring(0, 4), 10)
+
+/**
+ * Get the month from a date (1-12)
+ */
+export const getMonth = (date: DateOnly): number => parseInt(date.substring(5, 7), 10)
+
+/**
+ * Get the day from a date (1-31)
+ */
+export const getDay = (date: DateOnly): number => parseInt(date.substring(8, 10), 10)
+
+/**
+ * Calculate the number of days between two dates
+ * @param from - The starting date
+ * @param to - The ending date
+ * @returns Number of days between the dates (positive if to > from, negative otherwise)
+ */
+export const getDaysBetween = (from: DateOnly, to: DateOnly): number => {
+  const fromDate = toDate(from)
+  const toDate_ = toDate(to)
+  const diffMs = toDate_.getTime() - fromDate.getTime()
+  return Math.floor(diffMs / (1000 * 60 * 60 * 24))
+}

package/src/lib/file-path/$$.ts

@@ -0,0 +1,5 @@
+// ============================================================================
+// File Path Module Exports
+// ============================================================================
+
+export * from './file-path.js'

package/src/lib/file-path/$.ts

@@ -0,0 +1,5 @@
+// ============================================================================
+// File Path Namespace Export
+// ============================================================================
+
+export * as FilePathSegment from './$$.js'

package/src/lib/file-path/file-path.test.ts

@@ -0,0 +1,80 @@
+import { describe, expect, test } from 'vitest'
+import { Test } from '../../../tests/unit/helpers/test.js'
+import * as FilePathSegment from './$$.js'
+
+describe('FilePathSegment', () => {
+  describe('SEPARATOR', () => {
+    test('should be forward slash', () => {
+      expect(FilePathSegment.SEPARATOR).toBe('/')
+    })
+  })
+  // dprint-ignore
+  Test.suite<{ segments: string[]; expected: string }>('join', [
+    { name: 'joins path segments',                                                                       segments: ['foo', 'bar', 'baz.txt'],                                                               expected: 'foo/bar/baz.txt' },
+    { name: 'handles leading slashes',                                                                   segments: ['/foo', '/bar', '/baz.txt'],                                                            expected: '/foo/bar/baz.txt' },
+    { name: 'handles trailing slashes',                                                                  segments: ['foo/', 'bar/', 'baz.txt'],                                                             expected: 'foo/bar/baz.txt' },
+    { name: 'handles empty segments',                                                                    segments: ['foo', '', 'bar', '', 'baz.txt'],                                                       expected: 'foo/bar/baz.txt' },
+    { name: 'returns empty for no segments',                                                             segments: [],                                                                                      expected: '' },
+  ], ({ segments, expected }) => {
+    const path = FilePathSegment.join(...segments.map(FilePathSegment.make))
+    expect(path).toBe(expected)
+  })
+
+  // dprint-ignore
+  Test.suite<{ path: string; extension: string; expected: string }>('upsertExtension', [
+    { name: 'adds extension when missing',                                                               path: 'file',                                                                                      extension: 'json',  expected: 'file.json' },
+    { name: 'replaces existing extension',                                                               path: 'file.txt',                                                                                  extension: 'json',  expected: 'file.json' },
+    { name: 'handles extension with dot',                                                                path: 'file',                                                                                      extension: '.json', expected: 'file.json' },
+    { name: 'handles multiple dots in filename',                                                         path: 'file.test.txt',                                                                             extension: 'json',  expected: 'file.test.json' },
+    { name: 'handles paths with directories',                                                            path: '/path/to/file.txt',                                                                         extension: 'json',  expected: '/path/to/file.json' },
+  ], ({ path, extension, expected }) => {
+    const result = FilePathSegment.upsertExtension(FilePathSegment.make(path), extension)
+    expect(result).toBe(expected)
+  })
+
+  // dprint-ignore
+  Test.suite<{ path: string; extension: string; expected: string }>('withExtension', [
+    { name: 'adds extension without dot',                                                                path: 'file',                                                                                      extension: 'json',  expected: 'file.json' },
+    { name: 'adds extension with dot',                                                                  path: 'file',                                                                                      extension: '.json', expected: 'file.json' },
+  ], ({ path, extension, expected }) => {
+    const result = FilePathSegment.ensureExtension(FilePathSegment.make(path), extension)
+    expect(result).toBe(expected)
+  })
+
+  // dprint-ignore
+  Test.suite<{ path: string; expected: string }>('withoutExtension', [
+    { name: 'removes extension',                                                                         path: 'file.json',                                                                                 expected: 'file' },
+    { name: 'handles no extension',                                                                      path: 'file',                                                                                      expected: 'file' },
+  ], ({ path, expected }) => {
+    const result = FilePathSegment.withoutExtension(FilePathSegment.make(path))
+    expect(result).toBe(expected)
+  })
+
+  // dprint-ignore
+  Test.suite<{ path: string; expected: string | undefined }>('getExtension', [
+    { name: 'gets extension',                                                                            path: 'file.json',                                                                                 expected: 'json' },
+    { name: 'returns undefined for no extension',                                                        path: 'file',                                                                                      expected: undefined },
+  ], ({ path, expected }) => {
+    const result = FilePathSegment.getExtension(FilePathSegment.make(path))
+    expect(result).toBe(expected)
+  })
+
+  // dprint-ignore
+  Test.suite<{ path: string; expected: string }>('getFileName', [
+    { name: 'gets filename from path',                                                                   path: '/path/to/file.json',                                                                        expected: 'file.json' },
+    { name: 'handles Windows paths',                                                                     path: 'C:/path/to/file.json',                                                                      expected: 'file.json' },
+    { name: 'returns full path if no directory',                                                         path: 'file.json',                                                                                 expected: 'file.json' },
+  ], ({ path, expected }) => {
+    const result = FilePathSegment.getFileName(FilePathSegment.make(path))
+    expect(result).toBe(expected)
+  })
+
+  // dprint-ignore
+  Test.suite<{ path: string; expected: string }>('getDirectory', [
+    { name: 'gets directory from path',                                                                  path: '/path/to/file.json',                                                                        expected: '/path/to' },
+    { name: 'returns dot for no directory',                                                              path: 'file.json',                                                                                 expected: '.' },
+  ], ({ path, expected }) => {
+    const result = FilePathSegment.getDirectory(FilePathSegment.make(path))
+    expect(result).toBe(expected)
+  })
+})

package/src/lib/file-path/file-path.ts

@@ -0,0 +1,134 @@
+import { S } from '#lib/kit-temp/effect'
+import { Brand } from 'effect'
+import * as Path from 'node:path'
+
+// ============================================================================
+// Constants
+// ============================================================================
+
+export const SEPARATOR = '/' as const
+
+// ============================================================================
+// Schema and Type
+// ============================================================================
+
+/**
+ * File path segment
+ */
+export type FilePathSegment = string & Brand.Brand<'FilePathSegment'>
+export const FilePathSegment = S.String.pipe(
+  S.brand('FilePathSegment'),
+  S.annotations({
+    identifier: 'FilePathSegment',
+    description: 'A segment of a file path',
+  }),
+)
+
+// ============================================================================
+// Constructors
+// ============================================================================
+
+export const make = (path: string): FilePathSegment => path as FilePathSegment
+
+// ============================================================================
+// Type Guard
+// ============================================================================
+
+export const is = (value: unknown): value is FilePathSegment => typeof value === 'string'
+
+// ============================================================================
+// Codec
+// ============================================================================
+
+export const decode = S.decode(FilePathSegment)
+export const decodeSync = S.decodeSync(FilePathSegment)
+export const encode = S.encode(FilePathSegment)
+
+// ============================================================================
+// Domain Logic
+// ============================================================================
+
+/**
+ * Add extension to a file path
+ */
+export const ensureExtension = (
+  path: FilePathSegment,
+  extension: string,
+): FilePathSegment => {
+  const ext = extension.startsWith('.') ? extension : `.${extension}`
+  return `${path}${ext}` as FilePathSegment
+}
+
+/**
+ * Remove extension from a file path
+ */
+export const withoutExtension = (path: FilePathSegment): FilePathSegment => {
+  const dir = Path.dirname(path)
+  const base = Path.basename(path, Path.extname(path))
+  return join(
+    dir as FilePathSegment,
+    base as FilePathSegment,
+  )
+}
+
+/**
+ * Get the extension from a file path
+ */
+export const getExtension = (path: FilePathSegment): string | undefined => {
+  const ext = Path.extname(path)
+  // Remove the leading dot if present
+  return ext ? ext.slice(1) : undefined
+}
+
+/**
+ * Get the file name from a path
+ */
+export const getFileName = (path: FilePathSegment): string => {
+  return Path.basename(path)
+}
+
+/**
+ * Get the directory from a path
+ */
+export const getDirectory = (path: FilePathSegment): FilePathSegment => {
+  const dir = Path.dirname(path)
+  // Normalize to forward slashes
+  return dir.replace(/\\/g, SEPARATOR) as FilePathSegment
+}
+
+/**
+ * Join multiple path segments together
+ * Uses node:path internally for proper path handling
+ */
+export const join = (...segments: ReadonlyArray<FilePathSegment>): FilePathSegment => {
+  if (segments.length === 0) {
+    return '' as FilePathSegment
+  }
+
+  // Use Path.join for consistent path handling
+  const joined = Path.join(...segments)
+
+  // Normalize to forward slashes
+  return joined.replace(/\\/g, SEPARATOR) as FilePathSegment
+}
+
+/**
+ * Upsert extension - adds extension if missing, replaces if present
+ * @param path - The file path
+ * @param extension - The extension to upsert (with or without leading dot)
+ */
+export const upsertExtension = (
+  path: FilePathSegment,
+  extension: string,
+): FilePathSegment => {
+  const ext = extension.startsWith('.') ? extension : `.${extension}`
+  const currentExt = getExtension(path)
+
+  if (currentExt) {
+    // Replace existing extension
+    return ensureExtension(withoutExtension(path), extension)
+  } else {
+    // Add extension
+    return ensureExtension(path, extension)
+  }
+}

package/src/lib/file-router/index.test.ts

@@ -1,6 +1,7 @@
 import { Fn } from '@wollybeard/kit'
+import { Effect } from 'effect'
 import { describe, expect } from 'vitest'
-import { test } from '../../../tests/unit/helpers/test.js'
+import { test } from '../../../tests/unit/helpers/test-with-fixtures.js'
 import { FileRouter } from './$.js'
 
 /* Note
@@ -12,7 +13,7 @@ absolute: { dir: expect.stringMatching(/^pages\/$/) },
 */
 
 const $ = Fn.$identityPartial<FileRouter.ScanResult> // subset data factory
-const scan = (path: string) => FileRouter.scan({ dir: path + '/pages' })
+const scan = (path: string) => Effect.runPromise(FileRouter.scan({ dir: path + '/pages' }))
 
 describe('.scan', () => {
   describe('literal', () => {

package/src/lib/file-router/linter.test.ts

@@ -1,4 +1,5 @@
-import { describe, expect, test } from 'vitest'
+import { expect } from 'vitest'
+import { Test } from '../../../tests/unit/helpers/test.js'
 import { lint } from './linter.js'
 import type { Route } from './route.js'
 
@@ -33,85 +34,100 @@ const createRoute = (path: string[], order?: number, isIndex = false): Route =>
   }
 }
 
-describe('linter', () => {
-  test('warns about numbered prefix on index files', () => {
-    const routes: Route[] = [
-      createRoute(['docs'], 10, true), // 10_index.md
-      createRoute(['docs', 'getting-started']),
-    ]
-
-    const result = lint(routes)
+interface LinterTestCase {
+  routes: Array<{ path: string[]; order?: number; isIndex?: boolean }>
+  expectedDiagnosticCount: number
+  expectedMessage?: string
+  checkDiagnostic?: (diagnostic: any) => void
+}
 
-    expect(result.diagnostics).toHaveLength(1)
-    expect(result.diagnostics[0]).toMatchObject({
-      message: expect.stringContaining('Numbered prefix on index file has no effect'),
-      file: expect.objectContaining({
-        path: expect.objectContaining({
-          relative: expect.objectContaining({
-            name: 'index',
+// dprint-ignore
+Test.suite<LinterTestCase>('linter', [
+  { 
+    name: 'warns about numbered prefix on index files',
+    routes: [
+      { path: ['docs'], order: 10, isIndex: true }, // 10_index.md
+      { path: ['docs', 'getting-started'] },
+    ],
+    expectedDiagnosticCount: 1,
+    expectedMessage: 'Numbered prefix on index file has no effect',
+    checkDiagnostic: (diagnostic) => {
+      expect(diagnostic).toMatchObject({
+        message: expect.stringContaining('Numbered prefix on index file has no effect'),
+        file: expect.objectContaining({
+          path: expect.objectContaining({
+            relative: expect.objectContaining({
+              name: 'index',
+            }),
           }),
         }),
-      }),
-      order: 10,
-    })
-  })
-
-  test('no warning for index files without numbered prefix', () => {
-    const routes: Route[] = [
-      createRoute(['docs'], undefined, true), // index.md
-      createRoute(['docs', 'getting-started']),
-    ]
-
-    const result = lint(routes)
-
-    expect(result.diagnostics).toHaveLength(0)
-  })
-
-  test('warns about numbered prefix conflicts', () => {
-    const routes: Route[] = [
-      createRoute(['about'], 10), // 10_about.md
-      createRoute(['about'], 20), // 20_about.md
-    ]
-
-    const result = lint(routes)
-
-    expect(result.diagnostics).toHaveLength(1)
-    expect(result.diagnostics[0]).toMatchObject({
-      message: expect.stringContaining('conflicting routes due to numbered prefixes'),
-      kept: expect.objectContaining({ order: 20 }),
-      dropped: expect.objectContaining({ order: 10 }),
-    })
-  })
-
-  test('warns about index/literal conflicts', () => {
-    const routes: Route[] = [
-      createRoute(['docs'], undefined, true), // docs/index.md
-      createRoute(['docs']), // docs.md
-    ]
-
-    const result = lint(routes)
-
-    expect(result.diagnostics).toHaveLength(1)
-    expect(result.diagnostics[0]).toMatchObject({
-      message: expect.stringContaining('conflicting routes'),
-      literal: expect.any(Object),
-      index: expect.any(Object),
-    })
-  })
-
-  test('warns about numbered prefix conflicts with same order number', () => {
-    const routes: Route[] = [
-      createRoute(['about'], 10), // 10_about.md
-      createRoute(['about'], 10), // 10-about.md (same order)
-    ]
-
-    const result = lint(routes)
-
-    expect(result.diagnostics).toHaveLength(1)
-    expect(result.diagnostics[0]).toMatchObject({
-      message: expect.stringContaining('Both files have the same order number (10)'),
-      kept: expect.objectContaining({ order: 10 }),
-      dropped: expect.objectContaining({ order: 10 }),
-    })
-  })
+        order: 10,
+      })
+    }
+  },
+  { 
+    name: 'no warning for index files without numbered prefix',
+    routes: [
+      { path: ['docs'], isIndex: true }, // index.md
+      { path: ['docs', 'getting-started'] },
+    ],
+    expectedDiagnosticCount: 0,
+  },
+  { 
+    name: 'warns about numbered prefix conflicts',
+    routes: [
+      { path: ['about'], order: 10 }, // 10_about.md
+      { path: ['about'], order: 20 }, // 20_about.md
+    ],
+    expectedDiagnosticCount: 1,
+    expectedMessage: 'conflicting routes due to numbered prefixes',
+    checkDiagnostic: (diagnostic) => {
+      expect(diagnostic).toMatchObject({
+        message: expect.stringContaining('conflicting routes due to numbered prefixes'),
+        kept: expect.objectContaining({ order: 20 }),
+        dropped: expect.objectContaining({ order: 10 }),
+      })
+    }
+  },
+  { 
+    name: 'warns about index/literal conflicts',
+    routes: [
+      { path: ['docs'], isIndex: true }, // docs/index.md
+      { path: ['docs'] }, // docs.md
+    ],
+    expectedDiagnosticCount: 1,
+    expectedMessage: 'conflicting routes',
+    checkDiagnostic: (diagnostic) => {
+      expect(diagnostic).toMatchObject({
+        message: expect.stringContaining('conflicting routes'),
+        literal: expect.any(Object),
+        index: expect.any(Object),
+      })
+    }
+  },
+  { 
+    name: 'warns about numbered prefix conflicts with same order number',
+    routes: [
+      { path: ['about'], order: 10 }, // 10_about.md
+      { path: ['about'], order: 10 }, // 10-about.md (same order)
+    ],
+    expectedDiagnosticCount: 1,
+    expectedMessage: 'Both files have the same order number (10)',
+    checkDiagnostic: (diagnostic) => {
+      expect(diagnostic).toMatchObject({
+        message: expect.stringContaining('Both files have the same order number (10)'),
+        kept: expect.objectContaining({ order: 10 }),
+        dropped: expect.objectContaining({ order: 10 }),
+      })
+    }
+  },
+], ({ routes, expectedDiagnosticCount, expectedMessage, checkDiagnostic }) => {
+  const routeObjects = routes.map(r => createRoute(r.path, r.order, r.isIndex))
+  const result = lint(routeObjects)
+  
+  expect(result.diagnostics).toHaveLength(expectedDiagnosticCount)
+  
+  if (expectedDiagnosticCount > 0 && checkDiagnostic) {
+    checkDiagnostic(result.diagnostics[0])
+  }
 })

package/src/lib/file-router/route.ts

@@ -42,7 +42,7 @@ export interface Route {
 
 export interface RouteLogical {
   path: Path
-  order?: number
+  order?: number | undefined
 }
 
 export interface RouteFile {