@fgv/ts-res-cli 1.0.0

package/README.md

@@ -0,0 +1,197 @@
+# @fgv/ts-res-cli
+
+Command-line interface for compiling and managing ts-res resources with contextual filtering and optimization.
+
+## Installation
+
+```bash
+# From the monorepo root
+rush install
+rushx build --to @fgv/ts-res-cli
+```
+
+## Usage
+
+### Compile Resources
+
+```bash
+ts-res-compile compile -i ./resources -o ./dist/resources.json
+```
+
+### Advanced Compilation
+
+```bash
+# Compile with context filtering
+ts-res-compile compile \
+  -i ./resources \
+  -o ./dist/resources.json \
+  --context '{"language": "en-US", "territory": "US"}' \
+  --format json
+# Compile for production with TypeScript output
+ts-res-compile compile \
+  -i ./resources \
+  -o ./dist/resources.ts \
+  --format ts \
+  --include-metadata
+```
+
+### Validate Resources
+
+```bash
+# Validate resource files
+ts-res-compile validate -i ./resources
+```
+
+### Get Resource Information
+
+```bash
+# Get basic resource information
+ts-res-compile info -i ./resources
+
+# Get filtered information
+ts-res-compile info \
+  -i ./resources \
+  --context '{"language": "en"}' \
+```
+
+## Commands
+
+### `compile`
+
+Compiles resources from input to output format.
+
+**Required Options:**
+- `-i, --input <path>` - Input file or directory path
+- `-o, --output <path>` - Output file path
+
+**Optional Options:**
+- `-c, --context <json>` - Context filter for resources (JSON string)
+- `-f, --format <format>` - Output format (json, js, ts, binary) [default: json]
+- `--debug` - Include debug information [default: false]
+- `-v, --verbose` - Verbose output [default: false]
+- `-q, --quiet` - Quiet output [default: false]
+- `--validate` - Validate resources during compilation [default: true]
+- `--include-metadata` - Include resource metadata in output [default: false]
+- `--resource-types <types>` - Resource type filter (comma-separated)
+- `--max-distance <number>` - Maximum distance for language matching
+
+### `validate`
+
+Validates resources without compilation.
+
+**Required Options:**
+- `-i, --input <path>` - Input file or directory path
+
+**Optional Options:**
+- `-v, --verbose` - Verbose output [default: false]
+- `-q, --quiet` - Quiet output [default: false]
+
+### `info`
+
+Shows information about resources.
+
+**Required Options:**
+- `-i, --input <path>` - Input file or directory path
+
+**Optional Options:**
+- `-c, --context <json>` - Context filter for resources (JSON string)
+- `--resource-types <types>` - Resource type filter (comma-separated)
+- `--max-distance <number>` - Maximum distance for language matching
+
+## Input Formats
+
+The CLI supports the following input formats:
+
+### Resource Candidate Array
+```json
+[
+  {
+    "id": "welcome.message",
+    "json": { "text": "Welcome!" },
+    "conditions": { "language": "en" },
+    "resourceTypeName": "json"
+  }
+]
+```
+
+### Resource Collection
+```json
+{
+  "resources": [
+    {
+      "id": "welcome.message",
+      "resourceTypeName": "json",
+      "candidates": [
+        {
+          "json": { "text": "Welcome!" },
+          "conditions": { "language": "en" }
+        }
+      ]
+    }
+  ]
+}
+```
+
+## Output Formats
+
+### JSON (default)
+```json
+{
+  "resources": {
+    "welcome.message": {
+      "default": { "text": "Welcome!" }
+    }
+  }
+}
+```
+
+### JavaScript
+```javascript
+module.exports = {
+  "resources": {
+    "welcome.message": {
+      "default": { "text": "Welcome!" }
+    }
+  }
+};
+```
+
+### TypeScript
+```typescript
+export const resources = {
+  "resources": {
+    "welcome.message": {
+      "default": { "text": "Welcome!" }
+    }
+  }
+} as const;
+```
+
+## Context Filtering
+
+Context filtering allows you to compile only resources that match specific conditions:
+
+```bash
+# Only resources for English language
+ts-res-compile compile -i ./resources -o ./en.json \
+  --context '{"language": "en"}'
+
+## Examples
+
+See the `examples/` directory for sample resource files and compilation scenarios.
+
+## Development
+
+```bash
+# Build the CLI
+rushx build
+
+# Run tests
+rushx test
+
+# Run linting
+rushx lint
+
+# Generate documentation
+rushx build-docs
+```

package/bin/ts-res-compile.js

@@ -0,0 +1,40 @@
+#!/usr/bin/env node
+
+/*
+ * 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.
+ */
+
+const { TsResCliApp } = require('../lib/cli');
+
+async function main() {
+  try {
+    const app = new TsResCliApp();
+    await app.run(process.argv);
+  } catch (error) {
+    console.error('Fatal error:', error.message);
+    process.exit(1);
+  }
+}
+
+main().catch((error) => {
+  console.error('Unhandled error:', error);
+  process.exit(1);
+});

package/config/jest.config.json

@@ -0,0 +1,9 @@
+{
+  "testMatch": ["<rootDir>/src/test/**/*.test.ts", "<rootDir>/test/**/*.test.ts"],
+  "preset": "ts-jest",
+  "testEnvironment": "node",
+  "extensionsToTreatAsEsm": [],
+  "transform": {
+    "^.+\\.ts$": "ts-jest"
+  }
+}

package/config/rig.json

@@ -0,0 +1,16 @@
+// The "rig.json" file directs tools to look for their config files in an external package.
+// Documentation for this system: https://www.npmjs.com/package/@rushstack/rig-package
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
+  /**
+   * (Required) The name of the rig package to inherit from.
+   * It should be an NPM package name with the "-rig" suffix.
+   */
+  "rigPackageName": "@rushstack/heft-node-rig"
+  /**
+   * (Optional) Selects a config profile from the rig package.  The name must consist of
+   * lowercase alphanumeric words separated by hyphens, for example "sample-profile".
+   * If omitted, then the "default" profile will be used."
+   */
+  // "rigProfile": "your-profile-name"
+}

package/lib/cli.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Main CLI class for ts-res-compile
+ */
+export declare class TsResCliApp {
+    private readonly _program;
+    constructor();
+    /**
+     * Runs the CLI with the provided arguments
+     */
+    run(argv: string[]): Promise<void>;
+    /**
+     * Sets up the CLI commands and options
+     */
+    private _setupCommands;
+    /**
+     * Handles the compile command
+     */
+    private _handleCompileCommand;
+    /**
+     * Handles the validate command
+     */
+    private _handleValidateCommand;
+    /**
+     * Handles the info command
+     */
+    private _handleInfoCommand;
+    /**
+     * Handles the config command
+     */
+    private _handleConfigCommand;
+    /**
+     * Parses and validates compile options
+     */
+    private _parseCompileOptions;
+}
+//# sourceMappingURL=cli.d.ts.map

package/lib/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AA0FA;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;;IAOnC;;OAEG;IACU,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/C;;OAEG;IACH,OAAO,CAAC,cAAc;IAkHtB;;OAEG;YACW,qBAAqB;IAoBnC;;OAEG;YACW,sBAAsB;IA6CpC;;OAEG;YACW,kBAAkB;IA6ChC;;OAEG;YACW,oBAAoB;IAoNlC;;OAEG;IACH,OAAO,CAAC,oBAAoB;CA4C7B"}