@elementor/extract-i18n-wordpress-expressions-webpack-plugin 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +5 -15
- package/dist/index.js +3 -8
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +3 -8
- package/dist/index.mjs.map +1 -1
- package/package.json +39 -39
- package/src/__tests__/index.test.ts +20 -8
- package/src/plugin.ts +4 -14
- package/src/types.ts +8 -8
- package/src/utils.ts +11 -9
package/CHANGELOG.md
CHANGED
|
@@ -3,35 +3,25 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
-
## [0.3.
|
|
6
|
+
## [0.3.2](https://github.com/elementor/elementor-packages/compare/@elementor/extract-i18n-wordpress-expressions-webpack-plugin@0.3.1...@elementor/extract-i18n-wordpress-expressions-webpack-plugin@0.3.2) (2024-07-16)
|
|
7
7
|
|
|
8
8
|
**Note:** Version bump only for package @elementor/extract-i18n-wordpress-expressions-webpack-plugin
|
|
9
9
|
|
|
10
|
+
## [0.3.1](https://github.com/elementor/elementor-packages/compare/@elementor/extract-i18n-wordpress-expressions-webpack-plugin@0.3.0...@elementor/extract-i18n-wordpress-expressions-webpack-plugin@0.3.1) (2023-11-07)
|
|
10
11
|
|
|
11
|
-
|
|
12
|
-
|
|
12
|
+
**Note:** Version bump only for package @elementor/extract-i18n-wordpress-expressions-webpack-plugin
|
|
13
13
|
|
|
14
14
|
# [0.3.0](https://github.com/elementor/elementor-packages/compare/@elementor/extract-i18n-wordpress-expressions-webpack-plugin@0.2.2...@elementor/extract-i18n-wordpress-expressions-webpack-plugin@0.3.0) (2023-09-12)
|
|
15
15
|
|
|
16
|
-
|
|
17
16
|
### Features
|
|
18
17
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
18
|
+
- **i18n-webpack:** changed the way it extracts expressions ([#117](https://github.com/elementor/elementor-packages/issues/117)) ([5be687d](https://github.com/elementor/elementor-packages/commit/5be687d57ca9d0c335b9803aea12cdacc14f8202))
|
|
24
19
|
|
|
25
20
|
## 0.2.2 (2023-08-31)
|
|
26
21
|
|
|
27
|
-
|
|
28
22
|
### Bug Fixes
|
|
29
23
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
24
|
+
- **i18n-plugin:** typo in package name [ED-11227] ([#109](https://github.com/elementor/elementor-packages/issues/109)) ([e2adcbf](https://github.com/elementor/elementor-packages/commit/e2adcbf988019493d1a72404b4fe62eeef2f6a59))
|
|
35
25
|
|
|
36
26
|
## 0.2.1 (2023-07-02)
|
|
37
27
|
|
package/dist/index.js
CHANGED
|
@@ -49,7 +49,7 @@ var COMMENTS_REGEXPS = [
|
|
|
49
49
|
];
|
|
50
50
|
var TRANSLATIONS_REGEXPS = [
|
|
51
51
|
// Matches translation functions: `__('Hello', 'elementor')`, `_n('Me', 'Us', 2, 'elementor-pro')`.
|
|
52
|
-
/\b_(?:_|n|nx|x)\(.*?,\s*(?<c>['"`])[\w-]+\k<c>\s*?\)/
|
|
52
|
+
/\b_(?:_|n|nx|x)\(.*?,\s*(?<c>['"`])[\w-]+\k<c>\s*?\)/gs
|
|
53
53
|
];
|
|
54
54
|
function createStringsFilePath(path2, suffix = ".strings.js") {
|
|
55
55
|
return path2.replace(/(\.min)?\.js$/i, suffix);
|
|
@@ -103,9 +103,7 @@ var ExtractI18nWordpressExpressionsWebpackPlugin = class {
|
|
|
103
103
|
const entries = this.getEntries(compilation);
|
|
104
104
|
await Promise.all(
|
|
105
105
|
entries.map(async (entry) => {
|
|
106
|
-
const fileContents = await getFilesContents(
|
|
107
|
-
await getFilesPaths(entry.pattern)
|
|
108
|
-
);
|
|
106
|
+
const fileContents = await getFilesContents(await getFilesPaths(entry.pattern));
|
|
109
107
|
const entryContent = generateStringsFileContent(fileContents);
|
|
110
108
|
await fs2.promises.writeFile(entry.path, entryContent);
|
|
111
109
|
})
|
|
@@ -131,10 +129,7 @@ var ExtractI18nWordpressExpressionsWebpackPlugin = class {
|
|
|
131
129
|
id,
|
|
132
130
|
chunk,
|
|
133
131
|
path: path.join(basePath, filePath),
|
|
134
|
-
pattern: this.options.pattern(
|
|
135
|
-
path.resolve(process.cwd(), entrypoint.origins[0].request),
|
|
136
|
-
id
|
|
137
|
-
)
|
|
132
|
+
pattern: this.options.pattern(path.resolve(process.cwd(), entrypoint.origins[0].request), id)
|
|
138
133
|
};
|
|
139
134
|
}).filter(Boolean);
|
|
140
135
|
}
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts","../src/plugin.ts","../src/utils.ts"],"sourcesContent":["export { default as ExtractI18nWordpressExpressionsWebpackPlugin } from './plugin';\n","import * as path from 'path';\nimport * as fs from 'fs';\nimport { Compilation, Compiler } from 'webpack';\nimport { EntrySettings } from './types';\nimport {
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/plugin.ts","../src/utils.ts"],"sourcesContent":["export { default as ExtractI18nWordpressExpressionsWebpackPlugin } from './plugin';\n","import * as path from 'path';\nimport * as fs from 'fs';\nimport { Compilation, Compiler } from 'webpack';\nimport { EntrySettings } from './types';\nimport { createStringsFilePath, generateStringsFileContent, getFilesContents, getFilesPaths } from './utils';\n\ntype Options = {\n\tpattern: ( entryPath: string, entryId: string ) => string;\n};\n\nexport default class ExtractI18nWordpressExpressionsWebpackPlugin {\n\toptions: Options;\n\n\tconstructor( options: Options ) {\n\t\tthis.options = options;\n\t}\n\n\tapply( compiler: Compiler ) {\n\t\tcompiler.hooks.afterEmit.tapPromise( this.constructor.name, async ( compilation ) => {\n\t\t\tconst entries = this.getEntries( compilation );\n\n\t\t\tawait Promise.all(\n\t\t\t\tentries.map( async ( entry ) => {\n\t\t\t\t\tconst fileContents = await getFilesContents( await getFilesPaths( entry.pattern ) );\n\n\t\t\t\t\tconst entryContent = generateStringsFileContent( fileContents );\n\n\t\t\t\t\t// Writing manually instead of using `chunk.files.add()` in order to avoid passing\n\t\t\t\t\t// the file through the loaders (transpilers, minifiers, etc.).\n\t\t\t\t\tawait fs.promises.writeFile( entry.path, entryContent );\n\t\t\t\t} )\n\t\t\t);\n\t\t} );\n\t}\n\n\tgetEntries( compilation: Compilation ) {\n\t\treturn [ ...compilation.entrypoints ]\n\t\t\t.map( ( [ id, entrypoint ] ) => {\n\t\t\t\tconst chunk = entrypoint.chunks.find( ( { name } ) => name === id );\n\n\t\t\t\tif ( ! chunk ) {\n\t\t\t\t\treturn null;\n\t\t\t\t}\n\n\t\t\t\tconst chunkJSFile = [ ...chunk.files ].find( ( f ) => /\\.(js|ts)$/i.test( f ) );\n\n\t\t\t\tif ( ! chunkJSFile ) {\n\t\t\t\t\treturn null;\n\t\t\t\t}\n\n\t\t\t\tconst { path: basePath } = compilation.options.output;\n\n\t\t\t\tif ( ! basePath ) {\n\t\t\t\t\treturn null;\n\t\t\t\t}\n\n\t\t\t\tconst filePath = createStringsFilePath( compilation.getPath( '[file]', { filename: chunkJSFile } ) );\n\n\t\t\t\treturn {\n\t\t\t\t\tid,\n\t\t\t\t\tchunk,\n\t\t\t\t\tpath: path.join( basePath, filePath ),\n\t\t\t\t\tpattern: this.options.pattern( path.resolve( process.cwd(), entrypoint.origins[ 0 ].request ), id ),\n\t\t\t\t};\n\t\t\t} )\n\t\t\t.filter( Boolean ) as EntrySettings[];\n\t}\n}\n","import { TranslationCallExpression } from './types';\nimport { glob } from 'glob';\nimport * as fs from 'fs';\n\nconst COMMENTS_REGEXPS = [\n\t// Matches translators comment block: `/* translators: %s */`.\n\t/\\/\\*[\\t ]*translators:.*\\*\\//gm,\n\t// Matches translators inline comment: `// translators: %s`.\n\t/(\\/\\/)[\\t ]*translators:[^\\r\\n]*/gm,\n] as const;\n\nconst TRANSLATIONS_REGEXPS = [\n\t// Matches translation functions: `__('Hello', 'elementor')`, `_n('Me', 'Us', 2, 'elementor-pro')`.\n\t/\\b_(?:_|n|nx|x)\\(.*?,\\s*(?<c>['\"`])[\\w-]+\\k<c>\\s*?\\)/gs,\n] as const;\n\nexport function createStringsFilePath( path: string, suffix = '.strings.js' ) {\n\treturn path.replace( /(\\.min)?\\.js$/i, suffix );\n}\n\nexport function getFilesPaths( pattern: string ) {\n\treturn glob( pattern, {\n\t\tignore: {\n\t\t\tignored: ( p ) => ! /\\.(js|ts|jsx|tsx)$/.test( p.name ),\n\t\t\tchildrenIgnored: ( p ) => p.isNamed( '__tests__' ) || p.isNamed( '__mocks__' ),\n\t\t},\n\n\t\t/**\n\t\t * Fix for Windows paths escaping.\n\t\t * Note: This means we don't support paths with special character (like `*`,`?`, etc.)\n\t\t * and only allow patterns that are constructed using `path.join()` or `path.resolve()`.\n\t\t *\n\t\t * @see https://github.com/isaacs/node-glob#options\n\t\t * @see https://github.com/isaacs/node-glob#windows\n\t\t * @see https://github.com/isaacs/node-glob/issues/212#issuecomment-1449062925\n\t\t */\n\t\twindowsPathsNoEscape: true,\n\t} );\n}\n\nexport function getFilesContents( paths: string[] ) {\n\treturn Promise.all( paths.map( ( filePath ) => fs.promises.readFile( filePath, 'utf-8' ) ) );\n}\n\nexport function generateStringsFileContent( contents: string[] ) {\n\treturn (\n\t\tcontents\n\t\t\t.map( ( content ) => extractExpressions( content ) )\n\t\t\t.flat()\n\t\t\t// Add a semicolon when needed.\n\t\t\t.map( ( expr ) => `${ expr.value }${ expr.type === 'comment' ? '' : ';' }` )\n\t\t\t// Join all the expressions to a single string with line-breaks between them.\n\t\t\t.join( '\\n' )\n\t);\n}\n\nfunction extractExpressions( content: string ): TranslationCallExpression[] {\n\tconst expressions: TranslationCallExpression[] = [];\n\n\t[ ...TRANSLATIONS_REGEXPS, ...COMMENTS_REGEXPS ].forEach( ( regexp ) => {\n\t\t[ ...content.matchAll( regexp ) ].forEach( ( res ) => {\n\t\t\texpressions.push( {\n\t\t\t\ttype: COMMENTS_REGEXPS.includes( regexp ) ? 'comment' : 'call-expression',\n\t\t\t\tindex: res.index || 0,\n\t\t\t\tvalue: res[ 0 ],\n\t\t\t} );\n\t\t} );\n\t} );\n\n\t// Sort by the index it was found in the file based on the regexp (and not by the order it was added to the array).\n\treturn expressions.sort( ( a, b ) => a.index - b.index );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,WAAsB;AACtB,IAAAA,MAAoB;;;ACApB,kBAAqB;AACrB,SAAoB;AAEpB,IAAM,mBAAmB;AAAA;AAAA,EAExB;AAAA;AAAA,EAEA;AACD;AAEA,IAAM,uBAAuB;AAAA;AAAA,EAE5B;AACD;AAEO,SAAS,sBAAuBC,OAAc,SAAS,eAAgB;AAC7E,SAAOA,MAAK,QAAS,kBAAkB,MAAO;AAC/C;AAEO,SAAS,cAAe,SAAkB;AAChD,aAAO,kBAAM,SAAS;AAAA,IACrB,QAAQ;AAAA,MACP,SAAS,CAAE,MAAO,CAAE,qBAAqB,KAAM,EAAE,IAAK;AAAA,MACtD,iBAAiB,CAAE,MAAO,EAAE,QAAS,WAAY,KAAK,EAAE,QAAS,WAAY;AAAA,IAC9E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAWA,sBAAsB;AAAA,EACvB,CAAE;AACH;AAEO,SAAS,iBAAkB,OAAkB;AACnD,SAAO,QAAQ,IAAK,MAAM,IAAK,CAAE,aAAiB,YAAS,SAAU,UAAU,OAAQ,CAAE,CAAE;AAC5F;AAEO,SAAS,2BAA4B,UAAqB;AAChE,SACC,SACE,IAAK,CAAE,YAAa,mBAAoB,OAAQ,CAAE,EAClD,KAAK,EAEL,IAAK,CAAE,SAAU,GAAI,KAAK,KAAM,GAAI,KAAK,SAAS,YAAY,KAAK,GAAI,EAAG,EAE1E,KAAM,IAAK;AAEf;AAEA,SAAS,mBAAoB,SAA+C;AAC3E,QAAM,cAA2C,CAAC;AAElD,GAAE,GAAG,sBAAsB,GAAG,gBAAiB,EAAE,QAAS,CAAE,WAAY;AACvE,KAAE,GAAG,QAAQ,SAAU,MAAO,CAAE,EAAE,QAAS,CAAE,QAAS;AACrD,kBAAY,KAAM;AAAA,QACjB,MAAM,iBAAiB,SAAU,MAAO,IAAI,YAAY;AAAA,QACxD,OAAO,IAAI,SAAS;AAAA,QACpB,OAAO,IAAK,CAAE;AAAA,MACf,CAAE;AAAA,IACH,CAAE;AAAA,EACH,CAAE;AAGF,SAAO,YAAY,KAAM,CAAE,GAAG,MAAO,EAAE,QAAQ,EAAE,KAAM;AACxD;;;AD7DA,IAAqB,+CAArB,MAAkE;AAAA,EACjE;AAAA,EAEA,YAAa,SAAmB;AAC/B,SAAK,UAAU;AAAA,EAChB;AAAA,EAEA,MAAO,UAAqB;AAC3B,aAAS,MAAM,UAAU,WAAY,KAAK,YAAY,MAAM,OAAQ,gBAAiB;AACpF,YAAM,UAAU,KAAK,WAAY,WAAY;AAE7C,YAAM,QAAQ;AAAA,QACb,QAAQ,IAAK,OAAQ,UAAW;AAC/B,gBAAM,eAAe,MAAM,iBAAkB,MAAM,cAAe,MAAM,OAAQ,CAAE;AAElF,gBAAM,eAAe,2BAA4B,YAAa;AAI9D,gBAAS,aAAS,UAAW,MAAM,MAAM,YAAa;AAAA,QACvD,CAAE;AAAA,MACH;AAAA,IACD,CAAE;AAAA,EACH;AAAA,EAEA,WAAY,aAA2B;AACtC,WAAO,CAAE,GAAG,YAAY,WAAY,EAClC,IAAK,CAAE,CAAE,IAAI,UAAW,MAAO;AAC/B,YAAM,QAAQ,WAAW,OAAO,KAAM,CAAE,EAAE,KAAK,MAAO,SAAS,EAAG;AAElE,UAAK,CAAE,OAAQ;AACd,eAAO;AAAA,MACR;AAEA,YAAM,cAAc,CAAE,GAAG,MAAM,KAAM,EAAE,KAAM,CAAE,MAAO,cAAc,KAAM,CAAE,CAAE;AAE9E,UAAK,CAAE,aAAc;AACpB,eAAO;AAAA,MACR;AAEA,YAAM,EAAE,MAAM,SAAS,IAAI,YAAY,QAAQ;AAE/C,UAAK,CAAE,UAAW;AACjB,eAAO;AAAA,MACR;AAEA,YAAM,WAAW,sBAAuB,YAAY,QAAS,UAAU,EAAE,UAAU,YAAY,CAAE,CAAE;AAEnG,aAAO;AAAA,QACN;AAAA,QACA;AAAA,QACA,MAAW,UAAM,UAAU,QAAS;AAAA,QACpC,SAAS,KAAK,QAAQ,QAAc,aAAS,QAAQ,IAAI,GAAG,WAAW,QAAS,CAAE,EAAE,OAAQ,GAAG,EAAG;AAAA,MACnG;AAAA,IACD,CAAE,EACD,OAAQ,OAAQ;AAAA,EACnB;AACD;","names":["fs","path"]}
|
package/dist/index.mjs
CHANGED
|
@@ -13,7 +13,7 @@ var COMMENTS_REGEXPS = [
|
|
|
13
13
|
];
|
|
14
14
|
var TRANSLATIONS_REGEXPS = [
|
|
15
15
|
// Matches translation functions: `__('Hello', 'elementor')`, `_n('Me', 'Us', 2, 'elementor-pro')`.
|
|
16
|
-
/\b_(?:_|n|nx|x)\(.*?,\s*(?<c>['"`])[\w-]+\k<c>\s*?\)/
|
|
16
|
+
/\b_(?:_|n|nx|x)\(.*?,\s*(?<c>['"`])[\w-]+\k<c>\s*?\)/gs
|
|
17
17
|
];
|
|
18
18
|
function createStringsFilePath(path2, suffix = ".strings.js") {
|
|
19
19
|
return path2.replace(/(\.min)?\.js$/i, suffix);
|
|
@@ -67,9 +67,7 @@ var ExtractI18nWordpressExpressionsWebpackPlugin = class {
|
|
|
67
67
|
const entries = this.getEntries(compilation);
|
|
68
68
|
await Promise.all(
|
|
69
69
|
entries.map(async (entry) => {
|
|
70
|
-
const fileContents = await getFilesContents(
|
|
71
|
-
await getFilesPaths(entry.pattern)
|
|
72
|
-
);
|
|
70
|
+
const fileContents = await getFilesContents(await getFilesPaths(entry.pattern));
|
|
73
71
|
const entryContent = generateStringsFileContent(fileContents);
|
|
74
72
|
await fs2.promises.writeFile(entry.path, entryContent);
|
|
75
73
|
})
|
|
@@ -95,10 +93,7 @@ var ExtractI18nWordpressExpressionsWebpackPlugin = class {
|
|
|
95
93
|
id,
|
|
96
94
|
chunk,
|
|
97
95
|
path: path.join(basePath, filePath),
|
|
98
|
-
pattern: this.options.pattern(
|
|
99
|
-
path.resolve(process.cwd(), entrypoint.origins[0].request),
|
|
100
|
-
id
|
|
101
|
-
)
|
|
96
|
+
pattern: this.options.pattern(path.resolve(process.cwd(), entrypoint.origins[0].request), id)
|
|
102
97
|
};
|
|
103
98
|
}).filter(Boolean);
|
|
104
99
|
}
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/plugin.ts","../src/utils.ts"],"sourcesContent":["import * as path from 'path';\nimport * as fs from 'fs';\nimport { Compilation, Compiler } from 'webpack';\nimport { EntrySettings } from './types';\nimport {
|
|
1
|
+
{"version":3,"sources":["../src/plugin.ts","../src/utils.ts"],"sourcesContent":["import * as path from 'path';\nimport * as fs from 'fs';\nimport { Compilation, Compiler } from 'webpack';\nimport { EntrySettings } from './types';\nimport { createStringsFilePath, generateStringsFileContent, getFilesContents, getFilesPaths } from './utils';\n\ntype Options = {\n\tpattern: ( entryPath: string, entryId: string ) => string;\n};\n\nexport default class ExtractI18nWordpressExpressionsWebpackPlugin {\n\toptions: Options;\n\n\tconstructor( options: Options ) {\n\t\tthis.options = options;\n\t}\n\n\tapply( compiler: Compiler ) {\n\t\tcompiler.hooks.afterEmit.tapPromise( this.constructor.name, async ( compilation ) => {\n\t\t\tconst entries = this.getEntries( compilation );\n\n\t\t\tawait Promise.all(\n\t\t\t\tentries.map( async ( entry ) => {\n\t\t\t\t\tconst fileContents = await getFilesContents( await getFilesPaths( entry.pattern ) );\n\n\t\t\t\t\tconst entryContent = generateStringsFileContent( fileContents );\n\n\t\t\t\t\t// Writing manually instead of using `chunk.files.add()` in order to avoid passing\n\t\t\t\t\t// the file through the loaders (transpilers, minifiers, etc.).\n\t\t\t\t\tawait fs.promises.writeFile( entry.path, entryContent );\n\t\t\t\t} )\n\t\t\t);\n\t\t} );\n\t}\n\n\tgetEntries( compilation: Compilation ) {\n\t\treturn [ ...compilation.entrypoints ]\n\t\t\t.map( ( [ id, entrypoint ] ) => {\n\t\t\t\tconst chunk = entrypoint.chunks.find( ( { name } ) => name === id );\n\n\t\t\t\tif ( ! chunk ) {\n\t\t\t\t\treturn null;\n\t\t\t\t}\n\n\t\t\t\tconst chunkJSFile = [ ...chunk.files ].find( ( f ) => /\\.(js|ts)$/i.test( f ) );\n\n\t\t\t\tif ( ! chunkJSFile ) {\n\t\t\t\t\treturn null;\n\t\t\t\t}\n\n\t\t\t\tconst { path: basePath } = compilation.options.output;\n\n\t\t\t\tif ( ! basePath ) {\n\t\t\t\t\treturn null;\n\t\t\t\t}\n\n\t\t\t\tconst filePath = createStringsFilePath( compilation.getPath( '[file]', { filename: chunkJSFile } ) );\n\n\t\t\t\treturn {\n\t\t\t\t\tid,\n\t\t\t\t\tchunk,\n\t\t\t\t\tpath: path.join( basePath, filePath ),\n\t\t\t\t\tpattern: this.options.pattern( path.resolve( process.cwd(), entrypoint.origins[ 0 ].request ), id ),\n\t\t\t\t};\n\t\t\t} )\n\t\t\t.filter( Boolean ) as EntrySettings[];\n\t}\n}\n","import { TranslationCallExpression } from './types';\nimport { glob } from 'glob';\nimport * as fs from 'fs';\n\nconst COMMENTS_REGEXPS = [\n\t// Matches translators comment block: `/* translators: %s */`.\n\t/\\/\\*[\\t ]*translators:.*\\*\\//gm,\n\t// Matches translators inline comment: `// translators: %s`.\n\t/(\\/\\/)[\\t ]*translators:[^\\r\\n]*/gm,\n] as const;\n\nconst TRANSLATIONS_REGEXPS = [\n\t// Matches translation functions: `__('Hello', 'elementor')`, `_n('Me', 'Us', 2, 'elementor-pro')`.\n\t/\\b_(?:_|n|nx|x)\\(.*?,\\s*(?<c>['\"`])[\\w-]+\\k<c>\\s*?\\)/gs,\n] as const;\n\nexport function createStringsFilePath( path: string, suffix = '.strings.js' ) {\n\treturn path.replace( /(\\.min)?\\.js$/i, suffix );\n}\n\nexport function getFilesPaths( pattern: string ) {\n\treturn glob( pattern, {\n\t\tignore: {\n\t\t\tignored: ( p ) => ! /\\.(js|ts|jsx|tsx)$/.test( p.name ),\n\t\t\tchildrenIgnored: ( p ) => p.isNamed( '__tests__' ) || p.isNamed( '__mocks__' ),\n\t\t},\n\n\t\t/**\n\t\t * Fix for Windows paths escaping.\n\t\t * Note: This means we don't support paths with special character (like `*`,`?`, etc.)\n\t\t * and only allow patterns that are constructed using `path.join()` or `path.resolve()`.\n\t\t *\n\t\t * @see https://github.com/isaacs/node-glob#options\n\t\t * @see https://github.com/isaacs/node-glob#windows\n\t\t * @see https://github.com/isaacs/node-glob/issues/212#issuecomment-1449062925\n\t\t */\n\t\twindowsPathsNoEscape: true,\n\t} );\n}\n\nexport function getFilesContents( paths: string[] ) {\n\treturn Promise.all( paths.map( ( filePath ) => fs.promises.readFile( filePath, 'utf-8' ) ) );\n}\n\nexport function generateStringsFileContent( contents: string[] ) {\n\treturn (\n\t\tcontents\n\t\t\t.map( ( content ) => extractExpressions( content ) )\n\t\t\t.flat()\n\t\t\t// Add a semicolon when needed.\n\t\t\t.map( ( expr ) => `${ expr.value }${ expr.type === 'comment' ? '' : ';' }` )\n\t\t\t// Join all the expressions to a single string with line-breaks between them.\n\t\t\t.join( '\\n' )\n\t);\n}\n\nfunction extractExpressions( content: string ): TranslationCallExpression[] {\n\tconst expressions: TranslationCallExpression[] = [];\n\n\t[ ...TRANSLATIONS_REGEXPS, ...COMMENTS_REGEXPS ].forEach( ( regexp ) => {\n\t\t[ ...content.matchAll( regexp ) ].forEach( ( res ) => {\n\t\t\texpressions.push( {\n\t\t\t\ttype: COMMENTS_REGEXPS.includes( regexp ) ? 'comment' : 'call-expression',\n\t\t\t\tindex: res.index || 0,\n\t\t\t\tvalue: res[ 0 ],\n\t\t\t} );\n\t\t} );\n\t} );\n\n\t// Sort by the index it was found in the file based on the regexp (and not by the order it was added to the array).\n\treturn expressions.sort( ( a, b ) => a.index - b.index );\n}\n"],"mappings":";AAAA,YAAY,UAAU;AACtB,YAAYA,SAAQ;;;ACApB,SAAS,YAAY;AACrB,YAAY,QAAQ;AAEpB,IAAM,mBAAmB;AAAA;AAAA,EAExB;AAAA;AAAA,EAEA;AACD;AAEA,IAAM,uBAAuB;AAAA;AAAA,EAE5B;AACD;AAEO,SAAS,sBAAuBC,OAAc,SAAS,eAAgB;AAC7E,SAAOA,MAAK,QAAS,kBAAkB,MAAO;AAC/C;AAEO,SAAS,cAAe,SAAkB;AAChD,SAAO,KAAM,SAAS;AAAA,IACrB,QAAQ;AAAA,MACP,SAAS,CAAE,MAAO,CAAE,qBAAqB,KAAM,EAAE,IAAK;AAAA,MACtD,iBAAiB,CAAE,MAAO,EAAE,QAAS,WAAY,KAAK,EAAE,QAAS,WAAY;AAAA,IAC9E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAWA,sBAAsB;AAAA,EACvB,CAAE;AACH;AAEO,SAAS,iBAAkB,OAAkB;AACnD,SAAO,QAAQ,IAAK,MAAM,IAAK,CAAE,aAAiB,YAAS,SAAU,UAAU,OAAQ,CAAE,CAAE;AAC5F;AAEO,SAAS,2BAA4B,UAAqB;AAChE,SACC,SACE,IAAK,CAAE,YAAa,mBAAoB,OAAQ,CAAE,EAClD,KAAK,EAEL,IAAK,CAAE,SAAU,GAAI,KAAK,KAAM,GAAI,KAAK,SAAS,YAAY,KAAK,GAAI,EAAG,EAE1E,KAAM,IAAK;AAEf;AAEA,SAAS,mBAAoB,SAA+C;AAC3E,QAAM,cAA2C,CAAC;AAElD,GAAE,GAAG,sBAAsB,GAAG,gBAAiB,EAAE,QAAS,CAAE,WAAY;AACvE,KAAE,GAAG,QAAQ,SAAU,MAAO,CAAE,EAAE,QAAS,CAAE,QAAS;AACrD,kBAAY,KAAM;AAAA,QACjB,MAAM,iBAAiB,SAAU,MAAO,IAAI,YAAY;AAAA,QACxD,OAAO,IAAI,SAAS;AAAA,QACpB,OAAO,IAAK,CAAE;AAAA,MACf,CAAE;AAAA,IACH,CAAE;AAAA,EACH,CAAE;AAGF,SAAO,YAAY,KAAM,CAAE,GAAG,MAAO,EAAE,QAAQ,EAAE,KAAM;AACxD;;;AD7DA,IAAqB,+CAArB,MAAkE;AAAA,EACjE;AAAA,EAEA,YAAa,SAAmB;AAC/B,SAAK,UAAU;AAAA,EAChB;AAAA,EAEA,MAAO,UAAqB;AAC3B,aAAS,MAAM,UAAU,WAAY,KAAK,YAAY,MAAM,OAAQ,gBAAiB;AACpF,YAAM,UAAU,KAAK,WAAY,WAAY;AAE7C,YAAM,QAAQ;AAAA,QACb,QAAQ,IAAK,OAAQ,UAAW;AAC/B,gBAAM,eAAe,MAAM,iBAAkB,MAAM,cAAe,MAAM,OAAQ,CAAE;AAElF,gBAAM,eAAe,2BAA4B,YAAa;AAI9D,gBAAS,aAAS,UAAW,MAAM,MAAM,YAAa;AAAA,QACvD,CAAE;AAAA,MACH;AAAA,IACD,CAAE;AAAA,EACH;AAAA,EAEA,WAAY,aAA2B;AACtC,WAAO,CAAE,GAAG,YAAY,WAAY,EAClC,IAAK,CAAE,CAAE,IAAI,UAAW,MAAO;AAC/B,YAAM,QAAQ,WAAW,OAAO,KAAM,CAAE,EAAE,KAAK,MAAO,SAAS,EAAG;AAElE,UAAK,CAAE,OAAQ;AACd,eAAO;AAAA,MACR;AAEA,YAAM,cAAc,CAAE,GAAG,MAAM,KAAM,EAAE,KAAM,CAAE,MAAO,cAAc,KAAM,CAAE,CAAE;AAE9E,UAAK,CAAE,aAAc;AACpB,eAAO;AAAA,MACR;AAEA,YAAM,EAAE,MAAM,SAAS,IAAI,YAAY,QAAQ;AAE/C,UAAK,CAAE,UAAW;AACjB,eAAO;AAAA,MACR;AAEA,YAAM,WAAW,sBAAuB,YAAY,QAAS,UAAU,EAAE,UAAU,YAAY,CAAE,CAAE;AAEnG,aAAO;AAAA,QACN;AAAA,QACA;AAAA,QACA,MAAW,UAAM,UAAU,QAAS;AAAA,QACpC,SAAS,KAAK,QAAQ,QAAc,aAAS,QAAQ,IAAI,GAAG,WAAW,QAAS,CAAE,EAAE,OAAQ,GAAG,EAAG;AAAA,MACnG;AAAA,IACD,CAAE,EACD,OAAQ,OAAQ;AAAA,EACnB;AACD;","names":["fs","path"]}
|
package/package.json
CHANGED
|
@@ -1,41 +1,41 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
2
|
+
"name": "@elementor/extract-i18n-wordpress-expressions-webpack-plugin",
|
|
3
|
+
"version": "0.3.2",
|
|
4
|
+
"private": false,
|
|
5
|
+
"author": "Elementor Team",
|
|
6
|
+
"homepage": "https://elementor.com/",
|
|
7
|
+
"license": "GPL-3.0-or-later",
|
|
8
|
+
"main": "dist/index.js",
|
|
9
|
+
"module": "dist/index.mjs",
|
|
10
|
+
"types": "dist/index.d.ts",
|
|
11
|
+
"exports": {
|
|
12
|
+
".": {
|
|
13
|
+
"import": "./dist/index.mjs",
|
|
14
|
+
"require": "./dist/index.js",
|
|
15
|
+
"types": "./dist/index.d.ts"
|
|
16
|
+
},
|
|
17
|
+
"./package.json": "./package.json"
|
|
18
|
+
},
|
|
19
|
+
"repository": {
|
|
20
|
+
"type": "git",
|
|
21
|
+
"url": "https://github.com/elementor/elementor-packages.git",
|
|
22
|
+
"directory": "packages/tools/extract-i18n-wordpress-expressions-webpack-plugin"
|
|
23
|
+
},
|
|
24
|
+
"bugs": {
|
|
25
|
+
"url": "https://github.com/elementor/elementor-packages/issues"
|
|
26
|
+
},
|
|
27
|
+
"publishConfig": {
|
|
28
|
+
"access": "public"
|
|
29
|
+
},
|
|
30
|
+
"scripts": {
|
|
31
|
+
"build": "tsup --config=../../tsup.build.ts",
|
|
32
|
+
"dev": "tsup --config=../../tsup.dev.ts --format=esm,cjs"
|
|
33
|
+
},
|
|
34
|
+
"peerDependencies": {
|
|
35
|
+
"webpack": "5.x"
|
|
36
|
+
},
|
|
37
|
+
"dependencies": {
|
|
38
|
+
"glob": "^10.3.10"
|
|
39
|
+
},
|
|
40
|
+
"gitHead": "10fd8663495a9ced2521f27a74879684ed0cf322"
|
|
41
41
|
}
|
|
@@ -24,19 +24,27 @@ describe( '@elementor/extract-i18n-wordpress-expressions-webpack-plugin', () =>
|
|
|
24
24
|
fs.mkdirSync( path.resolve( '/app/src/components' ), { recursive: true } );
|
|
25
25
|
fs.mkdirSync( path.resolve( '/app/src/hooks' ), { recursive: true } );
|
|
26
26
|
|
|
27
|
-
fs.writeFileSync(
|
|
27
|
+
fs.writeFileSync(
|
|
28
|
+
path.resolve( '/app/src/components/component.js' ),
|
|
29
|
+
`
|
|
28
30
|
export default function Component() {
|
|
29
31
|
return __( "Component", 'elementor' );
|
|
30
32
|
}
|
|
31
|
-
`
|
|
33
|
+
`
|
|
34
|
+
);
|
|
32
35
|
|
|
33
|
-
fs.writeFileSync(
|
|
36
|
+
fs.writeFileSync(
|
|
37
|
+
path.resolve( '/app/src/hooks/hook.ts' ),
|
|
38
|
+
`
|
|
34
39
|
export default function useHook() {
|
|
35
40
|
return __('hook','elementor');
|
|
36
41
|
}
|
|
37
|
-
`
|
|
42
|
+
`
|
|
43
|
+
);
|
|
38
44
|
|
|
39
|
-
fs.writeFileSync(
|
|
45
|
+
fs.writeFileSync(
|
|
46
|
+
path.resolve( '/app/src/index.js' ),
|
|
47
|
+
`
|
|
40
48
|
export default function Index() {
|
|
41
49
|
__(
|
|
42
50
|
'Some long text with multiple lines in the function call',
|
|
@@ -63,12 +71,16 @@ describe( '@elementor/extract-i18n-wordpress-expressions-webpack-plugin', () =>
|
|
|
63
71
|
invalid__( 'invalid', 'elementor' ),
|
|
64
72
|
];
|
|
65
73
|
}
|
|
66
|
-
`
|
|
74
|
+
`
|
|
75
|
+
);
|
|
67
76
|
|
|
68
77
|
fs.mkdirSync( path.resolve( '/app2/src' ), { recursive: true } );
|
|
69
|
-
fs.writeFileSync(
|
|
78
|
+
fs.writeFileSync(
|
|
79
|
+
path.resolve( '/app2/src/index.js' ),
|
|
80
|
+
`
|
|
70
81
|
export const test = __( 'from app 2', 'elementor' );
|
|
71
|
-
`
|
|
82
|
+
`
|
|
83
|
+
);
|
|
72
84
|
|
|
73
85
|
// Should not be in output.
|
|
74
86
|
const ignoredContent = `
|
package/src/plugin.ts
CHANGED
|
@@ -2,16 +2,11 @@ import * as path from 'path';
|
|
|
2
2
|
import * as fs from 'fs';
|
|
3
3
|
import { Compilation, Compiler } from 'webpack';
|
|
4
4
|
import { EntrySettings } from './types';
|
|
5
|
-
import {
|
|
6
|
-
createStringsFilePath,
|
|
7
|
-
generateStringsFileContent,
|
|
8
|
-
getFilesContents,
|
|
9
|
-
getFilesPaths,
|
|
10
|
-
} from './utils';
|
|
5
|
+
import { createStringsFilePath, generateStringsFileContent, getFilesContents, getFilesPaths } from './utils';
|
|
11
6
|
|
|
12
7
|
type Options = {
|
|
13
8
|
pattern: ( entryPath: string, entryId: string ) => string;
|
|
14
|
-
}
|
|
9
|
+
};
|
|
15
10
|
|
|
16
11
|
export default class ExtractI18nWordpressExpressionsWebpackPlugin {
|
|
17
12
|
options: Options;
|
|
@@ -26,9 +21,7 @@ export default class ExtractI18nWordpressExpressionsWebpackPlugin {
|
|
|
26
21
|
|
|
27
22
|
await Promise.all(
|
|
28
23
|
entries.map( async ( entry ) => {
|
|
29
|
-
const fileContents = await getFilesContents(
|
|
30
|
-
await getFilesPaths( entry.pattern )
|
|
31
|
-
);
|
|
24
|
+
const fileContents = await getFilesContents( await getFilesPaths( entry.pattern ) );
|
|
32
25
|
|
|
33
26
|
const entryContent = generateStringsFileContent( fileContents );
|
|
34
27
|
|
|
@@ -67,10 +60,7 @@ export default class ExtractI18nWordpressExpressionsWebpackPlugin {
|
|
|
67
60
|
id,
|
|
68
61
|
chunk,
|
|
69
62
|
path: path.join( basePath, filePath ),
|
|
70
|
-
pattern: this.options.pattern(
|
|
71
|
-
path.resolve( process.cwd(), entrypoint.origins[ 0 ].request ),
|
|
72
|
-
id
|
|
73
|
-
),
|
|
63
|
+
pattern: this.options.pattern( path.resolve( process.cwd(), entrypoint.origins[ 0 ].request ), id ),
|
|
74
64
|
};
|
|
75
65
|
} )
|
|
76
66
|
.filter( Boolean ) as EntrySettings[];
|
package/src/types.ts
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { Chunk } from 'webpack';
|
|
2
2
|
|
|
3
3
|
export type EntrySettings = {
|
|
4
|
-
id: string
|
|
5
|
-
chunk: Chunk
|
|
6
|
-
path: string
|
|
7
|
-
pattern: string
|
|
8
|
-
}
|
|
4
|
+
id: string;
|
|
5
|
+
chunk: Chunk;
|
|
6
|
+
path: string;
|
|
7
|
+
pattern: string;
|
|
8
|
+
};
|
|
9
9
|
|
|
10
10
|
export type TranslationCallExpression = {
|
|
11
|
-
type: 'comment' | 'call-expression'
|
|
12
|
-
index: number
|
|
13
|
-
value: string
|
|
11
|
+
type: 'comment' | 'call-expression';
|
|
12
|
+
index: number;
|
|
13
|
+
value: string;
|
|
14
14
|
};
|
package/src/utils.ts
CHANGED
|
@@ -11,7 +11,7 @@ const COMMENTS_REGEXPS = [
|
|
|
11
11
|
|
|
12
12
|
const TRANSLATIONS_REGEXPS = [
|
|
13
13
|
// Matches translation functions: `__('Hello', 'elementor')`, `_n('Me', 'Us', 2, 'elementor-pro')`.
|
|
14
|
-
/\b_(?:_|n|nx|x)\(.*?,\s*(?<c>['"`])[\w-]+\k<c>\s*?\)/
|
|
14
|
+
/\b_(?:_|n|nx|x)\(.*?,\s*(?<c>['"`])[\w-]+\k<c>\s*?\)/gs,
|
|
15
15
|
] as const;
|
|
16
16
|
|
|
17
17
|
export function createStringsFilePath( path: string, suffix = '.strings.js' ) {
|
|
@@ -21,7 +21,7 @@ export function createStringsFilePath( path: string, suffix = '.strings.js' ) {
|
|
|
21
21
|
export function getFilesPaths( pattern: string ) {
|
|
22
22
|
return glob( pattern, {
|
|
23
23
|
ignore: {
|
|
24
|
-
ignored: ( p ) => !
|
|
24
|
+
ignored: ( p ) => ! /\.(js|ts|jsx|tsx)$/.test( p.name ),
|
|
25
25
|
childrenIgnored: ( p ) => p.isNamed( '__tests__' ) || p.isNamed( '__mocks__' ),
|
|
26
26
|
},
|
|
27
27
|
|
|
@@ -43,13 +43,15 @@ export function getFilesContents( paths: string[] ) {
|
|
|
43
43
|
}
|
|
44
44
|
|
|
45
45
|
export function generateStringsFileContent( contents: string[] ) {
|
|
46
|
-
return
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
46
|
+
return (
|
|
47
|
+
contents
|
|
48
|
+
.map( ( content ) => extractExpressions( content ) )
|
|
49
|
+
.flat()
|
|
50
|
+
// Add a semicolon when needed.
|
|
51
|
+
.map( ( expr ) => `${ expr.value }${ expr.type === 'comment' ? '' : ';' }` )
|
|
52
|
+
// Join all the expressions to a single string with line-breaks between them.
|
|
53
|
+
.join( '\n' )
|
|
54
|
+
);
|
|
53
55
|
}
|
|
54
56
|
|
|
55
57
|
function extractExpressions( content: string ): TranslationCallExpression[] {
|