Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(vue-extractor): fix default export burden with /api/extractors/babel #1626

Merged
merged 1 commit into from
Apr 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/cli/src/api/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ export { getCatalogForFile, getCatalogs } from "./catalog/getCatalogs"

export { createCompiledCatalog } from "./compile"

export { default as extractor } from "./extractors/babel"

export * from "./types"
7 changes: 4 additions & 3 deletions packages/extractor-vue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,13 @@ npm install --save-dev @lingui/extractor-vue

## Usage

This custom extractor requires that you use JavaScript for your Lingui configuration.
This custom extractor requires that you use JavaScript or TypeScript for your Lingui configuration.

```js
import { vueExtractor } from "@lingui/extractor-vue"
import babel from "@lingui/cli/api/extractors/babel"
import { extractor as defaultExtractor } from "@lingui/cli/api"

/** @type {import('@lingui/conf').LinguiConfig} */
const linguiConfig = {
locales: ["en", "nb"],
sourceLocale: "en",
Expand All @@ -31,7 +32,7 @@ const linguiConfig = {
include: ["<rootDir>/src"],
},
],
extractors: [babel, vueExtractor],
extractors: [defaultExtractor, vueExtractor],
}

export default linguiConfig
Expand Down
12 changes: 8 additions & 4 deletions packages/extractor-vue/src/vue-extractor.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { parse, compileTemplate, SFCBlock } from "@vue/compiler-sfc"
import babel from "@lingui/cli/api/extractors/babel"
import { extractor } from "@lingui/cli/api"
import type { ExtractorCtx, ExtractorType } from "@lingui/conf"

export const vueExtractor: ExtractorType = {
Expand All @@ -18,17 +18,21 @@ export const vueExtractor: ExtractorType = {
ignoreEmpty: true,
})

const isTsBlock = (block: SFCBlock) => block?.lang === "ts"

const compiledTemplate =
descriptor.template &&
compileTemplate({
source: descriptor.template.content,
filename,
inMap: descriptor.template.map,
id: filename,
compilerOptions: {
isTS:
isTsBlock(descriptor.script) || isTsBlock(descriptor.scriptSetup),
},
})

const isTsBlock = (block: SFCBlock) => block?.lang === "ts"

const targets = [
[
descriptor.script?.content,
Expand All @@ -51,7 +55,7 @@ export const vueExtractor: ExtractorType = {
targets
.filter(([source]) => Boolean(source))
.map(([source, map, isTs]) =>
babel.extract(
extractor.extract(
filename + (isTs ? ".ts" : ""),
source,
onMessageExtracted,
Expand Down
5 changes: 1 addition & 4 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,7 @@
"@lingui/macro": ["./packages/macro/src"],
"@lingui/format-po": ["./packages/format-po/src/po.ts"],
"@lingui/format-json": ["./packages/format-json/src/json.ts"],
"@lingui/extractor-vue": ["./packages/extractor-vue/src"],
"@lingui/cli/api/extractors/babel": [
"./packages/cli/src/api/extractors/babel"
]
"@lingui/extractor-vue": ["./packages/extractor-vue/src"]
}
},
"exclude": [
Expand Down
4 changes: 2 additions & 2 deletions website/docs/guides/custom-extractor.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ If your project is not working well with Lingui's Extractor, you can write your
That might be the case if you use some experimental features (stage0 - stage2) or frameworks with custom syntax such as Vue.js or Svelte.

```ts title="./my-custom-extractor.ts"
import babel from "@lingui/cli/api/extractors/babel"
import { extractor as defaultExtractor } from "@lingui/cli/api"

export const extractor: ExtractorType = {
match(filename: string) {
Expand All @@ -17,7 +17,7 @@ export const extractor: ExtractorType = {

// you can acess lingui config from using `ctx.linguiConfig`
// reuse extractor from cli
return babel.extract(filename, code, onMessageExtracted, {sourcemaps, ...ctx})
return defaultExtractor.extract(filename, code, onMessageExtracted, {sourcemaps, ...ctx})
}
}
```
Expand Down
5 changes: 3 additions & 2 deletions website/docs/tutorials/extractor-vue.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,13 @@ npm install --save-dev @lingui/extractor-vue

## Usage

It is required that you use JavaScript for your Lingui configuration.
It is required that you use JavaScript or TypeScript for your Lingui configuration.

```js title="lingui.config.{js,ts}"
import { vueExtractor } from "@lingui/extractor-vue"
import babel from "@lingui/cli/api/extractors/babel"
import { extractor as defaultExtractor } from "@lingui/cli/api"

/** @type {import('@lingui/conf').LinguiConfig} */
const linguiConfig = {
locales: ["en", "nb"],
sourceLocale: "en",
Expand Down