Skip to content

Commit

Permalink
add vue internationalization
Browse files Browse the repository at this point in the history
create vue internalization module using i18next 23.14.0 with language detector
see https://i18next.github.io/i18next-vue/introduction.html
  • Loading branch information
fabienpuissant committed Aug 28, 2024
1 parent bae298f commit a628c18
Show file tree
Hide file tree
Showing 17 changed files with 401 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
public class ReactI18nModuleFactory {

private static final JHipsterSource APP_SOURCE = from("client/react/i18n/src/main/webapp/app");
private static final JHipsterSource ASSETS_FR_SOURCE = from("client/react/i18n/src/main/webapp/assets/locales/fr");
private static final JHipsterSource ASSETS_EN_SOURCE = from("client/react/i18n/src/main/webapp/assets/locales/en");
private static final JHipsterSource ASSETS_FR_SOURCE = from("client/common/i18n/locales/fr");
private static final JHipsterSource ASSETS_EN_SOURCE = from("client/common/i18n/locales/en");

private static final String INDEX = "src/main/webapp/";
private static final String INDEX_TEST = "src/test/webapp/unit/common/primary/app/";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
class ReactI18nModuleConfiguration {

@Bean
JHipsterModuleResource i18nModule(ReactI18nApplicationService i18n) {
JHipsterModuleResource reactI18nModule(ReactI18nApplicationService i18n) {
return JHipsterModuleResource.builder()
.slug(REACT_I18N)
.propertiesDefinition(JHipsterModulePropertiesDefinition.builder().build())
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package tech.jhipster.lite.generator.client.vue.i18n.application;

import org.springframework.stereotype.Service;
import tech.jhipster.lite.generator.client.vue.i18n.domain.VueI18nModuleFactory;
import tech.jhipster.lite.module.domain.JHipsterModule;
import tech.jhipster.lite.module.domain.properties.JHipsterModuleProperties;

@Service
public class VueI18nApplicationService {

private final VueI18nModuleFactory factory;

public VueI18nApplicationService() {
factory = new VueI18nModuleFactory();
}

public JHipsterModule buildModule(JHipsterModuleProperties properties) {
return factory.buildModule(properties);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
package tech.jhipster.lite.generator.client.vue.i18n.domain;

import static tech.jhipster.lite.module.domain.JHipsterModule.*;

import tech.jhipster.lite.module.domain.JHipsterModule;
import tech.jhipster.lite.module.domain.file.JHipsterSource;
import tech.jhipster.lite.module.domain.packagejson.VersionSource;
import tech.jhipster.lite.module.domain.properties.JHipsterModuleProperties;
import tech.jhipster.lite.shared.error.domain.Assert;

public class VueI18nModuleFactory {

private static final JHipsterSource APP_SOURCE = from("client/vue/i18n/src/main/webapp/app");
private static final JHipsterSource ASSETS_FR_SOURCE = from("client/common/i18n/locales/fr");
private static final JHipsterSource ASSETS_EN_SOURCE = from("client/common/i18n/locales/en");
private static final JHipsterSource TEST_SOURCE = from("client/vue/i18n/src/test");

private static final String INDEX = "src/main/webapp/";
private static final String INDEX_TEST = "src/test/";

public JHipsterModule buildModule(JHipsterModuleProperties properties) {
Assert.notNull("properties", properties);

//@formatter:off
return moduleBuilder(properties)
.packageJson()
.addDependency(packageName("i18next"), VersionSource.COMMON)
.addDependency(packageName("i18next-vue"), VersionSource.VUE)
.addDependency(packageName("i18next-browser-languagedetector"), VersionSource.COMMON)
.addDependency(packageName("i18next-http-backend"), VersionSource.COMMON)
.and()
.files()
.batch(APP_SOURCE, to(INDEX + "/app"))
.addFile("i18n.ts")
.and()
.batch(ASSETS_EN_SOURCE, to(INDEX + "content/locales/en/"))
.addFile("translation.json")
.and()
.batch(ASSETS_FR_SOURCE, to(INDEX + "content/locales/fr/"))
.addFile("translation.json")
.and()
.batch(TEST_SOURCE, to(INDEX_TEST))
.addFile("setupTests.ts")
.and()
.and()
.mandatoryReplacements()
.in(path(INDEX + "app/main.ts"))
.add(lineBeforeText("// jhipster-needle-main-ts-import"), "import i18next from './i18n';")
.add(lineBeforeText("// jhipster-needle-main-ts-import"), "import I18NextVue from 'i18next-vue';")
.add(lineBeforeText("app.mount('#app');"), "app.use(I18NextVue, { i18next });")
.and()
.in(path(INDEX + "app/common/primary/homepage/Homepage.html"))
.add(lineAfterRegex("Vue 3 \\+ TypeScript \\+ Vite"), properties.indentation().times(1) + "<p v-html=\"$t('translationEnabled')\"></p>")
.and()
.in(path("./vitest.config.ts"))
.add(lineAfterRegex("test:"), properties.indentation().times(2) + "setupFiles: ['./src/test/setupTests.ts'],")
.and()
.in(path(INDEX_TEST + "webapp/unit/common/primary/homepage/Homepage.spec.ts"))
.add(append(), LINE_BREAK + """
describe('App I18next', () => {
it('should renders with translation', () => {
wrap();
expect(wrapper.text()).toContain("translationEnabled");
});
});
""")
.and()
.and()
.build();
//@formatter:off
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package tech.jhipster.lite.generator.client.vue.i18n.infrastructure.primary;

import static tech.jhipster.lite.generator.slug.domain.JHLiteFeatureSlug.CLIENT_INTERNATIONALIZATION;
import static tech.jhipster.lite.generator.slug.domain.JHLiteModuleSlug.VUE_CORE;
import static tech.jhipster.lite.generator.slug.domain.JHLiteModuleSlug.VUE_I18N;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import tech.jhipster.lite.generator.client.vue.i18n.application.VueI18nApplicationService;
import tech.jhipster.lite.module.domain.resource.JHipsterModuleOrganization;
import tech.jhipster.lite.module.domain.resource.JHipsterModulePropertiesDefinition;
import tech.jhipster.lite.module.domain.resource.JHipsterModuleResource;

@Configuration
class VueI18nModuleConfiguration {

@Bean
JHipsterModuleResource vueI18nModule(VueI18nApplicationService i18n) {
return JHipsterModuleResource.builder()
.slug(VUE_I18N)
.propertiesDefinition(JHipsterModulePropertiesDefinition.builder().build())
.apiDoc("Frontend - Vue", "Add vue internationalization")
.organization(JHipsterModuleOrganization.builder().feature(CLIENT_INTERNATIONALIZATION).addDependency(VUE_CORE).build())
.tags("client", "vue", "i18n")
.factory(i18n::buildModule);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
@tech.jhipster.lite.BusinessContext
package tech.jhipster.lite.generator.client.vue.i18n;
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ public enum JHLiteModuleSlug implements JHipsterModuleSlugFactory {
SVELTE_CORE("svelte-core"),
TYPESCRIPT("typescript"),
VUE_CORE("vue-core"),
VUE_I18N("vue-i18next"),
VUE_PINIA("vue-pinia"),
TS_PAGINATION_DOMAIN("ts-pagination-domain"),
TS_REST_PAGINATION("ts-rest-pagination");
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import i18n from 'i18next';

import Backend from 'i18next-http-backend';
import LanguageDetector from 'i18next-browser-languagedetector';

i18n
.use(Backend)
.use(LanguageDetector)

.init({
fallbackLng: 'en',
debug: false,

interpolation: {
escapeValue: false,
},
backend: {
loadPath: '../content/locales/{{ lng }}/{{ ns }}.json',
},
});

export default i18n;
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { config } from '@vue/test-utils';

config.global.mocks = {
$t: msg => msg,
};
1 change: 1 addition & 0 deletions src/main/resources/generator/dependencies/vue/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"license": "Apache-2.0",
"dependencies": {
"axios": "1.7.5",
"i18next-vue": "5.0.0",
"pinia": "2.2.2",
"pinia-plugin-persistedstate": "3.2.1",
"vue": "3.4.38",
Expand Down
15 changes: 15 additions & 0 deletions src/test/features/client/vue-i18n.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Feature: Vue i18n

Scenario: Should apply vue i18n module to vue
When I apply modules to default project
| init |
| vue-core |
| vue-i18next |
Then I should have files in "src/main/webapp/app"
| i18n.ts |
And I should have files in "src/main/webapp/content/locales/en"
| translation.json |
And I should have files in "src/main/webapp/content/locales/fr"
| translation.json |
And I should have files in "src/test"
| setupTests.ts |
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
package tech.jhipster.lite.generator.client.vue.i18n.domain;

import static tech.jhipster.lite.module.infrastructure.secondary.JHipsterModulesAssertions.*;

import org.junit.jupiter.api.Test;
import tech.jhipster.lite.TestFileUtils;
import tech.jhipster.lite.UnitTest;
import tech.jhipster.lite.module.domain.JHipsterModule;
import tech.jhipster.lite.module.domain.JHipsterModulesFixture;

@UnitTest
class VueI18nModuleFactoryTest {

private static final VueI18nModuleFactory factory = new VueI18nModuleFactory();

@Test
void shouldBuildI18nModule() {
JHipsterModule module = factory.buildModule(
JHipsterModulesFixture.propertiesBuilder(TestFileUtils.tmpDirForTest()).projectBaseName("jhipster").build()
);

JHipsterModuleAsserter asserter = assertThatModuleWithFiles(
module,
packageJsonFile(),
mainFile(),
homepage(),
homepageTest(),
vitest()
);
asserter
.hasFile("package.json")
.containing(nodeDependency("i18next"))
.containing(nodeDependency("i18next-vue"))
.containing(nodeDependency("i18next-browser-languagedetector"))
.containing(nodeDependency("i18next-http-backend"))
.and()
.hasFile("src/main/webapp/app/i18n.ts")
.containing(
"""
import i18n from 'i18next';
import Backend from 'i18next-http-backend';
import LanguageDetector from 'i18next-browser-languagedetector';
i18n
.use(Backend)
.use(LanguageDetector)
.init({
fallbackLng: 'en',
debug: false,
interpolation: {
escapeValue: false,
},
backend: {
loadPath: '../content/locales/{{ lng }}/{{ ns }}.json',
},
});
export default i18n;
"""
)
.and()
.hasFile("src/main/webapp/app/main.ts")
.containing("import i18next from './i18n';")
.containing("import I18NextVue from 'i18next-vue';")
.containing("app.use(I18NextVue, { i18next });")
.and()
.hasFile("src/main/webapp/app/common/primary/homepage/Homepage.html")
.containing("<p v-html=\"$t('translationEnabled')\"></p>")
.and()
.hasFile("src/test/setupTests.ts")
.containing(
"""
import { config } from '@vue/test-utils';
config.global.mocks = {
$t: msg => msg,
};
"""
)
.and()
.hasFile("vitest.config.ts")
.containing("setupFiles: ['./src/test/setupTests.ts']")
.and()
.hasFile("src/main/webapp/content/locales/en/translation.json")
.containing(
"""
{
"translationEnabled": "Internationalization enabled"
}
"""
)
.and()
.hasFile("src/main/webapp/content/locales/fr/translation.json")
.containing(
"""
{
"translationEnabled": "Internationalisation activée"
}
"""
)
.and()
.hasFile("src/test/webapp/unit/common/primary/homepage/Homepage.spec.ts")
.containing("describe('App I18next', () => {");
}

private ModuleFile mainFile() {
return file("src/test/resources/projects/vue/main.ts.template", "src/main/webapp/app/main.ts");
}

private ModuleFile homepage() {
return file("src/test/resources/projects/vue/Homepage.html.template", "src/main/webapp/app/common/primary/homepage/Homepage.html");
}

private ModuleFile homepageTest() {
return file(
"src/test/resources/projects/vue/Homepage.spec.ts.template",
"src/test/webapp/unit/common/primary/homepage/Homepage.spec.ts"
);
}

private ModuleFile vitest() {
return file("src/test/resources/projects/vue/vitest.config.ts.template", "./vitest.config.ts");
}
}
23 changes: 23 additions & 0 deletions src/test/resources/projects/vue/Homepage.html.template
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<div id="app">
<img alt="Vue logo" src="../../../../content/images/VueLogo.png" />
<br />
<img alt="JHipster logo" src="../../../../content/images/JHipster-Lite-neon-green.png" />
<h1>{{ appName }}: Vue 3 + TypeScript + Vite</h1>
<p>
Recommended IDE setup:
<a href="https://code.visualstudio.com/" target="_blank" rel="noopener">VSCode</a>
+
<a href="https://github.com/johnsoncodehk/volar" target="_blank" rel="noopener">Volar</a>
</p>

<p>
<a href="https://vitejs.dev/guide/features.html" target="_blank" rel="noopener"> Vite Documentation </a>
|
<a href="https://v3.vuejs.org/" target="_blank" rel="noopener">Vue 3 Documentation</a>
</p>

<p>
Edit
<code>src/main/webapp/app/common/primary/app/AppVue.vue</code> to test hot module replacement.
</p>
</div>
17 changes: 17 additions & 0 deletions src/test/resources/projects/vue/Homepage.spec.ts.template
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { describe, it, expect } from 'vitest';
import { shallowMount, VueWrapper } from '@vue/test-utils';
import { HomepageVue } from '@/common/primary/homepage';

let wrapper: VueWrapper;

const wrap = () => {
wrapper = shallowMount(HomepageVue);
};

describe('App', () => {
it('should exist', () => {
wrap();

expect(wrapper.exists()).toBeTruthy();
});
});
Loading

0 comments on commit a628c18

Please sign in to comment.