Skip to content

Commit 04e2bd8

Browse files
authored
feat: include logger plugin to the core export (#1783)
Ref vitejs/vite#334
1 parent 3bd49b7 commit 04e2bd8

File tree

5 files changed

+28
-5
lines changed

5 files changed

+28
-5
lines changed

Diff for: src/index.cjs.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import { Store, install } from './store'
22
import { mapState, mapMutations, mapGetters, mapActions, createNamespacedHelpers } from './helpers'
3+
import createLogger from './plugins/logger'
34

45
export default {
56
Store,
@@ -9,5 +10,6 @@ export default {
910
mapMutations,
1011
mapGetters,
1112
mapActions,
12-
createNamespacedHelpers
13+
createNamespacedHelpers,
14+
createLogger
1315
}

Diff for: src/index.js

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import { Store, install } from './store'
22
import { mapState, mapMutations, mapGetters, mapActions, createNamespacedHelpers } from './helpers'
3+
import createLogger from './plugins/logger'
34

45
export default {
56
Store,
@@ -9,7 +10,8 @@ export default {
910
mapMutations,
1011
mapGetters,
1112
mapActions,
12-
createNamespacedHelpers
13+
createNamespacedHelpers,
14+
createLogger
1315
}
1416

1517
export {
@@ -19,5 +21,6 @@ export {
1921
mapMutations,
2022
mapGetters,
2123
mapActions,
22-
createNamespacedHelpers
24+
createNamespacedHelpers,
25+
createLogger
2326
}

Diff for: types/index.d.ts

+5
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@ import _Vue, { WatchOptions } from "vue";
44
import "./vue";
55

66
import { mapState, mapMutations, mapGetters, mapActions, createNamespacedHelpers } from "./helpers";
7+
import createLogger from "./logger";
78

89
export * from "./helpers";
10+
export * from "./logger";
911

1012
export declare class Store<S> {
1113
constructor(options: StoreOptions<S>);
@@ -147,6 +149,8 @@ export interface ModuleTree<R> {
147149
[key: string]: Module<any, R>;
148150
}
149151

152+
export { createLogger }
153+
150154
declare const _default: {
151155
Store: typeof Store;
152156
install: typeof install;
@@ -155,5 +159,6 @@ declare const _default: {
155159
mapGetters: typeof mapGetters,
156160
mapActions: typeof mapActions,
157161
createNamespacedHelpers: typeof createNamespacedHelpers,
162+
createLogger: typeof createLogger
158163
};
159164
export default _default;

Diff for: types/logger.d.ts

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import { Payload, Plugin } from "./index";
2+
3+
export interface LoggerOption<S> {
4+
collapsed?: boolean;
5+
filter?: <P extends Payload>(mutation: P, stateBefore: S, stateAfter: S) => boolean;
6+
transformer?: (state: S) => any;
7+
mutationTransformer?: <P extends Payload>(mutation: P) => any;
8+
actionFilter?: <P extends Payload>(action: P, state: S) => boolean;
9+
actionTransformer?: <P extends Payload>(action: P) => any;
10+
logMutations?: boolean;
11+
logActions?: boolean;
12+
}
13+
14+
export default function createLogger<S>(option?: LoggerOption<S>): Plugin<S>;

Diff for: types/test/index.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import Vue from "vue";
22
import * as Vuex from "../index";
3-
import createLogger from "../../dist/logger";
43

54
Vue.use(Vuex);
65

@@ -438,7 +437,7 @@ namespace Plugins {
438437
});
439438
}
440439

441-
const logger = createLogger<{ value: number }>({
440+
const logger = Vuex.createLogger<{ value: number }>({
442441
collapsed: true,
443442
transformer: state => state.value,
444443
mutationTransformer: (mutation: { type: string }) => mutation.type

0 commit comments

Comments
 (0)