@caleuche/cli 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @caleuche/cli
 
+## 0.5.0
+
+### Minor Changes
+
+- 8b3f4d5: Add support for sample tags
+
+### Patch Changes
+
+- Updated dependencies [8b3f4d5]
+  - @caleuche/core@0.4.0
+
+## 0.4.1
+
+### Patch Changes
+
+- Updated dependencies [1dd1a48]
+- Updated dependencies [6254997]
+  - @caleuche/core@0.3.0
+
 ## 0.4.0
 
 ### Minor Changes

package/dist/batch.js

@@ -97,6 +97,9 @@ function batchCompile(batchFile, options) {
             if (!resolvedVariant) {
                 process.exit(1);
             }
+            if (variant.tags) {
+                sample.tags = variant.tags;
+            }
             const effectiveOutputPath = path_1.default.join(options?.outputDir || workingDirectory, variant.output);
             if (!(0, common_1.compileAndWriteOutput)(sample, resolvedVariant.properties, effectiveOutputPath, {
                 project: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caleuche/cli",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "main": "dist/index.js",
   "bin": {
     "che": "dist/index.js"
@@ -19,7 +19,7 @@
   "license": "MIT",
   "description": "Caleuche CLI",
   "dependencies": {
-    "@caleuche/core": "^0.2.0",
+    "@caleuche/core": "^0.4.0",
     "commander": "^14.0.0",
     "yaml": "^2.8.0"
   },

package/src/batch.ts

@@ -80,7 +80,10 @@ function resolveVariantDefinition(
   }
 }
 
-export function batchCompile(batchFile: string, options: { outputDir?: string }) {
+export function batchCompile(
+  batchFile: string,
+  options: { outputDir?: string },
+) {
   if (!isFile(batchFile)) {
     console.error(`Batch file "${batchFile}" does not exist or is not a file.`);
     process.exit(1);
@@ -125,14 +128,24 @@ export function batchCompile(batchFile: string, options: { outputDir?: string })
         process.exit(1);
       }
 
+      if (variant.tags) {
+        sample.tags = variant.tags;
+      }
+
       const effectiveOutputPath = path.join(
         options?.outputDir || workingDirectory,
-        variant.output);
+        variant.output,
+      );
 
       if (
-        !compileAndWriteOutput(sample, resolvedVariant.properties, effectiveOutputPath, {
-          project: true,
-        })
+        !compileAndWriteOutput(
+          sample,
+          resolvedVariant.properties,
+          effectiveOutputPath,
+          {
+            project: true,
+          },
+        )
       ) {
         console.error(
           `Sample: ${sampleDefinition.templatePath}, Variant: ${JSON.stringify(variant)}`,

package/src/index.ts

@@ -12,16 +12,31 @@ program
 
 program
   .command("compile")
-  .argument("<sample-path>", "Path to the sample file or the directory that containes it.")
-  .argument("<data-file>", "Path to the input to be used to compile the template.")
-  .argument("<output-directory>", "Directory where the compiled output will be written.")
-  .option("-p, --project", "Flag to indicate whether to generate the appropriate project file along with the compiled template.")
+  .argument(
+    "<sample-path>",
+    "Path to the sample file or the directory that containes it.",
+  )
+  .argument(
+    "<data-file>",
+    "Path to the input to be used to compile the template.",
+  )
+  .argument(
+    "<output-directory>",
+    "Directory where the compiled output will be written.",
+  )
+  .option(
+    "-p, --project",
+    "Flag to indicate whether to generate the appropriate project file along with the compiled template.",
+  )
   .action(compile);
 
 program
   .command("batch")
   .argument("<batch-file>", "Path to the batch file")
-  .option("-d, --output-dir <outputDir>", "Output directory for compiled samples")
+  .option(
+    "-d, --output-dir <outputDir>",
+    "Output directory for compiled samples",
+  )
   .action(batchCompile);
 
 program.parse();

package/src/interfaces.ts

@@ -21,6 +21,7 @@ type SampleVariantInput =
 interface SampleVariantConfig {
   output: string;
   input: SampleVariantInput | string;
+  tags?: Record<string, any>;
 }
 
 interface SampleDefinition {

package/test/bach.test.ts

@@ -352,4 +352,54 @@ describe("batchCompile", () => {
       "console.log('2');",
     );
   });
+
+  it("should write sample tags file if defined", () => {
+    mockCompileSample.mockReturnValue({
+      items: [
+        { fileName: "file1.js", content: "console.log('1');" },
+        { fileName: "tags.yaml", content: "tag1: value1\ntag2: value2" }
+      ],
+    });
+    const batchFilePath = getPath("batch.yaml");
+    const batchFileContent = multiline`
+      variants:
+        - name: foo
+          input:
+            type: object
+            properties:
+              var2: value
+      samples:
+        - templatePath: sample.yaml
+          variants:
+            - output: out
+              input: foo
+              tags:
+                tag1: value1
+                tag2: value2
+    `;
+    fs.writeFileSync(batchFilePath, batchFileContent);
+    const sampleFilePath = getPath("sample.yaml");
+    const sampleContent = multiline`
+      template: sample.js.template
+      type: javascript
+      dependencies:
+      input:
+        - name: var
+          type: string
+          required: true
+    `;
+    fs.writeFileSync(sampleFilePath, sampleContent);
+    batchCompile(batchFilePath, {});
+    expect(fs.existsSync(getPath("out/file1.js"))).toBe(true);
+    expect(fs.readFileSync(getPath("out/file1.js"), "utf-8")).toBe(
+      "console.log('1');",
+    );
+    expect(fs.existsSync(getPath("out/tags.yaml"))).toBe(true);
+    expect(fs.readFileSync(getPath("out/tags.yaml"), "utf-8")).toBe(
+      multiline`
+        tag1: value1
+        tag2: value2
+      `,
+    );
+  });
 });