Skip to content

Commit ccce3b6

Browse files
kazuponkazupon
authored
improvement: api exporting (#237)
* improvement: api exporting * fix: formatting
1 parent b595389 commit ccce3b6

File tree

11 files changed

+3
-56
lines changed

11 files changed

+3
-56
lines changed

‎format-explorer/webpack.config.js‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ module.exports = {
1616
},
1717
alias: {
1818
vue: require.resolve('vue/dist/vue.esm-bundler.js'),
19-
'@intlify/message-compiler': require.resolve('../packages/message-compiler/dist/message-compiler.cjs.js')
19+
'@intlify/message-compiler': require.resolve(
20+
'../packages/message-compiler/dist/message-compiler.cjs.js'
21+
)
2022
}
2123
},
2224
module: {

‎packages/core-base/src/compile.ts‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,10 @@ function checkHtmlMessage(source: string, options: CompileOptions): void {
1919
const defaultOnCacheKey = (source: string): string => source
2020
let compileCache: unknown = Object.create(null)
2121

22-
/** @internal */
2322
export function clearCompileCache(): void {
2423
compileCache = Object.create(null)
2524
}
2625

27-
/** @internal */
2826
export function compileToFunction<T = string>(
2927
source: string,
3028
options: CompileOptions = {}

‎packages/core-base/src/context.ts‎

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@ export type LocaleMessages<Message = string> = Record<
6161

6262
export type CoreMissingType = 'translate' | 'datetime format' | 'number format'
6363

64-
/** @internal */
6564
export type CoreMissingHandler<Message = string> = (
6665
context: CoreCommonContext<Message>,
6766
locale: Locale,
@@ -74,13 +73,11 @@ export type PostTranslationHandler<Message = string> = (
7473
translated: MessageType<Message>
7574
) => MessageType<Message>
7675

77-
/** @internal */
7876
export type MessageCompiler<Message = string> = (
7977
source: string,
8078
options?: CompileOptions
8179
) => MessageFunction<Message>
8280

83-
/** @internal */
8481
export interface CoreOptions<Message = string> {
8582
locale?: Locale
8683
fallbackLocale?: FallbackLocale
@@ -102,14 +99,12 @@ export interface CoreOptions<Message = string> {
10299
onWarn?: (msg: string, err?: Error) => void
103100
}
104101

105-
/** @internal */
106102
export interface CoreInternalOptions {
107103
__datetimeFormatters?: Map<string, Intl.DateTimeFormat>
108104
__numberFormatters?: Map<string, Intl.NumberFormat>
109105
__emitter?: DevToolsEmitter // for vue-devtools timeline event
110106
}
111107

112-
/** @internal */
113108
export interface CoreCommonContext<Message = string> {
114109
locale: Locale
115110
fallbackLocale: FallbackLocale
@@ -121,7 +116,6 @@ export interface CoreCommonContext<Message = string> {
121116
onWarn(msg: string, err?: Error): void
122117
}
123118

124-
/** @internal */
125119
export interface CoreTranslationContext<Messages = {}, Message = string>
126120
extends CoreCommonContext<Message> {
127121
messages: Messages
@@ -134,19 +128,16 @@ export interface CoreTranslationContext<Messages = {}, Message = string>
134128
messageCompiler: MessageCompiler<Message> | null
135129
}
136130

137-
/** @internal */
138131
export interface CoreDateTimeContext<DateTimeFormats = {}, Message = string>
139132
extends CoreCommonContext<Message> {
140133
datetimeFormats: DateTimeFormats
141134
}
142135

143-
/** @internal */
144136
export interface CoreNumberContext<NumberFormats = {}, Message = string>
145137
extends CoreCommonContext<Message> {
146138
numberFormats: NumberFormats
147139
}
148140

149-
/** @internal */
150141
export interface CoreContext<
151142
Messages = {},
152143
DateTimeFormats = {},
@@ -156,18 +147,15 @@ export interface CoreContext<
156147
CoreDateTimeContext<DateTimeFormats, Message>,
157148
CoreNumberContext<NumberFormats, Message> {}
158149

159-
/** @internal */
160150
export interface CoreInternalContext {
161151
__datetimeFormatters: Map<string, Intl.DateTimeFormat>
162152
__numberFormatters: Map<string, Intl.NumberFormat>
163153
__localeChainCache?: Map<Locale, Locale[]>
164154
__emitter?: DevToolsEmitter // for vue-devtools timeline event
165155
}
166156

167-
/** @internal */
168157
export const NOT_REOSLVED = -1
169158

170-
/** @internal */
171159
export const MISSING_RESOLVE_VALUE = ''
172160

173161
function getDefaultLinkedModifiers<
@@ -188,14 +176,12 @@ function getDefaultLinkedModifiers<
188176

189177
let _compiler: unknown | null
190178

191-
/** @internal */
192179
export function registerMessageCompiler<Message>(
193180
compiler: MessageCompiler<Message>
194181
): void {
195182
_compiler = compiler
196183
}
197184

198-
/** @internal */
199185
export function createCoreContext<
200186
Message = string,
201187
Options extends CoreOptions<Message> = object,

‎packages/core-base/src/datetime.ts‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,38 +106,32 @@ export interface DateTimeOptions {
106106
}
107107

108108
// `datetime` function overloads
109-
/** @internal */
110109
export function datetime<DateTimeFormats, Message = string>(
111110
context: CoreDateTimeContext<DateTimeFormats, Message>,
112111
value: number | Date
113112
): string | number | Intl.DateTimeFormatPart[]
114-
/** @internal */
115113
export function datetime<DateTimeFormats, Message = string>(
116114
context: CoreDateTimeContext<DateTimeFormats, Message>,
117115
value: number | Date,
118116
key: string
119117
): string | number | Intl.DateTimeFormatPart[]
120-
/** @internal */
121118
export function datetime<DateTimeFormats, Message = string>(
122119
context: CoreDateTimeContext<DateTimeFormats, Message>,
123120
value: number | Date,
124121
key: string,
125122
locale: Locale
126123
): string | number | Intl.DateTimeFormatPart[]
127-
/** @internal */
128124
export function datetime<DateTimeFormats, Message = string>(
129125
context: CoreDateTimeContext<DateTimeFormats, Message>,
130126
value: number | Date,
131127
options: DateTimeOptions
132128
): string | number | Intl.DateTimeFormatPart[]
133-
/** @internal */
134129
export function datetime<DateTimeFormats, Message = string>(
135130
context: CoreDateTimeContext<DateTimeFormats, Message>,
136131
...args: unknown[]
137132
): string | number | Intl.DateTimeFormatPart[] // for internal
138133

139134
// implementation of `datetime` function
140-
/** @internal */
141135
export function datetime<DateTimeFormats, Message = string>(
142136
context: CoreDateTimeContext<DateTimeFormats, Message>,
143137
...args: unknown[]

‎packages/core-base/src/errors.ts‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,17 @@ import {
44
} from '@intlify/message-compiler'
55
import type { CompileError } from '@intlify/message-compiler'
66

7-
/** @internal */
87
export interface CoreError extends CompileError {
98
code: CoreErrorCodes
109
}
1110

12-
/** @internal */
1311
export const enum CoreErrorCodes {
1412
INVALID_ARGUMENT = CompileErrorCodes.__EXTEND_POINT__,
1513
INVALID_DATE_ARGUMENT,
1614
INVALID_ISO_DATE_ARGUMENT,
1715
__EXTEND_POINT__
1816
}
1917

20-
/** @internal */
2118
export function createCoreError(code: CoreErrorCodes): CoreError {
2219
return createCompileError(
2320
code,

‎packages/core-base/src/number.ts‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -100,38 +100,32 @@ export interface NumberOptions {
100100
}
101101

102102
// `number` function overloads
103-
/** @internal */
104103
export function number<NumberFormats, Message = string>(
105104
context: CoreNumberContext<NumberFormats, Message>,
106105
value: number
107106
): string | number | Intl.NumberFormatPart[]
108-
/** @internal */
109107
export function number<NumberFormats, Message = string>(
110108
context: CoreNumberContext<NumberFormats, Message>,
111109
value: number,
112110
key: string
113111
): string | number | Intl.NumberFormatPart[]
114-
/** @internal */
115112
export function number<NumberFormats, Message = string>(
116113
context: CoreNumberContext<NumberFormats, Message>,
117114
value: number,
118115
key: string,
119116
locale: Locale
120117
): string | number | Intl.NumberFormatPart[]
121-
/** @internal */
122118
export function number<NumberFormats, Message = string>(
123119
context: CoreNumberContext<NumberFormats, Message>,
124120
value: number,
125121
options: NumberOptions
126122
): string | number | Intl.NumberFormatPart[]
127-
/** @internal */
128123
export function number<NumberFormats, Message = string>(
129124
context: CoreNumberContext<NumberFormats, Message>,
130125
...args: unknown[]
131126
): string | number | Intl.NumberFormatPart[] // for internal
132127

133128
// implementation of `number` function
134-
/** @internal */
135129
export function number<NumberFormats, Message = string>(
136130
context: CoreNumberContext<NumberFormats, Message>,
137131
...args: unknown[]

‎packages/core-base/src/translate.ts‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -146,99 +146,84 @@ export interface TranslateOptions {
146146
}
147147

148148
// `translate` function overloads
149-
/** @internal */
150149
export function translate<Messages, Message = string>(
151150
context: CoreTranslationContext<Messages, Message>,
152151
key: Path
153152
): MessageType<Message> | number
154-
/** @internal */
155153
export function translate<Messages, Message = string>(
156154
context: CoreTranslationContext<Messages, Message>,
157155
key: Path,
158156
plural: number
159157
): MessageType<Message> | number
160-
/** @internal */
161158
export function translate<Messages, Message = string>(
162159
context: CoreTranslationContext<Messages, Message>,
163160
key: Path,
164161
plural: number,
165162
options: TranslateOptions
166163
): MessageType<Message> | number
167-
/** @internal */
168164
export function translate<Messages, Message = string>(
169165
context: CoreTranslationContext<Messages, Message>,
170166
key: Path,
171167
defaultMsg: string
172168
): MessageType<Message> | number
173-
/** @internal */
174169
export function translate<Messages, Message = string>(
175170
context: CoreTranslationContext<Messages, Message>,
176171
key: Path,
177172
defaultMsg: string,
178173
options: TranslateOptions
179174
): MessageType<Message> | number
180-
/** @internal */
181175
export function translate<Messages, Message = string>(
182176
context: CoreTranslationContext<Messages, Message>,
183177
key: Path,
184178
list: unknown[]
185179
): MessageType<Message> | number
186-
/** @internal */
187180
export function translate<Messages, Message = string>(
188181
context: CoreTranslationContext<Messages, Message>,
189182
key: Path,
190183
list: unknown[],
191184
plural: number
192185
): MessageType<Message> | number
193-
/** @internal */
194186
export function translate<Messages, Message = string>(
195187
context: CoreTranslationContext<Messages, Message>,
196188
key: Path,
197189
list: unknown[],
198190
defaultMsg: string
199191
): MessageType<Message> | number
200-
/** @internal */
201192
export function translate<Messages, Message = string>(
202193
context: CoreTranslationContext<Messages, Message>,
203194
key: Path,
204195
list: unknown[],
205196
options: TranslateOptions
206197
): MessageType<Message> | number
207-
/** @internal */
208198
export function translate<Messages, Message = string>(
209199
context: CoreTranslationContext<Messages, Message>,
210200
key: Path,
211201
named: NamedValue
212202
): MessageType<Message> | number
213-
/** @internal */
214203
export function translate<Messages, Message = string>(
215204
context: CoreTranslationContext<Messages, Message>,
216205
key: Path,
217206
named: NamedValue,
218207
plural: number
219208
): MessageType<Message> | number
220-
/** @internal */
221209
export function translate<Messages, Message = string>(
222210
context: CoreTranslationContext<Messages, Message>,
223211
key: Path,
224212
named: NamedValue,
225213
defaultMsg: string
226214
): MessageType<Message> | number
227-
/** @internal */
228215
export function translate<Messages, Message = string>(
229216
context: CoreTranslationContext<Messages, Message>,
230217
key: Path,
231218
named: NamedValue,
232219
options: TranslateOptions
233220
): MessageType<Message> | number
234-
/** @internal */
235221
export function translate<Messages, Message = string>(
236222
context: CoreTranslationContext<Messages, Message>,
237223
...args: unknown[]
238224
): MessageType<Message> | number // for internal
239225

240226
// implementationo of `translate` function
241-
/** @internal */
242227
export function translate<Messages, Message = string>(
243228
context: CoreTranslationContext<Messages, Message>,
244229
...args: unknown[]

‎packages/core-base/src/warnings.ts‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import { format } from '@intlify/shared'
22

3-
/** @internal */
43
export const enum CoreWarnCodes {
54
NOT_FOUND_KEY,
65
FALLBACK_TO_TRANSLATE,
@@ -21,7 +20,6 @@ export const warnMessages: { [code: number]: string } = {
2120
[CoreWarnCodes.FALLBACK_TO_DATE_FORMAT]: `Fall back to datetime format '{key}' key with '{target}' locale.`
2221
}
2322

24-
/** @internal */
2523
export function getWarnMessage(
2624
code: CoreWarnCodes,
2725
...args: unknown[]

‎packages/message-compiler/src/errors.ts‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,12 @@ export interface CompileError extends SyntaxError {
1414
location?: SourceLocation
1515
}
1616

17-
/** @internal */
1817
export interface CreateCompileErrorOptions {
1918
domain?: CompileDomain
2019
messages?: { [code: number]: string }
2120
args?: unknown[]
2221
}
2322

24-
/** @internal */
2523
export const enum CompileErrorCodes {
2624
// tokenizer error codes
2725
EXPECTED_TOKEN,
@@ -63,7 +61,6 @@ export const errorMessages: { [code: number]: string } = {
6361
[CompileErrorCodes.UNEXPECTED_LEXICAL_ANALYSIS]: `Unexpected lexical analysis in token: '{0}'`
6462
}
6563

66-
/** @internal */
6764
export function createCompileError<T extends number>(
6865
code: T,
6966
loc: SourceLocation | null,

‎packages/shared/src/index.ts‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,17 +51,14 @@ export function format(message: string, ...args: any): string {
5151
const hasSymbol =
5252
typeof Symbol === 'function' && typeof Symbol.toStringTag === 'symbol'
5353

54-
/** @internal */
5554
export const makeSymbol = (name: string): symbol | string => hasSymbol ? Symbol(name) : name
5655

57-
/** @internal */
5856
export const generateFormatCacheKey = (
5957
locale: string,
6058
key: string,
6159
source: string
6260
): string => friendlyJSONstringify({ l: locale, k: key, s: source })
6361

64-
/** @internal */
6562
export const friendlyJSONstringify = (json: unknown): string =>
6663
JSON.stringify(json)
6764
.replace(/\u2028/g, '\\u2028')

0 commit comments

Comments
 (0)