@remix-run/dev is a development tool for building web applications using the Remix framework. It provides a set of utilities and commands to streamline the development process, including building, watching, and serving your application.

What are @remix-run/dev's main functionalities?

Build

The build feature compiles the client and server entry points into a production-ready build. This is useful for preparing your application for deployment.

const { build } = require('@remix-run/dev');

build({
  entryClientFile: 'src/entry.client.tsx',
  entryServerFile: 'src/entry.server.tsx',
  outputDir: 'build',
  publicPath: '/build/',
}).then(() => {
  console.log('Build completed!');
}).catch((error) => {
  console.error('Build failed:', error);
});

Watch

The watch feature monitors your source files for changes and automatically rebuilds the application. This is useful for development as it provides instant feedback on code changes.

const { watch } = require('@remix-run/dev');

watch({
  entryClientFile: 'src/entry.client.tsx',
  entryServerFile: 'src/entry.server.tsx',
  outputDir: 'build',
  publicPath: '/build/',
}).then(() => {
  console.log('Watching for changes...');
}).catch((error) => {
  console.error('Watch failed:', error);
});

Serve

The serve feature starts a local development server to serve your built application. This is useful for testing your application in a local environment.

const { serve } = require('@remix-run/dev');

serve({
  buildDir: 'build',
  port: 3000,
}).then(() => {
  console.log('Server is running on http://localhost:3000');
}).catch((error) => {
  console.error('Server failed to start:', error);
});

Other packages similar to @remix-run/dev

Welcome to Remix!

Remix is a web framework that helps you build better websites with React.

To get started, open a new shell and run:

npx create-remix@latest

Then follow the prompts you see in your terminal.

For more information about Remix, visit remix.run!

v2.13.0

Date: 2024-10-11

What's Changed

Stabilized APIs

This release stabilizes a handful of "unstable" APIs in preparation for the pending React Router v7 release (see these posts for more info):

unstable_data → data (for use with Single Fetch)
unstable_flushSync → flushSync (useSubmit, fetcher.load, fetcher.submit)
unstable_viewTransition → viewTransition (<Link>, <Form>, useNavigate, useSubmit)
~~future.unstable_optimizeDeps → future.v3_optimizeDeps (Docs)~~
- ⚠️ This flag was not intended to stabilize in Remix v2 and was reverted back to future.unstable_optimizeDeps in 2.13.1
future.unstable_lazyRouteDiscovery → future.v3_lazyRouteDiscovery (Docs)
future.unstable_singleFetch → future.v3_singleFetch (Docs)

Minor Changes

Stabilize React Router APIs in Remix (#9980)
- Adopt stabilized React Router APIs internally
  - Single Fetch: unstable_dataStrategy -> dataStrategy
  - Lazy Route Discovery: unstable_patchRoutesOnNavigation -> patchRoutesOnNavigation
- Stabilize public-facing APIs
  - Single Fetch: unstable_data() -> data()
  - unstable_viewTransition -> viewTransition (Link, Form, navigate, submit)
  - unstable_flushSync> -> <Link viewTransition> (Link, Form, navigate, submit, useFetcher)
Stabilize future flags (#10072, #10092)
- future.unstable_lazyRouteDiscovery -> future.v3_lazyRouteDiscovery
- future.unstable_optimizeDeps -> future.v3_optimizeDeps
- future.unstable_singleFetch -> future.v3_singleFetch

Patch Changes

@remix-run/dev - Stop passing request.signal as the renderToReadableStream signal to abort server rendering for cloudflare/deno runtimes because by the time that request is aborted, aborting the rendering is useless because there's no way for React to flush down the unresolved boundaries (#10047)
- This has been incorrect for some time, but only recently exposed due to a bug in how we were aborting requests when running via remix vite:dev because we were incorrectly aborting requests after successful renders - which was causing us to abort a completed React render, and try to close an already closed ReadableStream
- This has likely not shown up in any production scenarios because cloudflare/deno production runtimes are (correctly) not aborting the request.signal on successful renders
- The built-in entry.server files no longer pass a signal to renderToReadableStream because adding a timeout-based abort signal to the default behavior would constitute a breaking change
- Users can configure this abort behavior via their own entry.server via remix reveal entry.server, and the template entry.server files have been updated with an example approach for newly created Remix apps
@remix-run/express - Fix adapter logic for aborting request.signal so we don't incorrectly abort on the close event for successful requests (#10046)
@remix-run/react - Fix bug with clientLoader.hydrate in a layout route when hydrating with bubbled errors (#10063)

Updated Dependencies

Changes by Package

Full Changelog: v2.12.1...v2.13.0

FAQs

What is @remix-run/dev?

Is @remix-run/dev popular?

Is @remix-run/dev well maintained?

Package last updated on 11 Oct 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@remix-run/dev

What is @remix-run/dev?

What are @remix-run/dev's main functionalities?

Other packages similar to @remix-run/dev

webpack

parcel

vite

Welcome to Remix!

v2.13.0

What's Changed

Stabilized APIs

Minor Changes

Patch Changes

Updated Dependencies

Changes by Package

Related posts

Socket Now Supports uv.lock Files

Gmail For Exfiltration: Malicious npm Packages Target Solana Private Keys and Drain Victims' Wallets

New Python Packaging Proposal Aims to Solve Phantom Dependency Problem with SBOMs