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.

Sign up for GitHub

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

Jump to bottom

Feat/locale #65

Closed
wants to merge 8 commits into from
Closed

Feat/locale #65

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1988765
feat: 🔥 add translate executor
shhdharmen Jan 17, 2022
4b161ee
feat: 🔥 modify scripts to generate 2nd entry point
shhdharmen Jan 18, 2022
5371c2f
feat: 🔥 create i18n entry points wo copying core
shhdharmen Jan 19, 2022
02c3171
refactor: 💡 cleanups
shhdharmen Jan 19, 2022
f1e60c4
refactor: 💡 automate rollup generattion
shhdharmen Jan 19, 2022
9b5a7f6
fix: 🐞 update paths of rand and random functions
shhdharmen Jan 19, 2022
2ab0645
chore: 🤖 add root export in lib package.json
shhdharmen Jan 20, 2022
f3f8459
fix: 🐞 handle data object fr translation
shhdharmen Jan 20, 2022
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
1 change: 1 addition & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
"test": "nx test falso",
"migrate": "nx migrate latest",
"migrate:run": "nx migrate --run-migrations",
"m": "npx tsc tools/executors/manipulator/index && nx run falso:manipulator"
"m": "npx tsc tools/executors/manipulator/index && nx run falso:manipulator",
"translate": "npx tsc tools/executors/translate/index && nx run falso:translate"
},
"workspaces": [
"packages/falso",
Expand All @@ -39,6 +40,7 @@
"@nrwl/web": "13.4.5",
"@nrwl/workspace": "13.4.5",
"@phenomnomnominal/tsquery": "4.1.1",
"@rollup/plugin-json": "^4.1.0",
shhdharmen marked this conversation as resolved.
Show resolved Hide resolved
"@types/estree": "0.0.50",
"@types/jest": "27.0.2",
"@types/node": "14.14.33",
Expand Down
3 changes: 3 additions & 0 deletions packages/falso/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,8 @@
"devDependencies": {
"@types/seedrandom": "3.0.1",
"@types/uuid": "8.3.4"
},
"exports": {
shhdharmen marked this conversation as resolved.
Show resolved Hide resolved
"./i18n/*": "./i18n/*/index.cjs.js"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

@shhdharmen shhdharmen Jan 21, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

@michaelxvoelker michaelxvoelker Jan 23, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

}
}
7 changes: 7 additions & 0 deletions packages/falso/project.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,13 @@
"options": {
"commitMessageFormat": "chore(${projectName}): release version ${version}"
}
},
"translate": {
"executor": "./tools/executors/translate:translate",
"options": {
"languages": ["es", "ru"],
"output": "packages/falso/src/i18n"
}
}
},
"tags": []
Expand Down
32 changes: 32 additions & 0 deletions packages/falso/src/i18n/es/abbreviation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"data": [
"es-SCSI",
"es-SMTP",
"es-ADP",
"es-TCP",
"es-PNG",
"es-EXE",
"es-AI",
"es-RAM",
"es-RSS",
"es-GB",
"es-SSL",
"es-CSS",
"es-SAS",
"es-SDD",
"es-PCI",
"es-IB",
"es-SQL",
"es-XML",
"es-THX",
"es-AGP",
"es-HTTP",
"es-SMS",
"es-FTP",
"es-JBOD",
"es-XSS",
"es-HDD",
"es-JSON",
"es-COM"
]
}
20 changes: 20 additions & 0 deletions packages/falso/src/i18n/es/abbreviation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { fake, FakeOptions } from '../../lib/core/core';
import { data } from './abbreviation.json';

/**
* Generate a random abbreviation.
*
* @category text
*
* @example
*
* randAbbreviation()
*
* @example
*
* randAbbreviation({ length: 10 })
*
*/
export function randAbbreviation<O extends FakeOptions>(options?: O) {
return fake(data, options);
}
2 changes: 2 additions & 0 deletions packages/falso/src/i18n/es/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// THIS FILE IS AUTO-GENERATED THROUGH `npm run translate`
export { randAbbreviation } from './abbreviation';
32 changes: 32 additions & 0 deletions packages/falso/src/i18n/ru/abbreviation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"data": [
"ru-SCSI",
"ru-SMTP",
"ru-ADP",
"ru-TCP",
"ru-PNG",
"ru-EXE",
"ru-AI",
"ru-RAM",
"ru-RSS",
"ru-GB",
"ru-SSL",
"ru-CSS",
"ru-SAS",
"ru-SDD",
"ru-PCI",
"ru-IB",
"ru-SQL",
"ru-XML",
"ru-THX",
"ru-AGP",
"ru-HTTP",
"ru-SMS",
"ru-FTP",
"ru-JBOD",
"ru-XSS",
"ru-HDD",
"ru-JSON",
"ru-COM"
]
}
20 changes: 20 additions & 0 deletions packages/falso/src/i18n/ru/abbreviation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { fake, FakeOptions } from '../../lib/core/core';
import { data } from './abbreviation.json';

/**
* Generate a random abbreviation.
*
* @category text
*
* @example
*
* randAbbreviation()
*
* @example
*
* randAbbreviation({ length: 10 })
*
*/
export function randAbbreviation<O extends FakeOptions>(options?: O) {
return fake(data, options);
}
2 changes: 2 additions & 0 deletions packages/falso/src/i18n/ru/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// THIS FILE IS AUTO-GENERATED THROUGH `npm run translate`
export { randAbbreviation } from './abbreviation';
16 changes: 14 additions & 2 deletions post-build.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
const json = require('json-update');
const { execSync } = require('child_process');

json.update('dist/packages/falso/package.json', { main: './index.cjs.js' })
async function buildTranslationEntryPoints() {
execSync(`npx tsc --project packages/falso/tsconfig.lib.json`);
execSync(`npx rollup --config rollup.config.js`);
}

json
.update('dist/packages/falso/package.json', { main: './index.cjs.js' })
.then(() => {
console.log('Changed umd to cjs');
console.log('Changed falso/project.json main umd to cjs\n');
buildTranslationEntryPoints()
.then(() =>
console.log('Created cjs and esm js files for all translations.')
)
.catch();
});
36 changes: 36 additions & 0 deletions rollup.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
import json from '@rollup/plugin-json';

export default [
shhdharmen marked this conversation as resolved.
Show resolved Hide resolved
{
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()],
},
{
input: 'dist/out-tsc/packages/falso/src/i18n/ru/index.js',
output: {
file: 'dist/packages/falso/i18n/ru/index.cjs.js',
format: 'cjs',
},
plugins: [json()],
},
{
input: 'dist/out-tsc/packages/falso/src/i18n/ru/index.js',
output: {
file: 'dist/packages/falso/i18n/ru/index.esm.js',
format: 'esm',
},
plugins: [json()],
},
];
1 change: 1 addition & 0 deletions tools/executors/translate/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export const UNICODE_REGEXP = /\\u([\d\w]{4})/gi;
export const COMMENT = `// THIS FILE IS AUTO-GENERATED THROUGH \`npm run translate\``;
export const TYPE_SCRIPT_FILE_EXTENSION = '.ts';
export const JSON_FILE_EXTENSION = '.json';
92 changes: 28 additions & 64 deletions tools/executors/translate/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,7 @@
import { ExecutorContext } from '@nrwl/devkit';
import {
existsSync,
readdirSync,
readFileSync,
statSync,
unlinkSync,
} from 'fs';
import { join } from 'path';
import * as ts from 'typescript';
import { TYPE_SCRIPT_FILE_EXTENSION } from './constants';
import { generateStringLiteralsAndSourceFile } from './generate';
import { readdirSync, statSync } from 'fs';
import { basename, join } from 'path';
import { JSON_FILE_EXTENSION } from './constants';
import { EchoExecutorOptions } from './options';
import {
manageLanguageIndexFiles,
Expand All @@ -31,77 +23,49 @@ export default async function translateExecutor(
context.workspace.projects[context.projectName].sourceRoot,
'lib'
);
options.path = options.path.map((p) => p + TYPE_SCRIPT_FILE_EXTENSION);
options.output = join(projectLibPath, options.output);
const jsonFilePaths = readdirSync(projectLibPath).filter((p) =>
NetanelBasal marked this conversation as resolved.
Show resolved Hide resolved
p.includes(JSON_FILE_EXTENSION)
);

manageLanguageIndexFiles(options);

console.info(`Will be translating ${options.path.length} files.\n`);
console.info(`Will be translating ${jsonFilePaths.length} files.\n`);

// for (let filePath of options.path) {
for (let filePath of readdirSync(projectLibPath)) {
await new Promise<void>((resolve, reject) =>
for (let jsonFileName of [jsonFilePaths[0]]) {
await new Promise<void>((resolve) =>
shhdharmen marked this conversation as resolved.
Show resolved Hide resolved
setTimeout(() => {
resolve();
}, 100)
);
const rootFilePath = join(projectLibPath, filePath);
const fileStats = statSync(rootFilePath);
const TSFileName = basename(jsonFileName, '.json') + '.ts';
const rootJSONFilePath = join(projectLibPath, jsonFileName);
const fileStats = statSync(rootJSONFilePath);

const isFile = fileStats.isFile();
if (isFile) {
let { stringLiterals, sourceFile } =
generateStringLiteralsAndSourceFile(rootFilePath);

if (!stringLiterals?.length) {
console.info(`No string-literals found in file ${rootFilePath}\n`);

if (
existsSync(
rootFilePath.replace(TYPE_SCRIPT_FILE_EXTENSION, '.json')
)
) {
stringLiterals = JSON.parse(
readFileSync(
rootFilePath.replace(TYPE_SCRIPT_FILE_EXTENSION, '.json')
).toString()
).data;
}
}

if (stringLiterals?.length) {
// create i18n.json for existing files
await writeTranslation(options, stringLiterals, sourceFile, filePath);

// and then for languages
for (const language of options.languages) {
await writeTranslation(
options,
stringLiterals,
sourceFile,
filePath,
language
);
}
// and then for languages
for (const language of options.languages) {
await writeTranslation(
options,
projectLibPath,
jsonFileName,
TSFileName,
language
);
}
} else {
console.error(`File: ${rootFilePath} does not exist or is not file!`);
console.error(
`File: ${rootJSONFilePath} does not exist or is not file!`
);
}
}

// delete translations/index.ts file if present
// const translationIndex = join(options.output, `index.ts`);
// if (existsSync(translationIndex)) {
// unlinkSync(translationIndex);
// }

// write export statements everywhere
// TODO: Un-comment below
// writeExportStatements(options, translationIndex);
writeExportStatements(options);

// console.info(
// "Translation complete. Please make sure to export from package's index file"
// );
console.info(
'Translation complete. Please make sure to add entries in rollup.config.js.'
);

return { success };
} catch (e) {
Expand Down
1 change: 0 additions & 1 deletion tools/executors/translate/options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
export interface EchoExecutorOptions {
path: string[];
languages: string[];
output: string;
}
9 changes: 1 addition & 8 deletions tools/executors/translate/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,6 @@
"type": "object",
"cli": "nx",
"properties": {
"path": {
"type": "array",
"description": "Files to translate",
"items": {
"type": "string"
}
},
"languages": {
"type": "array",
"description": "Languages",
Expand All @@ -23,5 +16,5 @@
"description": "The output dir path"
}
},
"required": ["path", "languages", "output"]
"required": ["languages", "output"]
}
Loading