@eggjs/development

@eggjs/development

This is an egg plugin for local development, under development environment enabled by default, and closed under other environment.

@eggjs/development has been built-in for egg. It is enabled by default.

Requirements

• egg >= 4.x

Configuration

see config/config.default.ts for more detail.

Features

• Under development environment, Output request log in STDOUT, statistic and output all key parts time-consuming;
• Watch file changes, and reload application；

About Reload

Under the following directory (including subdirectories) will watch file changes under development environment by default, trigger an Egg development environment server reload:

• ${app_root}/app
• ${app_root}/config
• ${app_root}/mocks
• ${app_root}/mocks_proxy
• ${app_root}/app.js

set config.development.overrideDefault to true to skip defaults merge.

Under the following directory (including subdirectories) will ignore file changes under development environment by default:

• ${app_root}/app/view
• ${app_root}/app/assets
• ${app_root}/app/public
• ${app_root}/app/web

set config.development.overrideIgnore to true to skip defaults merge.

Developer can use config.reloadPattern(multimatch) to control whether to reload.

// config/config.default.ts
export default = {
  development: {
    // don't reload when css fileChanged
    // https://github.com/sindresorhus/multimatch
    reloadPattern: ['**', '!**/*.css'],
  },
};

Loader Trace

You can view loader trace for performance issue from http://127.0.0.1:7001/__loader_trace__

Questions & Suggestions

Please open an issue here.

License

MIT

Contributors

Made with contributors-img.

Changelog

4.0.0 (2025-01-11)

⚠ BREAKING CHANGES

• drop Node.js < 18.19.0 support

part of https://github.com/eggjs/egg/issues/3644

https://github.com/eggjs/egg/issues/5257

<!-- This is an auto-generated comment: release notes by coderabbit.ai -->

Summary by CodeRabbit

Based on the comprehensive changes, here are the release notes:

Release Notes for @eggjs/development

• New Features

  • Added TypeScript support for development environment
  • Enhanced file watching and reloading mechanisms
  • Improved configuration options for development mode

• Breaking Changes

  • Migrated from egg-development to @eggjs/development
  • Requires Node.js version >=18.19.0
  • Dropped support for Node.js 14 and 16

• Improvements

  • Refined ESLint configuration
  • Updated GitHub Actions workflow to focus on macOS testing
  • Added more robust file change detection
  • Enhanced type safety across the project

• Bug Fixes

  • Improved handling of file reloading in different scenarios
  • Fixed potential issues with asset and service file monitoring

• Chores

  • Updated dependencies
  • Migrated test suite to TypeScript
  • Restructured project configuration

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Features

• support cjs and esm both by tshy (#34) (7a63cd6)