Skip to content

Commit

Permalink
fix: reduce devtools pkgs and size (#1823)
Browse files Browse the repository at this point in the history
  • Loading branch information
kazupon authored Apr 26, 2024
1 parent 16b78e3 commit 7f15c7b
Show file tree
Hide file tree
Showing 34 changed files with 222 additions and 390 deletions.
3 changes: 1 addition & 2 deletions packages/core-base/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@
"@intlify/shared": "workspace:*"
},
"devDependencies": {
"@intlify/devtools-if": "workspace:*",
"@intlify/vue-devtools": "workspace:*"
"@intlify/devtools-types": "workspace:*"
},
"engines": {
"node": ">= 16"
Expand Down
7 changes: 2 additions & 5 deletions packages/core-base/src/context.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,13 @@ import {
isObject,
warnOnce
} from '@intlify/shared'
import { VueDevToolsTimelineEvents } from '@intlify/vue-devtools'
import { initI18nDevTools } from './devtools'
import { CoreWarnCodes, getWarnMessage } from './warnings'
import { resolveWithKeyValue } from './resolver'
import { fallbackWithSimple } from './fallbacker'

import type { CompileOptions, ResourceNode } from '@intlify/message-compiler'
// HACK: embbed `@intlify/vue-devtools` types to `.d.ts`, because `@intlify/dev-tools` is devDependencies
// TODO: Consider this type dependency when separating into intlify/core
import type { VueDevToolsEmitter } from '../../vue-devtools/src/index'
import type { VueDevToolsEmitter } from '@intlify/devtools-types'
import type { Path, MessageResolver } from './resolver'
import type {
Locale,
Expand Down Expand Up @@ -661,7 +658,7 @@ export function handleMissing<Message = string>(
if (__DEV__) {
const emitter = (context as unknown as CoreInternalContext).__v_emitter
if (emitter) {
emitter.emit(VueDevToolsTimelineEvents.MISSING, {
emitter.emit('missing', {
locale,
key,
type,
Expand Down
3 changes: 1 addition & 2 deletions packages/core-base/src/datetime.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ import { CoreWarnCodes, getWarnMessage } from './warnings'
import { CoreErrorCodes, createCoreError } from './errors'
import { getLocale } from './fallbacker'
import { Availabilities } from './intl'
import { VueDevToolsTimelineEvents } from '@intlify/vue-devtools'

import type { Locale, FallbackLocale } from './runtime'
import type {
Expand Down Expand Up @@ -254,7 +253,7 @@ export function datetime<
if (__DEV__ && locale !== targetLocale) {
const emitter = (context as unknown as CoreInternalContext).__v_emitter
if (emitter) {
emitter.emit(VueDevToolsTimelineEvents.FALBACK, {
emitter.emit('fallback', {
type,
key,
from,
Expand Down
17 changes: 7 additions & 10 deletions packages/core-base/src/devtools.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
// HACK: embbed `@intlify/devtools-if` enum and type to `.d.ts`, because `@intlify/dev-tools` is devDependencies
// TODO: Consider this type dependency when separating into intlify/core
import {
import type {
IntlifyDevToolsHooks,
IntlifyDevToolsEmitter,
IntlifyDevToolsHookPayloads
} from '../../devtools-if/src/index'
IntlifyDevToolsHookPayloads,
IntlifyDevToolsEmitter
} from '@intlify/devtools-types'

let devtools: IntlifyDevToolsEmitter | null = null

Expand All @@ -23,17 +21,16 @@ export function initI18nDevTools(
): void {
// TODO: queue if devtools is undefined
devtools &&
devtools.emit(IntlifyDevToolsHooks.I18nInit, {
devtools.emit('i18n:init', {
timestamp: Date.now(),
i18n,
version,
meta
})
}

export const translateDevTools = /* #__PURE__*/ createDevToolsHook(
IntlifyDevToolsHooks.FunctionTranslate
)
export const translateDevTools =
/* #__PURE__*/ createDevToolsHook('function:translate')

function createDevToolsHook(hook: IntlifyDevToolsHooks) {
return (payloads: IntlifyDevToolsHookPayloads[IntlifyDevToolsHooks]) =>
Expand Down
3 changes: 1 addition & 2 deletions packages/core-base/src/number.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ import { CoreWarnCodes, getWarnMessage } from './warnings'
import { CoreErrorCodes, createCoreError } from './errors'
import { Availabilities } from './intl'
import { getLocale } from './fallbacker'
import { VueDevToolsTimelineEvents } from '@intlify/vue-devtools'

import type { Locale, FallbackLocale } from './runtime'
import type {
Expand Down Expand Up @@ -249,7 +248,7 @@ export function number<
if (__DEV__ && locale !== targetLocale) {
const emitter = (context as unknown as CoreInternalContext).__v_emitter
if (emitter) {
emitter.emit(VueDevToolsTimelineEvents.FALBACK, {
emitter.emit('fallback', {
type,
key,
from,
Expand Down
19 changes: 9 additions & 10 deletions packages/core-base/src/translate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,9 @@ import { CoreWarnCodes, getWarnMessage } from './warnings'
import { CoreErrorCodes, createCoreError } from './errors'
import { translateDevTools } from './devtools'
import { getLocale } from './fallbacker'
import { VueDevToolsTimelineEvents } from '@intlify/vue-devtools'

import type { CompileError, ResourceNode } from '@intlify/message-compiler'
import type { AdditionalPayloads } from '@intlify/devtools-if'
import type { AdditionalPayloads } from '@intlify/devtools-types'
import type { Path, PathValue } from './resolver'
import type {
Locale,
Expand Down Expand Up @@ -856,7 +855,7 @@ function resolveMessageFormat<Messages, Message>(
if (__DEV__ && locale !== targetLocale) {
const emitter = (context as unknown as CoreInternalContext).__v_emitter
if (emitter) {
emitter.emit(VueDevToolsTimelineEvents.FALBACK, {
emitter.emit('fallback', {
type,
key,
from,
Expand Down Expand Up @@ -890,8 +889,8 @@ function resolveMessageFormat<Messages, Message>(
const end = window.performance.now()
const emitter = (context as unknown as CoreInternalContext).__v_emitter
if (emitter && start && format) {
emitter.emit(VueDevToolsTimelineEvents.MESSAGE_RESOLVE, {
type: VueDevToolsTimelineEvents.MESSAGE_RESOLVE,
emitter.emit('message-resolve', {
type: 'message-resolve',
key,
message: format,
time: end - start,
Expand Down Expand Up @@ -978,8 +977,8 @@ function compileMessageFormat<Messages, Message>(
const end = window.performance.now()
const emitter = (context as unknown as CoreInternalContext).__v_emitter
if (emitter && start) {
emitter.emit(VueDevToolsTimelineEvents.MESSAGE_COMPILATION, {
type: VueDevToolsTimelineEvents.MESSAGE_COMPILATION,
emitter.emit('message-compilation', {
type: 'message-compilation',
message: format as string | ResourceNode | MessageFunction,
time: end - start,
groupId: `${'translate'}:${key}`
Expand Down Expand Up @@ -1021,8 +1020,8 @@ function evaluateMessage<Messages, Message>(
const end = window.performance.now()
const emitter = (context as unknown as CoreInternalContext).__v_emitter
if (emitter && start) {
emitter.emit(VueDevToolsTimelineEvents.MESSAGE_EVALUATION, {
type: VueDevToolsTimelineEvents.MESSAGE_EVALUATION,
emitter.emit('message-evaluation', {
type: 'message-evaluation',
value: messaged,
time: end - start,
groupId: `${'translate'}:${(msg as MessageFunctionInternal).key}`
Expand Down Expand Up @@ -1108,7 +1107,7 @@ function getCompileContext<Messages, Message>(
)
const emitter = (context as unknown as CoreInternalContext).__v_emitter
if (emitter && _source) {
emitter.emit(VueDevToolsTimelineEvents.COMPILE_ERROR, {
emitter.emit('compile-error', {
message: _source,
error: err.message,
start: err.location && err.location.start.offset,
Expand Down
11 changes: 5 additions & 6 deletions packages/core-base/test/devtools.test.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
import { createCoreContext, translate } from '../src/index'
import { createEmitter } from '@intlify/shared'
import { createCoreContext, translate } from '../src/index'
import { compileToFunction } from '../src/compilation'
import { IntlifyDevToolsHooks } from '@intlify/devtools-if'
import { setDevToolsHook, getDevToolsHook } from '../src/devtools'

import type {
IntlifyDevToolsEmitterHooks,
IntlifyDevToolsEmitter
} from '@intlify/devtools-if'
} from '@intlify/devtools-types'

let devtools: IntlifyDevToolsEmitter | null = null
beforeEach(() => {
Expand All @@ -23,7 +22,7 @@ afterEach(() => {

test('initI18nDevTools', () => {
const fn = vi.fn()
devtools!.on(IntlifyDevToolsHooks.I18nInit, fn)
devtools!.on('i18n:init', fn)

const meta = { framework: 'Vue' }
const ctx = createCoreContext({
Expand All @@ -46,7 +45,7 @@ test('initI18nDevTools', () => {
describe('translateDevTools', () => {
test('basic', () => {
const fn = vi.fn()
devtools!.on(IntlifyDevToolsHooks.FunctionTranslate, fn)
devtools!.on('function:translate', fn)

const meta = { __INTLIFY_META__: 'xxx', framework: 'Vue' }
const HELLO = 'Hello {name}!'
Expand All @@ -73,7 +72,7 @@ describe('translateDevTools', () => {

test('fallback', () => {
const fn = vi.fn()
devtools!.on(IntlifyDevToolsHooks.FunctionTranslate, fn)
devtools!.on('function:translate', fn)

const HELLO = 'やあ {name}!'
const ctx = createCoreContext({
Expand Down
13 changes: 0 additions & 13 deletions packages/devtools-if/README.md

This file was deleted.

7 changes: 0 additions & 7 deletions packages/devtools-if/index.js

This file was deleted.

70 changes: 0 additions & 70 deletions packages/devtools-if/package.json

This file was deleted.

42 changes: 0 additions & 42 deletions packages/devtools-if/src/index.ts

This file was deleted.

Empty file removed packages/devtools-if/test/.gitkeep
Empty file.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2021 kazuya kawaguchi
Copyright (c) 2024 kazuya kawaguchi

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand Down
5 changes: 5 additions & 0 deletions packages/devtools-types/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# @intlify/devtools-types

## :copyright: License

[MIT](http://opensource.org/licenses/MIT)
File renamed without changes.
7 changes: 7 additions & 0 deletions packages/devtools-types/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
'use strict'

if (process.env.NODE_ENV === 'production') {
module.exports = require('./dist/devtools-types.prod.cjs')
} else {
module.exports = require('./dist/devtools-types.cjs')
}
Loading

0 comments on commit 7f15c7b

Please sign in to comment.