@lingui/extractor-vue 4.0.0-next.7

package/README.md

@@ -0,0 +1,46 @@
+[![License][badge-license]][license]
+[![Version][badge-version]][package]
+[![Downloads][badge-downloads]][package]
+
+# @lingui/vue-extractor
+
+This package contains a custom extractor that handles Vue.js files. It supports extracting messages from script and setup scripts as well as Vue templates.
+
+`@lingui/vue-extractor` is part of [LinguiJS][linguijs]. See the [documentation][documentation] for all information, tutorials and examples.
+
+## Installation
+
+```sh
+npm install --save-dev @lingui/extractor-vue
+```
+
+## Usage
+
+This custom extractor requires that you use JavaScript for your Lingui configuration.
+
+```js
+import { vueExtractor } from "@lingui/extractor-vue"
+import babel from "@lingui/cli/api/extractors/babel"
+
+const linguiConfig = {
+  locales: ["en", "nb"],
+  sourceLocale: "en",
+  catalogs: [
+    {
+      path: "<rootDir>/src/{locale}",
+      include: ["<rootDir>/src"],
+    },
+  ],
+  extractors: [babel, vueExtractor],
+}
+
+export default linguiConfig
+```
+
+## License
+
+This package is licensed under [MIT][license] license.
+
+[license]: https://github.com/lingui/js-lingui/blob/main/LICENSE
+[linguijs]: https://github.com/lingui/js-lingui
+[documentation]: https://lingui.dev/tutorials/extractor-vue

package/dist/index.cjs

@@ -0,0 +1,56 @@
+'use strict';
+
+const compilerSfc = require('@vue/compiler-sfc');
+const babel = require('@lingui/cli/api/extractors/babel');
+
+const vueExtractor = {
+  match(filename) {
+    return filename.endsWith(".vue");
+  },
+  async extract(filename, code, onMessageExtracted, ctx) {
+    const { descriptor } = compilerSfc.parse(code, {
+      sourceMap: true,
+      filename,
+      ignoreEmpty: true
+    });
+    const compiledTemplate = compilerSfc.compileTemplate({
+      source: descriptor.template.content,
+      filename,
+      inMap: descriptor.template.map,
+      id: filename
+    });
+    const isTsBlock = (block) => block?.lang === "ts";
+    const targets = [
+      [
+        descriptor.script?.content,
+        descriptor.script?.map,
+        isTsBlock(descriptor.script)
+      ],
+      [
+        descriptor.scriptSetup?.content,
+        descriptor.scriptSetup?.map,
+        isTsBlock(descriptor.scriptSetup)
+      ],
+      [
+        compiledTemplate?.code,
+        compiledTemplate?.map,
+        isTsBlock(descriptor.script) || isTsBlock(descriptor.scriptSetup)
+      ]
+    ];
+    await Promise.all(
+      targets.filter(([source]) => Boolean(source)).map(
+        ([source, map, isTs]) => babel.extract(
+          filename + (isTs ? ".ts" : ""),
+          source,
+          onMessageExtracted,
+          {
+            sourceMaps: map,
+            ...ctx
+          }
+        )
+      )
+    );
+  }
+};
+
+exports.vueExtractor = vueExtractor;

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { ExtractorType } from '@lingui/conf';
+
+declare const vueExtractor: ExtractorType;
+
+export { vueExtractor };

package/dist/index.mjs

@@ -0,0 +1,54 @@
+import { parse, compileTemplate } from '@vue/compiler-sfc';
+import babel from '@lingui/cli/api/extractors/babel';
+
+const vueExtractor = {
+  match(filename) {
+    return filename.endsWith(".vue");
+  },
+  async extract(filename, code, onMessageExtracted, ctx) {
+    const { descriptor } = parse(code, {
+      sourceMap: true,
+      filename,
+      ignoreEmpty: true
+    });
+    const compiledTemplate = compileTemplate({
+      source: descriptor.template.content,
+      filename,
+      inMap: descriptor.template.map,
+      id: filename
+    });
+    const isTsBlock = (block) => block?.lang === "ts";
+    const targets = [
+      [
+        descriptor.script?.content,
+        descriptor.script?.map,
+        isTsBlock(descriptor.script)
+      ],
+      [
+        descriptor.scriptSetup?.content,
+        descriptor.scriptSetup?.map,
+        isTsBlock(descriptor.scriptSetup)
+      ],
+      [
+        compiledTemplate?.code,
+        compiledTemplate?.map,
+        isTsBlock(descriptor.script) || isTsBlock(descriptor.scriptSetup)
+      ]
+    ];
+    await Promise.all(
+      targets.filter(([source]) => Boolean(source)).map(
+        ([source, map, isTs]) => babel.extract(
+          filename + (isTs ? ".ts" : ""),
+          source,
+          onMessageExtracted,
+          {
+            sourceMaps: map,
+            ...ctx
+          }
+        )
+      )
+    );
+  }
+};
+
+export { vueExtractor };

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@lingui/extractor-vue",
+  "version": "4.0.0-next.7",
+  "description": "Custom Vue.js extractor to be used with the CLI tool",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "keywords": [
+    "cli",
+    "i18n",
+    "internationalization",
+    "i10n",
+    "localization",
+    "i9n",
+    "translation",
+    "vue"
+  ],
+  "repository": "lingui/js-lingui",
+  "bugs": "https://github.com/lingui/js-lingui/issues",
+  "license": "MIT",
+  "author": {
+    "name": "Christoffer Jahren",
+    "email": "christoffer@jahren.it"
+  },
+  "scripts": {
+    "build": "rimraf ./dist && unbuild",
+    "stub": "unbuild --stub"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "/dist"
+  ],
+  "dependencies": {
+    "@lingui/cli": "^4.0.0-next.7",
+    "@lingui/conf": "^4.0.0-next.7",
+    "@vue/compiler-sfc": "^3.2.47"
+  },
+  "devDependencies": {
+    "@lingui/babel-plugin-extract-messages": "^4.0.0-next.7",
+    "unbuild": "^1.1.2"
+  }
+}