Version Packages

[github-actions]

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

Releases

[email protected]

Major Changes

• 02facb1: Removes renoun/collections package export and all related types and utilities that were deprecated in v7.8.0.

  Breaking Changes

  The renoun/collections package was removed. To upgrade, move to the renoun/file-system package and use the Directory class instead. In most cases, you can replace Collection with Directory and CompositeCollection with EntryGroup.

  Before

  import { Collection, CompositeCollection } from 'renoun/collections'
  
  const docs = new Collection({
    filePattern: '*.mdx',
    baseDirectory: 'docs',
  })
  const components = new Collection({
    filePattern: '*.{ts,tsx}',
    baseDirectory: 'src/components',
  })
  const compositeCollection = new CompositeCollection(docs, components)

  After

  import { Directory, EntryGroup } from 'renoun/file-system'
  
  const docs = new Directory({
    path: 'docs',
    include: '*.mdx',
  })
  const components = new Directory({
    path: 'src/components',
    include: '*.{ts,tsx}',
  })
  const entryGroup = new EntryGroup({
    entries: [docs, components],
  })

• eda5977: Removes all *OrThrow methods from Directory and EntryGroup. This also exports two new custom errors, FileNotFoundError and FileExportNotFoundError to handle missing files and exports.

  Breaking Changes

  Directory and EntryGroup no longer have *OrThrow methods, use the respective methods instead. To get the same functionality as before, you can catch the error and handle it accordingly:

  import { Directory } from 'renoun/file-system'
  
  const posts = new Directory({ path: 'posts' })
  
  posts.getFile('hello-world', 'mdx').catch((error) => {
    if (error instanceof FileNotFoundError) {
      return undefined
    }
    throw error
  })

Minor Changes

• fcd11af: Now Directory#getParent throws when called for the root directory. This makes the method easier to work with and aligns better with File#getParent always returning a Directory instance.

• 71aa01f: Adds a default mdx loader to JavaScriptFile that uses the MDXRenderer component. This allows MDX files without imports to be rendered easily:

  import { Directory } from 'renoun/file-system'
  
  const posts = new Directory({ path: 'posts' })
  
  export default async function Page({
    params,
  }: {
    params: Promise<{ slug: string }>
  }) {
    const slug = (await params).slug
    const post = await posts.getFile(slug, 'mdx')
    const Content = await post.getExportValue('default')
  
    return <Content />
  }

• 21a952a: Adds File#getText method for retrieving the text contents of the file.

• e107c2f: Allows instantiating File and JavaScriptFile more easily using only a path:

  import { JavaScriptFile } from 'renoun/file-system'
  
  const indexFile = new JavaScriptFile({ path: 'src/index.ts' })
  const indexFileExports = await indexFile.getExports()

• 919b73d: Configures the JavaScript RegExp Engine for shiki.

• 213cc11: Adds an option for specifying the port number when using createServer from renoun/server:

  import { createServer } from 'renoun/server'
  
  createServer({ port: 3001 })

• 446effc: Exports FileSystem, MemoryFileSystem, and NodeFileSystem classes for creating custom file systems as well as Repository for normalizing git providers.

  import { Directory, MemoryFileSystem } from 'renoun/file-system'
  
  const fileSystem = new MemoryFileSystem({
    'index.mdx': '# Hello, World!',
  })
  const directory = new Directory({ fileSystem })

Patch Changes

• 7b90440: Fixes getType erroring when inferring a re-exported type.
• 54eeb9e: Fixes duplicate exports when there are overloads.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
renoun	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 5, 2025 7:16am