@vocab/webpack 1.2.3 → 1.2.5

package/README.md

@@ -29,7 +29,7 @@ $ npm i --save @vocab/core @vocab/react
 
 ### Step 2: Configure Vocab
 
-You can configure Vocab directly when calling the API or via a `vocab.config.js` file.
+You can configure Vocab directly when calling the API or via a `vocab.config.js` or `vocab.config.cjs` file.
 
 In this example we've configured two languages, English and French, where our initial `translation.json` files will use English.
 
@@ -184,7 +184,7 @@ t('my key with component', {
 
 ## Configuration
 
-Configuration can either be passed into the Node API directly or be gathered from the nearest _vocab.config.js_ file.
+Configuration can either be passed into the Node API directly or be gathered from the nearest _vocab.config.js_ or _vocab.config.cjs_ file.
 
 **vocab.config.js**
 
@@ -341,7 +341,7 @@ functionality.
 
 ### Generating a pseudo-localized language using Vocab
 
-Vocab can generate a pseudo-localized language via the [`generatedLanguages` config][generated languages config], either via the webpack plugin or your `vocab.config.js` file.
+Vocab can generate a pseudo-localized language via the [`generatedLanguages` config][generated languages config], either via the webpack plugin or your `vocab.config.js` or `vocab.config.cjs` file.
 `@vocab/pseudo-localize` exports a `generator` that can be used directly in your config.
 
 **vocab.config.js**
@@ -506,6 +506,38 @@ Tags on keys in other languages will be ignored.
 [tags]: https://support.phrase.com/hc/en-us/articles/5822598372252-Tags-Strings-
 [configuration]: #Configuration
 
+#### Global key
+
+`vocab push` and `vocab pull` can support global keys mapping. When you want certain translations to use a specific/custom key in Phrase, add the `globalKey` to the structure.
+
+```jsonc
+// translations.json
+{
+  "Hello": {
+    "message": "Hello",
+    "globalKey": "hello"
+  },
+  "Goodbye": {
+    "message": "Goodbye",
+    "globalKey": "app.goodbye.label"
+  }
+}
+```
+
+In the above example,
+
+- `vocab push` will push the `hello` and `app.goodbye.label` keys to Phrase.
+- `vocab pull` will pull translations from Phrase and map them to the `hello` and `app.goodbye.label` keys.
+
+##### Error on no translation for global key
+
+By default, `vocab pull` will not error if a translation is missing in Phrase for a translation with a global key.
+If you want to throw an error in this situation, pass the `--error-on-no-global-key-translation` flag:
+
+```sh
+vocab pull --error-on-no-global-key-translation
+```
+
 ## Troubleshooting
 
 ### Problem: Passed locale is being ignored or using en-US instead

package/chunk-name/dist/vocab-webpack-chunk-name.cjs.d.ts

@@ -1 +1,2 @@
 export * from "../../dist/declarations/src/chunk-name";
+//# sourceMappingURL=vocab-webpack-chunk-name.cjs.d.ts.map

package/chunk-name/dist/vocab-webpack-chunk-name.cjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vocab-webpack-chunk-name.cjs.d.ts","sourceRoot":"","sources":["../../dist/declarations/src/chunk-name.d.ts"],"names":[],"mappings":"AAAA"}

package/dist/declarations/src/index.d.ts

@@ -1,4 +1,4 @@
-import type { UserConfig } from '@vocab/core';
+import { type UserConfig } from '@vocab/core';
 import type { Compiler } from 'webpack';
 interface UserOptions extends Partial<UserConfig> {
     configFile?: string;

package/dist/declarations/src/loader.d.ts

@@ -1,4 +1,4 @@
-import type { UserConfig } from '@vocab/core';
+import { type UserConfig } from '@vocab/core';
 import type { LoaderContext as WebpackLoaderContext } from 'webpack';
 type LoaderContext = WebpackLoaderContext<UserConfig>;
 export default function vocabLoader(this: LoaderContext, source: string): Promise<void>;

package/dist/vocab-webpack.cjs.d.ts

@@ -1 +1,2 @@
 export * from "./declarations/src/index";
+//# sourceMappingURL=vocab-webpack.cjs.d.ts.map

package/dist/vocab-webpack.cjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vocab-webpack.cjs.d.ts","sourceRoot":"","sources":["./declarations/src/index.d.ts"],"names":[],"mappings":"AAAA"}

package/loader/dist/vocab-webpack-loader.cjs.d.ts

@@ -1,2 +1,3 @@
 export * from "../../dist/declarations/src/loader";
 export { default } from "../../dist/declarations/src/loader";
+//# sourceMappingURL=vocab-webpack-loader.cjs.d.ts.map

package/loader/dist/vocab-webpack-loader.cjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vocab-webpack-loader.cjs.d.ts","sourceRoot":"","sources":["../../dist/declarations/src/loader.d.ts"],"names":[],"mappings":"AAAA"}

package/loader/dist/vocab-webpack-loader.cjs.dev.js

@@ -3,9 +3,9 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var path = require('path');
+var core = require('@vocab/core');
 var cjsModuleLexer = require('cjs-module-lexer');
 var esModuleLexer = require('es-module-lexer');
-var core = require('@vocab/core');
 var chunkName_dist_vocabWebpackChunkName = require('../../chunk-name/dist/vocab-webpack-chunk-name.cjs.dev.js');
 var logger = require('../../dist/logger-65149486.cjs.dev.js');
 require('chalk');

package/loader/dist/vocab-webpack-loader.cjs.prod.js

@@ -3,9 +3,9 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var path = require('path');
+var core = require('@vocab/core');
 var cjsModuleLexer = require('cjs-module-lexer');
 var esModuleLexer = require('es-module-lexer');
-var core = require('@vocab/core');
 var chunkName_dist_vocabWebpackChunkName = require('../../chunk-name/dist/vocab-webpack-chunk-name.cjs.prod.js');
 var logger = require('../../dist/logger-f79e34a8.cjs.prod.js');
 require('chalk');

package/loader/dist/vocab-webpack-loader.esm.js

@@ -1,7 +1,7 @@
 import path from 'path';
+import { getDevLanguageFileFromTsFile, loadTranslation } from '@vocab/core';
 import * as cjsModuleLexer from 'cjs-module-lexer';
 import * as esModuleLexer from 'es-module-lexer';
-import { getDevLanguageFileFromTsFile, loadTranslation } from '@vocab/core';
 import { getChunkName } from '../../chunk-name/dist/vocab-webpack-chunk-name.esm.js';
 import { t as trace$1 } from '../../dist/logger-e1862ea1.esm.js';
 import 'chalk';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vocab/webpack",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "main": "dist/vocab-webpack.cjs.js",
   "module": "dist/vocab-webpack.esm.js",
   "exports": {
@@ -39,7 +39,7 @@
     "web"
   ],
   "dependencies": {
-    "@vocab/core": "^1.4.0",
+    "@vocab/core": "^1.6.0",
     "chalk": "^4.1.0",
     "cjs-module-lexer": "^1.2.2",
     "debug": "^4.3.1",

package/web/dist/vocab-webpack-web.cjs.d.ts

@@ -1 +1,2 @@
 export * from "../../dist/declarations/src/web";
+//# sourceMappingURL=vocab-webpack-web.cjs.d.ts.map

package/web/dist/vocab-webpack-web.cjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vocab-webpack-web.cjs.d.ts","sourceRoot":"","sources":["../../dist/declarations/src/web.d.ts"],"names":[],"mappings":"AAAA"}

package/dist/declarations/src/logger.d.ts

@@ -1,3 +0,0 @@
-import debug from 'debug';
-export declare const trace: debug.Debugger;
-export declare const log: (...params: unknown[]) => void;