@fgv/ts-res-cli 1.0.0

package/lib/options.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Output format options for resource compilation
+ */
+export type OutputFormat = 'compiled' | 'source' | 'js' | 'ts' | 'binary';
+/**
+ * Options for resource compilation
+ */
+export interface ICompileOptions {
+    /**
+     * Input file or directory path
+     */
+    input: string;
+    /**
+     * Output file path
+     */
+    output: string;
+    /**
+     * System configuration file path (JSON file in ISystemConfiguration format)
+     */
+    config?: string;
+    /**
+     * Context filter token (pipe-separated qualifier=value pairs, e.g., 'language=en-US|territory=US')
+     */
+    contextFilter?: string;
+    /**
+     * Qualifier default values token (pipe-separated qualifier=value pairs, e.g., 'language=en-US,en-CA|territory=US')
+     */
+    qualifierDefaults?: string;
+    /**
+     * Output format
+     */
+    format: OutputFormat;
+    /**
+     * Whether to include debug information
+     */
+    debug: boolean;
+    /**
+     * Whether to run in verbose mode
+     */
+    verbose: boolean;
+    /**
+     * Whether to run in quiet mode
+     */
+    quiet: boolean;
+    /**
+     * Whether to validate resources during compilation
+     */
+    validate: boolean;
+    /**
+     * Whether to include resource metadata in output
+     */
+    includeMetadata: boolean;
+    /**
+     * Resource type filter (e.g., 'json,other')
+     */
+    resourceTypes?: string;
+    /**
+     * Maximum distance for language matching
+     */
+    maxDistance?: number;
+    /**
+     * Whether to reduce qualifiers when filtering by context
+     */
+    reduceQualifiers?: boolean;
+}
+//# sourceMappingURL=options.d.ts.map

package/lib/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAsBA;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,QAAQ,GAAG,IAAI,GAAG,IAAI,GAAG,QAAQ,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B"}

package/lib/options.js

@@ -0,0 +1,24 @@
+"use strict";
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=options.js.map

package/lib/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG","sourcesContent":["/*\r\n * Copyright (c) 2025 Erik Fortune\r\n *\r\n * Permission is hereby granted, free of charge, to any person obtaining a copy\r\n * of this software and associated documentation files (the \"Software\"), to deal\r\n * in the Software without restriction, including without limitation the rights\r\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r\n * copies of the Software, and to permit persons to whom the Software is\r\n * furnished to do so, subject to the following conditions:\r\n *\r\n * The above copyright notice and this permission notice shall be included in all\r\n * copies or substantial portions of the Software.\r\n *\r\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r\n * SOFTWARE.\r\n */\r\n\r\n/**\r\n * Output format options for resource compilation\r\n */\r\nexport type OutputFormat = 'compiled' | 'source' | 'js' | 'ts' | 'binary';\r\n\r\n/**\r\n * Options for resource compilation\r\n */\r\nexport interface ICompileOptions {\r\n  /**\r\n   * Input file or directory path\r\n   */\r\n  input: string;\r\n\r\n  /**\r\n   * Output file path\r\n   */\r\n  output: string;\r\n\r\n  /**\r\n   * System configuration file path (JSON file in ISystemConfiguration format)\r\n   */\r\n  config?: string;\r\n\r\n  /**\r\n   * Context filter token (pipe-separated qualifier=value pairs, e.g., 'language=en-US|territory=US')\r\n   */\r\n  contextFilter?: string;\r\n\r\n  /**\r\n   * Qualifier default values token (pipe-separated qualifier=value pairs, e.g., 'language=en-US,en-CA|territory=US')\r\n   */\r\n  qualifierDefaults?: string;\r\n\r\n  /**\r\n   * Output format\r\n   */\r\n  format: OutputFormat;\r\n\r\n  /**\r\n   * Whether to include debug information\r\n   */\r\n  debug: boolean;\r\n\r\n  /**\r\n   * Whether to run in verbose mode\r\n   */\r\n  verbose: boolean;\r\n\r\n  /**\r\n   * Whether to run in quiet mode\r\n   */\r\n  quiet: boolean;\r\n\r\n  /**\r\n   * Whether to validate resources during compilation\r\n   */\r\n  validate: boolean;\r\n\r\n  /**\r\n   * Whether to include resource metadata in output\r\n   */\r\n  includeMetadata: boolean;\r\n\r\n  /**\r\n   * Resource type filter (e.g., 'json,other')\r\n   */\r\n  resourceTypes?: string;\r\n\r\n  /**\r\n   * Maximum distance for language matching\r\n   */\r\n  maxDistance?: number;\r\n\r\n  /**\r\n   * Whether to reduce qualifiers when filtering by context\r\n   */\r\n  reduceQualifiers?: boolean;\r\n}\r\n"]}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@fgv/ts-res-cli",
+  "version": "1.0.0",
+  "description": "Command-line interface for ts-res resource compilation and management",
+  "main": "lib/index.js",
+  "bin": {
+    "ts-res-compile": "bin/ts-res-compile.js"
+  },
+  "keywords": [
+    "typescript",
+    "resources",
+    "internationalization",
+    "localization",
+    "cli",
+    "tool"
+  ],
+  "author": "Erik Fortune",
+  "license": "MIT",
+  "dependencies": {
+    "commander": "^11.0.0",
+    "@fgv/ts-res": "5.0.0-0",
+    "@fgv/ts-utils": "5.0.0-0",
+    "@fgv/ts-extras": "5.0.0-0",
+    "@fgv/ts-json-base": "5.0.0-0",
+    "@fgv/ts-json": "5.0.0-0"
+  },
+  "devDependencies": {
+    "@rushstack/heft": "~0.74.0",
+    "@rushstack/heft-node-rig": "~2.9.0",
+    "@rushstack/eslint-config": "~4.4.0",
+    "@types/heft-jest": "1.0.6",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.14.9",
+    "@typescript-eslint/eslint-plugin": "^7.14.1",
+    "@typescript-eslint/parser": "^7.14.1",
+    "eslint": "^8.57.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.4.0",
+    "typescript": "^5.7.3",
+    "@fgv/ts-utils-jest": "5.0.0-0"
+  },
+  "peerDependencies": {
+    "typescript": "^5.7.3"
+  },
+  "scripts": {
+    "build": "heft build --clean",
+    "test": "heft test --clean",
+    "build-all": "rushx build && rushx build-docs",
+    "coverage": "heft test --clean --coverage",
+    "clean": "heft clean",
+    "lint": "eslint src --ext .ts",
+    "fixlint": "eslint src --ext .ts --fix",
+    "build-docs": "api-documenter markdown --input-folder ./temp --output-folder ./docs",
+    "test-handles": "rushx test --detectOpenHandles",
+    "clean-jest": "rushx test --clearCache",
+    "build-samples": "node bin/ts-res-compile.js compile -i src/test/data/sample-resources.json -o temp/sample-output.json --include-metadata",
+    "build-samples-all": "npm run build-samples && node bin/ts-res-compile.js compile -i src/test/data/resource-collection.json -o temp/collection-output.json --include-metadata && node bin/ts-res-compile.js compile -i src/test/data/sample-resources.json -o temp/sample-output.js -f js && node bin/ts-res-compile.js compile -i src/test/data/sample-resources.json -o temp/sample-output.ts -f ts"
+  }
+}