Scoped Library Extractor
In some cases, you may need to include translations within your npm libraries, especially in a monorepo environment. This allows you to keep translation files inside the library's folder and package them together. However, loading translation files directly from the library can be challenging for two main reasons:
The applicationβs public directory isn't directly accessible.
Webpack dynamic imports donβt work with libraries.
To overcome these issues, the only option is to load the translation files from the application's public folder. This means you would need to manually copy the translation files from the library to the application's translation folder, which can be repetitive and error-prone.
This is where the Scoped Library Extractor tool comes in, which automates this process for you.
Example Setup
Let's consider a monorepo with the following structure:
π¦ projects
β£ π core
β β£ π src
β β β£ π lib
β β β β£ core.component.ts
β β β β£ core.module.ts
β β β β£ π i18n
β β β β β£ en.json
β β β β β es.json
β β β£ public-api.ts
β£ ng-package.json
β£ package.json
π¦ src
β£ π app
β β£ app.component.html
β β£ app.component.ts
β β£ app.module.ts
β β transloco.loader.ts
β£ π assets
β β£ π i18n
β β β£ en.json
β β β es.json
Here, we have a core library with its own translation files located under projects/core/src/lib/i18n
. To use these translations in our application, we need to configure the libraryβs translations in the CoreModule
.
Declare the Translation Scope
In the CoreModule
, provide the scope for the translations:
import { provideTranslocoScope } from './transloco.providers';
@NgModule({
declarations: [CoreComponent],
providers: [provideTranslocoScope('core')],
imports: [TranslocoModule],
})
export class CoreModule {}
Then, in the CoreComponent
, use the translations with the defined scope:
<ng-container *transloco="let t">
{{ t('core.title') }}
</ng-container>
Configure the Global Transloco Config
In your global transloco.config.ts
, add the path to the library in the scopedLibs
configuration:
const config: TranslocoGlobalConfig = {
scopedLibs: ['./projects/core/', '@lib/name']
};
If you need to specify multiple destinations for the extracted files, you can also use an object configuration:
const config: TranslocoGlobalConfig = {
scopedLibs: [
{
src: './projects/core',
dist: ['./projects/spa/src/assets/i18n', './src/assets/i18n/']
}
]
};
Run the Script
Now, run the script to extract the translation files from the library and copy them to the main project's translation folder:
pnpm transloco:extract-scoped-libs
This script will:
Extract the translation files from the library.
Copy them to the main project's
src/assets/i18n
folder.Add the libraryβs translation files to
.gitignore
(use the--skip-gitignore
flag if you want to skip this step).
Join Strategies
The tool supports two strategies for handling translations:
Default Strategy: The translation files from the library will be copied individually into the main project's translation folder.
Join Strategy: All translation files from the library will be combined into a single file (e.g.,
en.vendor.json
), which can then be loaded alongside the main translation files.
To use the Join Strategy, modify the package.json
of the library:
{
"name": "@app/core",
"i18n": [
{
"scope": "core",
"path": "src/lib/i18n",
"strategy": "join"
}
]
}
Then, in your application loader, you can use the following setup to load both the main and vendor translations:
// transloco-loader.ts
@Injectable({ providedIn: 'root' })
export class HttpLoader implements TranslocoLoader {
constructor(private http: HttpClient) {}
getTranslation(lang: string, { scope }) {
const base = this.http.get(`/assets/i18n/${lang}.json`);
if (scope) {
return base;
}
return forkJoin([
base,
this.http.get(`/assets/i18n/${lang}.vendor.json`),
]).pipe(
map(([translation, vendor]) => {
return { ...translation, ...vendor };
}),
);
}
}
export const httpLoader = { provide: TRANSLOCO_LOADER, useClass: HttpLoader };
Use with Webpack
To add custom Webpack support, use a tool like ngx-build-plus
and include the plugin in your webpack.config.js
:
const TranslocoScopedLibsWebpackPlugin = require('@jsverse/transloco-scoped-libs/webpack');
module.exports = {
plugins: [new TranslocoScopedLibsWebpackPlugin()],
};
This solution ensures that translation files from libraries are easily extracted, joined, and integrated into your application.
Last updated
Was this helpful?