@vendure/ngx-translate-extract - npm Package Compare versions

Comparing version 9.2.0-next.0 to 9.2.0

dist/cli/cli.js

@@ -74,2 +74,9 @@ import yargs from 'yargs';
 })
+    .option('sort-sensitivity', {
+    alias: 'ss',
+    describe: 'Sort sensitivitiy of strings (only to be used when sorting)',
+    type: 'string',
+    choices: ['base', 'accent', 'case', 'variant'],
+    default: undefined
+})
     .option('clean', {
@@ -119,3 +126,3 @@ alias: 'c',
 })
-    .group(['format', 'format-indentation', 'sort', 'clean', 'replace', 'strip-prefix'], 'Output')
+    .group(['format', 'format-indentation', 'sort', 'sort-sensitivity', 'clean', 'replace', 'strip-prefix'], 'Output')
     .group(['key-as-default-value', 'key-as-initial-default-value', 'null-as-default-value', 'string-as-default-value'], 'Extracted key value (defaults to empty string)')
@@ -168,3 +175,3 @@ .conflicts('key-as-default-value', 'null-as-default-value')
 if (cli.sort) {
-    postProcessors.push(new SortByKeyPostProcessor());
+    postProcessors.push(new SortByKeyPostProcessor(cli.sortSensitivity));
 }
@@ -171,0 +178,0 @@ extractTask.setPostProcessors(postProcessors);

dist/parsers/function.parser.js

@@ -1,4 +0,3 @@
-import { tsquery } from '@phenomnomnominal/tsquery';
 import { TranslationCollection } from '../utils/translation.collection.js';
-import { getStringsFromExpression, findSimpleCallExpressions } from '../utils/ast-helpers.js';
+import { getStringsFromExpression, findSimpleCallExpressions, getAST } from '../utils/ast-helpers.js';
 import pkg from 'typescript';
@@ -12,3 +11,3 @@ const { isIdentifier } = pkg;
     extract(source, filePath) {
-        const sourceFile = tsquery.ast(source, filePath);
+        const sourceFile = getAST(source, filePath);
         let collection = new TranslationCollection();
@@ -15,0 +14,0 @@ const callExpressions = findSimpleCallExpressions(sourceFile, this.fnName);

dist/parsers/marker.parser.js

@@ -1,5 +0,3 @@
-import { ScriptKind, tsquery } from '@phenomnomnominal/tsquery';
-import { extname } from 'path';
 import { TranslationCollection } from '../utils/translation.collection.js';
-import { getNamedImportAlias, findFunctionCallExpressions, getStringsFromExpression } from '../utils/ast-helpers.js';
+import { getNamedImportAlias, findFunctionCallExpressions, getStringsFromExpression, getAST } from '../utils/ast-helpers.js';
 const MARKER_MODULE_NAME = 'ngx-translate-extract-marker';
@@ -9,10 +7,3 @@ const MARKER_IMPORT_NAME = 'marker';
     extract(source, filePath) {
-        const supportedScriptTypes = {
-            '.js': ScriptKind.JS,
-            '.jsx': ScriptKind.JSX,
-            '.ts': ScriptKind.TS,
-            '.tsx': ScriptKind.TSX
-        };
-        const scriptKind = supportedScriptTypes[extname(filePath)] ?? ScriptKind.TS;
-        const sourceFile = tsquery.ast(source, filePath, scriptKind);
+        const sourceFile = getAST(source, filePath);
         const markerImportName = getNamedImportAlias(sourceFile, MARKER_MODULE_NAME, MARKER_IMPORT_NAME);
@@ -19,0 +10,0 @@ if (!markerImportName) {

dist/parsers/service.parser.js

@@ -5,5 +5,4 @@ import path from 'node:path';
 import JSON5 from 'json5';
-import { tsquery } from '@phenomnomnominal/tsquery';
 import { TranslationCollection } from '../utils/translation.collection.js';
-import { findClassDeclarations, findClassPropertiesByType, findPropertyCallExpressions, findMethodCallExpressions, getStringsFromExpression, findMethodParameterByType, findConstructorDeclaration, getSuperClassName, getImportPath, findFunctionExpressions, findVariableNameByInjectType } from '../utils/ast-helpers.js';
+import { findClassDeclarations, findClassPropertiesByType, findPropertyCallExpressions, findMethodCallExpressions, getStringsFromExpression, findMethodParameterByType, findConstructorDeclaration, getSuperClassName, getImportPath, findFunctionExpressions, findVariableNameByInjectType, getAST } from '../utils/ast-helpers.js';
 const TRANSLATE_SERVICE_TYPE_REFERENCE = 'TranslateService';
@@ -14,3 +13,3 @@ const TRANSLATE_SERVICE_METHOD_NAMES = ['get', 'instant', 'stream'];
     extract(source, filePath) {
-        const sourceFile = tsquery.ast(source, filePath);
+        const sourceFile = getAST(source, filePath);
         const classDeclarations = findClassDeclarations(sourceFile);
@@ -108,3 +107,3 @@ const functionDeclarations = findFunctionExpressions(sourceFile);
             const superClassFileContent = fs.readFileSync(file, 'utf8');
-            const superClassAst = tsquery.ast(superClassFileContent, file);
+            const superClassAst = getAST(superClassFileContent, file);
             const superClassDeclarations = findClassDeclarations(superClassAst, superClassName);
@@ -111,0 +110,0 @@ const superClassPropertyNames = superClassDeclarations

dist/post-processors/sort-by-key.post-processor.d.ts

@@ -5,3 +5,5 @@ import { TranslationCollection } from '../utils/translation.collection.js';
     name: string;
+    sortSensitivity: 'base' | 'accent' | 'case' | 'variant' | undefined;
+    constructor(sortSensitivity: string | undefined);
     process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection;
 }

dist/post-processors/sort-by-key.post-processor.js

 export class SortByKeyPostProcessor {
     name = 'SortByKey';
+    sortSensitivity = undefined;
+    constructor(sortSensitivity) {
+        if (isOfTypeSortSensitivity(sortSensitivity)) {
+            this.sortSensitivity = sortSensitivity;
+        }
+        else {
+            throw new Error(`Unknown sortSensitivity: ${sortSensitivity}`);
+        }
+    }
     process(draft, extracted, existing) {
-        const compareFn = new Intl.Collator('en', { sensitivity: 'base' }).compare;
+        const compareFn = this.sortSensitivity ? new Intl.Collator('en', { sensitivity: this.sortSensitivity }).compare : undefined;
         return draft.sort(compareFn);
     }
 }
+function isOfTypeSortSensitivity(keyInput) {
+    return ['base', 'accent', 'case', 'variant'].includes(keyInput) || keyInput === undefined;
+}
 //# sourceMappingURL=sort-by-key.post-processor.js.map

dist/utils/ast-helpers.d.ts

@@ -1,2 +0,3 @@
-import pkg, { Node, NamedImports, ClassDeclaration, ConstructorDeclaration, CallExpression, Expression } from 'typescript';
+import pkg, { Node, NamedImports, ClassDeclaration, ConstructorDeclaration, CallExpression, Expression, SourceFile } from 'typescript';
+export declare function getAST(source: string, fileName?: string): SourceFile;
 export declare function getNamedImports(node: Node, moduleName: string): NamedImports[];
@@ -3,0 +4,0 @@ export declare function getNamedImportAlias(node: Node, moduleName: string, importName: string): string | null;

dist/utils/ast-helpers.js

@@ -1,4 +0,15 @@
-import { tsquery } from '@phenomnomnominal/tsquery';
+import { extname } from 'node:path';
+import { ScriptKind, tsquery } from '@phenomnomnominal/tsquery';
 import pkg from 'typescript';
 const { SyntaxKind, isStringLiteralLike, isArrayLiteralExpression, isBinaryExpression, isConditionalExpression } = pkg;
+export function getAST(source, fileName = '') {
+    const supportedScriptTypes = {
+        '.js': ScriptKind.JS,
+        '.jsx': ScriptKind.JSX,
+        '.ts': ScriptKind.TS,
+        '.tsx': ScriptKind.TSX
+    };
+    const scriptKind = supportedScriptTypes[extname(fileName)] ?? ScriptKind.TS;
+    return tsquery.ast(source, fileName, scriptKind);
+}
 export function getNamedImports(node, moduleName) {
@@ -5,0 +16,0 @@ const query = `ImportDeclaration[moduleSpecifier.text=/${moduleName}/] NamedImports`;

package.json

 {
   "name": "@vendure/ngx-translate-extract",
-  "version": "9.2.0-next.0",
+  "version": "9.2.0",
   "description": "Extract strings from projects using ngx-translate",
@@ -5,0 +5,0 @@ "author": "Kim Biesbjerg <[e-mail]>",

README.md

@@ -91,2 +91,12 @@ # ngx-translate-extract
 
+### Sorting
+
+Extracted keys are by default not sorted. You can enable sorting by using the `--sort` or `-s` flag.
+
+If sorting is enabled, the keys will be sorted using the default variant sort sensitivity. Other sort sensitivity options are also available using the `--sort-sensitivity` or `-ss` flag:
+- `base`: Strings that differ in base letters are unequal. For example `a !== b`, `a === á`, `a === A`
+- `accent`: Strings that differ in base letters and accents are unequal. For example `a !== b`, `a !== á`, `a === A`
+- `case`: Strings that differ in base letters or casing are unequal. For example `a !== b`, `a === á`, `a !== A`
+- `variant`: Strings that differ in base letters, accents, or casing are unequal. For example `a !== b`, `a !== á`, `a !== A`
+
 ### Marker function
@@ -114,2 +124,3 @@
   --sort, -s                  Sort strings in alphabetical order                                         [boolean]
+  --sort-sensitivity, -ss     Sensitivity when sorting strings (only when sort is enabled)				 [string]
   --clean, -c                 Remove obsolete strings after merge                                        [boolean]
@@ -116,0 +127,0 @@ --replace, -r               Replace the contents of output file if it exists (Merges by default)       [boolean]

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

139314

increased by1.72%

Lines of code

1687

increased by1.32%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

166

increased by7.1%

No dependency changes