@eggjs/logrotator 5.0.0-beta.33 → 5.0.0-beta.34

package/README.md

@@ -13,36 +13,25 @@
 
 LogRotator for egg. Rotate all file of `app.loggers` by default
 
-## Install
-
-```bash
-npm i @eggjs/logrotator
-```
+egg built-in plugin `logrotator` is enabled by default.
 
 ## Usage
 
-- `plugin.js`
-
-```js
-exports.logrotator = {
-  enable: true,
-  package: '@eggjs/logrotator',
-};
-```
-
-- `config.default.js`
+- `config/config.default.ts`
 
-```js
+```ts
 // if any files need rotate by file size, config here
-exports.logrotator = {
-  filesRotateByHour: [], // list of files that will be rotated by hour
-  hourDelimiter: '-', // rotate the file by hour use specified delimiter
-  filesRotateBySize: [], // list of files that will be rotated by size
-  maxFileSize: 50 * 1024 * 1024, // Max file size to judge if any file need rotate
-  maxFiles: 10, // pieces rotate by size
-  rotateDuration: 60000, // time interval to judge if any file need rotate
-  maxDays: 31, // keep max days log files, default is `31`. Set `0` to keep all logs
-  gzip: false, // use gzip compress logger on rotate file, default is `false`. Set `true` to enable
+export default {
+  logrotator: {
+    filesRotateByHour: [], // list of files that will be rotated by hour
+    hourDelimiter: '-', // rotate the file by hour use specified delimiter
+    filesRotateBySize: [], // list of files that will be rotated by size
+    maxFileSize: 50 * 1024 * 1024, // Max file size to judge if any file need rotate
+    maxFiles: 10, // pieces rotate by size
+    rotateDuration: 60000, // time interval to judge if any file need rotate
+    maxDays: 31, // keep max days log files, default is `31`. Set `0` to keep all logs
+    gzip: false, // use gzip compress logger on rotate file, default is `false`. Set `true` to enable
+  },
 };
 ```
 
@@ -72,9 +61,9 @@ If `file` is relative path, then will normalize to `path.join(this.app.config.lo
 
 You can use `app.LogRotator` to customize.
 
-```js
-// app/schedule/custom.js
-module.exports = app => {
+```ts
+// app/schedule/custom.ts
+export default (app: Application) => {
   const rotator = getRotator(app);
   return {
     // https://github.com/eggjs/egg-schedule
@@ -88,7 +77,7 @@ module.exports = app => {
   };
 };
 
-function getRotator(app) {
+function getRotator(app: Application) {
   class CustomRotator extends app.LogRotator {
     // return map that contains a pair of srcPath and targetPath
     // LogRotator will rename ksrcPath to targetPath

package/README.zh-CN.md

@@ -15,12 +15,6 @@ egg 的日志切割插件，默认会按照时间切割所有的 app.loggers。
 
 ## 配置
 
-- `plugin.js`
-
-```js
-exports.logrotator = true;
-```
-
 - `config.default.js`
 
 ```js

package/dist/index.d.ts

@@ -1,4 +1,19 @@
-import './config/config.default.ts';
-import './app/extend/application.ts';
 import './types.ts';
+import { type EggPluginFactory } from 'egg';
+/**
+ * LogRotator plugin
+ *
+ * @since 4.1.0
+ * Usage:
+ * ```ts
+ * // config/plugin.ts
+ * import logrotatorPlugin from '@eggjs/logrotator';
+ *
+ * export default {
+ *   ...logrotatorPlugin(),
+ * };
+ * ```
+ */
+declare const _default: EggPluginFactory;
+export default _default;
 export * from './lib/rotator.ts';

package/dist/index.js

@@ -1,5 +1,24 @@
-import "./config/config.default.js";
-import "./app/extend/application.js";
 import "./types.js";
+import { definePluginFactory } from 'egg';
+/**
+ * LogRotator plugin
+ *
+ * @since 4.1.0
+ * Usage:
+ * ```ts
+ * // config/plugin.ts
+ * import logrotatorPlugin from '@eggjs/logrotator';
+ *
+ * export default {
+ *   ...logrotatorPlugin(),
+ * };
+ * ```
+ */
+export default definePluginFactory({
+    name: 'logrotator',
+    enable: true,
+    path: import.meta.dirname,
+    dependencies: ['schedule'],
+});
 export * from "./lib/rotator.js";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyw0QkFBNEIsQ0FBQztBQUNwQyxPQUFPLDZCQUE2QixDQUFDO0FBQ3JDLE9BQU8sWUFBWSxDQUFDO0FBRXBCLGNBQWMsa0JBQWtCLENBQUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxZQUFZLENBQUM7QUFFcEIsT0FBTyxFQUFFLG1CQUFtQixFQUF5QixNQUFNLEtBQUssQ0FBQztBQUVqRTs7Ozs7Ozs7Ozs7OztHQWFHO0FBQ0gsZUFBZSxtQkFBbUIsQ0FBQztJQUNqQyxJQUFJLEVBQUUsWUFBWTtJQUNsQixNQUFNLEVBQUUsSUFBSTtJQUNaLElBQUksRUFBRSxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU87SUFDekIsWUFBWSxFQUFFLENBQUMsVUFBVSxDQUFDO0NBQzNCLENBQXFCLENBQUM7QUFFdkIsY0FBYyxrQkFBa0IsQ0FBQyJ9

package/package.json

@@ -1,13 +1,7 @@
 {
   "name": "@eggjs/logrotator",
-  "version": "5.0.0-beta.33",
+  "version": "5.0.0-beta.34",
   "description": "logrotator for egg",
-  "eggPlugin": {
-    "name": "logrotator",
-    "dependencies": [
-      "schedule"
-    ]
-  },
   "keywords": [
     "egg",
     "eggPlugin",
@@ -58,7 +52,7 @@
     "utility": "^2.5.0"
   },
   "peerDependencies": {
-    "egg": "4.1.0-beta.33"
+    "egg": "4.1.0-beta.34"
   },
   "devDependencies": {
     "@types/node": "^24.9.1",
@@ -66,11 +60,11 @@
     "glob": "^11.0.0",
     "tsdown": "0.15.11",
     "typescript": "^5.9.3",
-    "vitest": "4.0.4",
-    "@eggjs/schedule": "6.0.0-beta.33",
-    "@eggjs/tsconfig": "3.1.0-beta.33",
-    "@eggjs/mock": "7.0.0-beta.33",
-    "egg": "4.1.0-beta.33"
+    "vitest": "4.0.5",
+    "@eggjs/mock": "7.0.0-beta.34",
+    "@eggjs/schedule": "6.0.0-beta.34",
+    "egg": "4.1.0-beta.34",
+    "@eggjs/tsconfig": "3.1.0-beta.34"
   },
   "files": [
     "dist"