gtx-cli 2.0.1 → 2.0.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # gtx-cli
 
+## 2.0.2
+
+### Patch Changes
+
+- [#458](https://github.com/generaltranslation/gt/pull/458) [`aff4b95`](https://github.com/generaltranslation/gt/commit/aff4b95f582ec9fcb28f1395d2eba907c93e4e31) Thanks [@brian-lou](https://github.com/brian-lou)! - Add individual file support to validate
+
 ## 2.0.1
 
 ### Patch Changes

package/dist/cli/base.js

@@ -14,6 +14,7 @@ import { installPackage } from '../utils/installPackage.js';
 import { getPackageManager } from '../utils/packageManager.js';
 import { retrieveCredentials, setCredentials } from '../utils/credentials.js';
 import { areCredentialsSet } from '../utils/credentials.js';
+import { getCLIVersion } from '../utils/packageJson.js';
 export class BaseCLI {
     library;
     additionalModules;
@@ -21,6 +22,7 @@ export class BaseCLI {
     // Constructor is shared amongst all CLI class types
     constructor(program, library, additionalModules) {
         this.program = program;
+        this.program.version(getCLIVersion());
         this.library = library;
         this.additionalModules = additionalModules || [];
         this.setupInitCommand();

package/dist/cli/react.d.ts

@@ -17,5 +17,5 @@ export declare class ReactCLI extends BaseCLI {
     protected handleScanCommand(options: WrapOptions): Promise<void>;
     protected handleStage(initOptions: Options): Promise<void>;
     protected handleTranslate(initOptions: Options): Promise<void>;
-    protected handleValidate(initOptions: Options): Promise<void>;
+    protected handleValidate(initOptions: Options, files?: string[]): Promise<void>;
 }

package/dist/cli/react.js

@@ -88,17 +88,17 @@ export class ReactCLI extends BaseCLI {
     }
     setupValidateCommand() {
         this.program
-            .command('validate')
+            .command('validate [files...]')
             .description('Scans the project for a dictionary and/or <T> tags, and validates the project for errors.')
             .option('-c, --config <path>', 'Filepath to config file, by default gt.config.json', findFilepath(['gt.config.json']))
             .option('--tsconfig, --jsconfig <path>', 'Path to jsconfig or tsconfig file', findFilepath(['./tsconfig.json', './jsconfig.json']))
             .option('--dictionary <path>', 'Path to dictionary file')
             .option('--src <paths...>', "Space-separated list of glob patterns containing the app's source code, by default 'src/**/*.{js,jsx,ts,tsx}' 'app/**/*.{js,jsx,ts,tsx}' 'pages/**/*.{js,jsx,ts,tsx}' 'components/**/*.{js,jsx,ts,tsx}'")
             .option('--inline', 'Include inline <T> tags in addition to dictionary file', true)
-            .action(async (options) => {
+            .action(async (files, options) => {
             // intro here since we don't want to show the ascii title
             intro(chalk.cyan('Validating project...'));
-            await this.handleValidate(options);
+            await this.handleValidate(options, files);
             endCommand('Done!');
         });
     }
@@ -294,12 +294,19 @@ export class ReactCLI extends BaseCLI {
             await flattenJsonFiles(options);
         }
     }
-    async handleValidate(initOptions) {
+    async handleValidate(initOptions, files) {
         validateConfigExists();
         const settings = await generateSettings(initOptions);
         // First run the base class's handleTranslate method
         const options = { ...initOptions, ...settings };
         const pkg = this.library === 'gt-next' ? 'gt-next' : 'gt-react';
-        await validateProject(options, pkg);
+        if (files && files.length > 0) {
+            // Validate specific files using createInlineUpdates
+            await validateProject(options, pkg, files);
+        }
+        else {
+            // Validate whole project as before
+            await validateProject(options, pkg);
+        }
     }
 }

package/dist/react/parse/createDictionaryUpdates.d.ts

@@ -1,3 +1,3 @@
 import { BuildOptions } from 'esbuild';
 import { Updates } from '../../types/index.js';
-export default function createDictionaryUpdates(dictionaryPath: string, esbuildConfig?: BuildOptions): Promise<Updates>;
+export declare function createDictionaryUpdates(dictionaryPath: string, esbuildConfig?: BuildOptions): Promise<Updates>;

package/dist/react/parse/createDictionaryUpdates.js

@@ -7,7 +7,7 @@ import loadJSON from '../../fs/loadJSON.js';
 import { hashSource } from 'generaltranslation/id';
 import getEntryAndMetadata from '../utils/getEntryAndMetadata.js';
 import { logError } from '../../console/logging.js';
-export default async function createDictionaryUpdates(dictionaryPath, esbuildConfig) {
+export async function createDictionaryUpdates(dictionaryPath, esbuildConfig) {
     let dictionary;
     // ---- HANDLE JSON STRING DICTIONARY ----- //
     if (dictionaryPath.endsWith('.json')) {

package/dist/react/parse/createInlineUpdates.d.ts

@@ -1,5 +1,5 @@
-import { Options, Updates } from '../../types/index.js';
-export default function createInlineUpdates(options: Options, pkg: 'gt-react' | 'gt-next', validate: boolean): Promise<{
+import { Updates } from '../../types/index.js';
+export declare function createInlineUpdates(pkg: 'gt-react' | 'gt-next', validate: boolean, filePatterns: string[] | undefined): Promise<{
     updates: Updates;
     errors: string[];
 }>;

package/dist/react/parse/createInlineUpdates.js

@@ -12,12 +12,11 @@ import { validateStringFunction } from '../jsx/utils/validateStringFunction.js';
 import { GT_TRANSLATION_FUNCS } from '../jsx/utils/constants.js';
 import { matchFiles } from '../../fs/matchFiles.js';
 import { DEFAULT_SRC_PATTERNS } from '../../config/generateSettings.js';
-export default async function createInlineUpdates(options, pkg, validate) {
+export async function createInlineUpdates(pkg, validate, filePatterns) {
     const updates = [];
     const errors = [];
     // Use the provided app directory or default to the current directory
-    const filePatterns = options.src || DEFAULT_SRC_PATTERNS;
-    const files = matchFiles(process.cwd(), filePatterns);
+    const files = matchFiles(process.cwd(), filePatterns || DEFAULT_SRC_PATTERNS);
     for (const file of files) {
         const code = await fs.promises.readFile(file, 'utf8');
         let ast;

package/dist/translation/parse.js

@@ -1,8 +1,8 @@
 import fs from 'fs';
 import { logError } from '../console/logging.js';
 import loadJSON from '../fs/loadJSON.js';
-import createDictionaryUpdates from '../react/parse/createDictionaryUpdates.js';
-import createInlineUpdates from '../react/parse/createInlineUpdates.js';
+import { createDictionaryUpdates } from '../react/parse/createDictionaryUpdates.js';
+import { createInlineUpdates } from '../react/parse/createInlineUpdates.js';
 import createESBuildConfig from '../react/config/createESBuildConfig.js';
 import chalk from 'chalk';
 /**
@@ -48,7 +48,7 @@ export async function createUpdates(options, sourceDictionary, pkg, validate) {
     }
     // Scan through project for <T> tags
     if (options.inline) {
-        const { updates: newUpdates, errors: newErrors } = await createInlineUpdates(options, pkg, validate);
+        const { updates: newUpdates, errors: newErrors } = await createInlineUpdates(pkg, validate, options.src);
         errors = [...errors, ...newErrors];
         updates = [...updates, ...newUpdates];
     }

package/dist/translation/validate.d.ts

@@ -1,2 +1,2 @@
 import { Options, Settings } from '../types/index.js';
-export declare function validateProject(settings: Options & Settings, pkg: 'gt-react' | 'gt-next'): Promise<void>;
+export declare function validateProject(settings: Options & Settings, pkg: 'gt-react' | 'gt-next', files?: string[]): Promise<void>;

package/dist/translation/validate.js

@@ -3,7 +3,19 @@ import chalk from 'chalk';
 import findFilepath from '../fs/findFilepath.js';
 import { logError, logSuccess } from '../console/logging.js';
 import { createUpdates } from './parse.js';
-export async function validateProject(settings, pkg) {
+import { createInlineUpdates } from '../react/parse/createInlineUpdates.js';
+export async function validateProject(settings, pkg, files) {
+    if (files && files.length > 0) {
+        // Validate specific files using createInlineUpdates
+        const { errors } = await createInlineUpdates(pkg, true, files);
+        if (errors.length > 0) {
+            logErrorAndExit(chalk.red(`Error: CLI tool encountered ${errors.length} syntax errors:\n` +
+                errors
+                    .map((error) => chalk.red('• ') + chalk.white(error) + '\n')
+                    .join('')));
+        }
+        return;
+    }
     if (!settings.dictionary) {
         settings.dictionary = findFilepath([
             './dictionary.js',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtx-cli",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "main": "dist/index.js",
   "bin": "dist/main.js",
   "files": [