@caleuche/core 0.5.1 → 0.6.0

package/README.md

@@ -18,6 +18,7 @@ The library acts as the core engine for tools like the Caleuche CLI, providing a
   - Primitives: `string`, `number`, `boolean`
   - Complex types: `object`, `array` (with typed items)
   - Required/optional fields with default values
+- **Test Sample Generation**: Automatically generate test variants with overridden input values in a `test/` subfolder
 - **Template Helper Functions**: Built-in language-specific helpers for common code generation tasks:
   - Import/using statement generation
   - Environment variable handling with runtime validation
@@ -151,6 +152,45 @@ const output = compileSample(sample, { name: "World" }, { project: false });
 // Output includes tags.yaml file with metadata
 ```
 
+### Generating Test Samples with Test Overrides
+
+Use `testOverrides` to automatically generate a test variant of your sample in a `test/` subfolder. The test sample inherits all parent input values, with specified values overridden:
+
+```ts
+const sample: Sample = {
+  template: `
+const client = new OpenAI({ endpoint: "<%= endpoint %>" });
+const response = await client.chat.completions.create({
+  model: "<%= model %>",
+  messages: [{ role: "user", content: "Hello" }],
+});
+  `,
+  type: "javascript",
+  dependencies: [{ name: "openai", version: "^4.0.0" }],
+  input: [
+    { name: "endpoint", type: "string", required: true },
+    { name: "model", type: "string", required: true },
+  ],
+  testOverrides: {
+    input: {
+      endpoint: "https://test-endpoint.openai.azure.com",
+      model: "gpt-4-test",
+    },
+  },
+};
+
+const output = compileSample(
+  sample,
+  { endpoint: "https://display-endpoint.openai.com", model: "gpt-4" },
+  { project: true },
+);
+
+// Output includes:
+// - sample.js: Uses production endpoint and model
+// - package.json: Project dependencies
+// - test/sample.js: Uses test endpoint and model (overridden values)
+```
+
 ### Template Built-ins
 
 Template helper functions are available within templates to generate language-specific boilerplate code. These functions are accessed via the language namespace (e.g., `go.includes()`, `csharp.usings()`).
@@ -296,6 +336,17 @@ interface Sample {
   dependencies: Dependency[]; // Package dependencies
   input: TemplateInput[]; // Template input definitions
   tags?: Record<string, any>; // Optional metadata tags
+  testOverrides?: TestOverrides; // Optional test sample overrides
+}
+```
+
+**`TestOverrides`**
+
+Defines input value overrides for generating a test sample in a `test/` subfolder:
+
+```ts
+interface TestOverrides {
+  input: Record<string, any>; // Input values to override in test sample
 }
 ```
 

package/dist/index.cjs.js

@@ -7607,8 +7607,9 @@ var packageJson = "{\n  \"name\": \"sample\",\n  \"version\": \"1.0.0\",\n  \"ty
 
 var pomXml = "<project xmlns=\"http://maven.apache.org/POM/4.0.0\"\n         xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n         xsi:schemaLocation=\"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd\">\n    <modelVersion>4.0.0</modelVersion>\n    <groupId>sample</groupId>\n    <artifactId>sample</artifactId>\n    <version>1.0-SNAPSHOT</version>\n    <dependencies>\n    <% _.forEach(dependencies, function(dependency) { %>\n        <dependency>\n            <groupId><%= dependency.name.split(\":\")[0] %></groupId>\n            <artifactId><%= dependency.name.split(\":\")[1] %></artifactId>\n            <version><%= dependency.version %></version>\n        </dependency>\n    <% }); %>\n    </dependencies>\n    <build>\n        <plugins>\n            <plugin>\n                <groupId>org.codehaus.mojo</groupId>\n                <artifactId>build-helper-maven-plugin</artifactId>\n                <version>3.6.0</version>\n                <executions>\n                    <execution>\n                        <id>add-source</id>\n                        <phase>generate-sources</phase>\n                        <goals>\n                            <goal>add-source</goal>\n                        </goals>\n                        <configuration>\n                            <sources>\n                                <source>.</source>\n                            </sources>\n                        </configuration>\n                    </execution>\n                </executions>\n            </plugin>\n        </plugins>\n    </build>\n</project>\n";
 
-var requirementsTxt = "<% _.forEach(dependencies, function(dependency) { %>\n<%= dependency.name %><% if (dependency.version) { %>==<%= dependency.version %>\n<% } %>\n<% }) %>";
+var requirementsTxt = "<% _.forEach(dependencies, function(dependency) { %>\n<%= dependency.name %><% if (dependency.version) { %>==<%= dependency.version %><% } %>\n\n<% }) %>";
 
+const TEST_SUBFOLDER = "test";
 function fillInputObject(sample, inputData) {
     const inputObject = {};
     for (const { name, required, default: defaultValue } of sample.input) {
@@ -7707,6 +7708,12 @@ function compileSample(sample, input, options) {
     if (options.project) {
         const projectFile = generateProjectFile(sample);
         output.items.push(projectFile);
+        if (sample.testOverrides) {
+            output.items.push({
+                fileName: `${TEST_SUBFOLDER}/${projectFile.fileName}`,
+                content: projectFile.content,
+            });
+        }
     }
     if (sample.tags) {
         const tagsFile = generateTagsFile(sample);
@@ -7729,8 +7736,26 @@ function compileSample(sample, input, options) {
         fileName: targetFileName,
         content: outputFileContent,
     });
+    if (sample.testOverrides) {
+        const testOutput = generateTestSample(sample, input, sample.testOverrides, compiledTemplate, targetFileName);
+        output.items.push(...testOutput);
+    }
     return output;
 }
+function generateTestSample(sample, parentInput, testOverrides, compiledTemplate, targetFileName) {
+    const testItems = [];
+    // Merge parent input with test overrides
+    const testInputObject = fillInputObject(sample, {
+        ...parentInput,
+        ...testOverrides.input,
+    });
+    const testOutputContent = compiledTemplate(testInputObject);
+    testItems.push({
+        fileName: `${TEST_SUBFOLDER}/${targetFileName}`,
+        content: testOutputContent,
+    });
+    return testItems;
+}
 
 exports.compileSample = compileSample;
 //# sourceMappingURL=index.cjs.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caleuche/core",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "main": "dist/index.cjs.js",
   "exports": {
     ".": {

package/project-templates/requirements.txt.template

@@ -1,4 +1,4 @@
 <% _.forEach(dependencies, function(dependency) { %>
-<%= dependency.name %><% if (dependency.version) { %>==<%= dependency.version %>
-<% } %>
+<%= dependency.name %><% if (dependency.version) { %>==<%= dependency.version %><% } %>
+
 <% }) %>