Feat/locale #65

shhdharmen · 2022-01-18T19:37:52Z

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/ngneat/falso/blob/master/CONTRIBUTING.md#commit
~~[ ] Tests for the changes have been added (for bug fixes / features)~~
~~[ ] Docs have been added / updated (for bug fixes / features)~~

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Issue Number: #1

What is the new behavior?

1. Translation languages

Add languages in packages/falso/project.json's translate executor's options.

2. Generate translation files

npm run translate

Above command will...

Translate texts from json for that particular language (API implementation is remaining)
Create language specific files in below structure:

2. Add configuration for each language in `rollup.config.js`:

import json from '@rollup/plugin-json';

export default [
  {
    input: 'dist/out-tsc/packages/falso/src/i18n/es/index.js',
    output: {
      file: 'dist/packages/falso/i18n/es/index.cjs.js',
      format: 'cjs',
    },
    plugins: [json()],
  },
  {
    input: 'dist/out-tsc/packages/falso/src/i18n/es/index.js',
    output: {
      file: 'dist/packages/falso/i18n/es/index.esm.js',
      format: 'esm',
    },
    plugins: [json()],
  }
];

Above approach can be simplified using glob patterns, but it requires more research.

3. Build the library with secondary entry points for each language

npm run build

Above command will...

Build main falso library without i18n
run the postBuild.js script, which will internally run all needed scripts to create entry points for each language.

3. Usage

After packing and publishing the library, one can use the translation like below:

const { randAbbreviation } = require("@ngneat/falso/i18n/es");

// or

import { randAbbreviation } from '@ngneat/falso/i18n/es';

Does this PR introduce a breaking change?

[ ] Yes
[x] No

✅ Closes: ngneat#1

NetanelBasal · 2022-01-18T19:43:59Z

Thanks. Why do we need to copy the core?

NetanelBasal · 2022-01-18T19:54:15Z

Also, does that mean each package should be installed via npm? That's not was the intention :)

michaelxvoelker · 2022-01-18T21:28:53Z

I think the translation should generate submodules with its own entry-points within packages/falso/src and bundled all together in one package. Maybe this might help to get the correct setup.

shhdharmen · 2022-01-19T03:29:54Z

Also, does that mean each package should be installed via npm? That's not was the intention :)

@NetanelBasal no, user just need to install falso, i18n files are part of it.

shhdharmen · 2022-01-19T03:32:54Z

Thanks. Why do we need to copy the core?

@NetanelBasal because without copying, when end user tries to access any function from i18n, it gives error of core functions not found. The reason behind that is lib is bundled separately and i18n files are bundled separately.

Although, I will try to find out a way to eliminate that.

shhdharmen · 2022-01-19T03:34:21Z

I think the translation should generate submodules with its own entry-points within packages/falso/src and bundled all together in one package. Maybe this might help to get the correct setup.

Thanks for sharing. Initial structure was like that only, but nx only bundled main index.ts file. I will check if that can be changed through some configs.

michaelxvoelker · 2022-01-19T09:13:31Z

Looks tricky to setup correctly. I wonder if the rollup plugin for multiple entry files can do the trick. 🤔

✅ Closes: ngneat#1

shhdharmen · 2022-01-19T10:49:23Z

@NetanelBasal modified the code which doesn't require copying core files. Let me know if this is good, then I can start looking into API integration.

packages/falso/package.json

rollup.config.js

tools/executors/translate/index.ts

package.json

NetanelBasal · 2022-01-19T12:03:25Z

tools/executors/translate/translate.ts

+
+  const data = jsonData.data;
+
+  const updatedData = await translateDataArray(data, language);


Why do we need all this code? you have the data array property from the JSON file, and we should translate its elements

It's needed for nested jsons.

For example?

For example data is array of objects instead of strings.

I don't think we have such a case. Our data is always a list of strings

@shhdharmen now I see the food example, you are right 😀

Chexk if you support this please

Checked for food, worked fine.

NetanelBasal · 2022-01-19T12:04:10Z

tools/executors/translate/write.ts

@@ -154,23 +77,29 @@ export function createLanguageIndexFile(outputDir: string) {

  readdirSync(outputDir)


tools/executors/translate/write.ts

NetanelBasal · 2022-01-19T16:11:22Z

packages/falso/package.json

@@ -34,5 +34,8 @@
  "devDependencies": {
    "@types/seedrandom": "3.0.1",
    "@types/uuid": "8.3.4"
+  },
+  "exports": {
+    "./i18n/*": "./i18n/*/index.cjs.js"


Can you verify it works with web bundlers such as Wepback, please? I' suggesting to build the library and npm link to dist

Checked for webpack, it gave error for missing entry of . in exports, so added that and it worked fine.

I'm not sure about this approach because you're referring only to cjs modules here, and web bundles can't tree-shake it.

Other approach could be to have package.json for each language, and it contains main and module entries in it and remove exports from main package.json. Should I check that? We will need to take care that users still need to only install main package only.

Or can we use other builder than rollup? Like node? Which supports multiple entry points: https://nx.dev/node/build#additionalentrypoints. And it's built on top of webpack, which can help us with more configurations.

We will need to ensure that users still need to install the main package only.

That's not an issue because it's tree-shakable. It'll not be bundled if they do not use the i18n functions.

There's a problem we did not think of - name collision. We should prefix the i18n function with the locale (e.g. ruRandFullName)

Let's try the other builder with the entry point support regarding the build.

With the prefix in place, we can just export the i18n functions in the regular index.ts file, right? 🤔 No additional entry point is needed for packaging.

@michaelxvoelker feel free to clone the repo or even the branch I created and try out what you mentioned. Let me know if it works.

Tried node builder, but doesn't produce results the way we want. I will research more.

shhdharmen added 2 commits January 17, 2022 13:41

feat: 🔥 add translate executor

1988765

feat: 🔥 modify scripts to generate 2nd entry point

4b161ee

✅ Closes: ngneat#1

shhdharmen marked this pull request as draft January 18, 2022 19:40

feat: 🔥 create i18n entry points wo copying core

5371c2f

✅ Closes: ngneat#1

refactor: 💡 cleanups

02c3171

NetanelBasal reviewed Jan 19, 2022

View reviewed changes

shhdharmen added 2 commits January 19, 2022 20:49

refactor: 💡 automate rollup generattion

f1e60c4

fix: 🐞 update paths of rand and random functions

9b5a7f6

NetanelBasal reviewed Jan 19, 2022

View reviewed changes

shhdharmen added 2 commits January 20, 2022 16:07

chore: 🤖 add root export in lib package.json

2ab0645

fix: 🐞 handle data object fr translation

f3f8459

NetanelBasal closed this Feb 23, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/locale #65

Feat/locale #65

shhdharmen commented Jan 18, 2022 •

edited

NetanelBasal commented Jan 18, 2022

NetanelBasal commented Jan 18, 2022

michaelxvoelker commented Jan 18, 2022

shhdharmen commented Jan 19, 2022

shhdharmen commented Jan 19, 2022

shhdharmen commented Jan 19, 2022

michaelxvoelker commented Jan 19, 2022

shhdharmen commented Jan 19, 2022

NetanelBasal Jan 19, 2022

shhdharmen Jan 19, 2022

NetanelBasal Jan 19, 2022

shhdharmen Jan 19, 2022

NetanelBasal Jan 19, 2022

NetanelBasal Jan 19, 2022

NetanelBasal Jan 19, 2022

shhdharmen Jan 20, 2022

NetanelBasal Jan 19, 2022

NetanelBasal Jan 19, 2022

shhdharmen Jan 20, 2022

NetanelBasal Jan 20, 2022

shhdharmen Jan 21, 2022 •

edited

NetanelBasal Jan 21, 2022

michaelxvoelker Jan 23, 2022 •

edited

shhdharmen Jan 23, 2022

shhdharmen Jan 27, 2022


		const data = jsonData.data;

		const updatedData = await translateDataArray(data, language);

		@@ -154,23 +77,29 @@ export function createLanguageIndexFile(outputDir: string) {

		readdirSync(outputDir)

Feat/locale #65

Feat/locale #65

Conversation

shhdharmen commented Jan 18, 2022 • edited

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

1. Translation languages

2. Generate translation files

2. Add configuration for each language in rollup.config.js:

3. Build the library with secondary entry points for each language

3. Usage

Does this PR introduce a breaking change?

NetanelBasal commented Jan 18, 2022

NetanelBasal commented Jan 18, 2022

michaelxvoelker commented Jan 18, 2022

shhdharmen commented Jan 19, 2022

shhdharmen commented Jan 19, 2022

shhdharmen commented Jan 19, 2022

michaelxvoelker commented Jan 19, 2022

shhdharmen commented Jan 19, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shhdharmen Jan 21, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michaelxvoelker Jan 23, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shhdharmen commented Jan 18, 2022 •

edited

2. Add configuration for each language in `rollup.config.js`:

shhdharmen Jan 21, 2022 •

edited

michaelxvoelker Jan 23, 2022 •

edited