renames makeImmutable to immutable

Author: Jens Karlsson

.changeset/real-wombats-dream.md

@@ -2,4 +2,4 @@
 "swagger-typescript-api": minor
 ---
 
-Supports immutable types with --make-immutable or makeImmutable
+Supports immutable types with --immutable flag or immutable option

index.ts

@@ -86,10 +86,10 @@ const generateCommand = defineCommand({
       description: "generate readonly properties",
       default: codeGenBaseConfig.addReadonly,
     },
-    "make-immutable": {
+    immutable: {
       type: "boolean",
       description: "makes all properties and values readonly",
-      default: codeGenBaseConfig.makeImmutable,
+      default: codeGenBaseConfig.immutable,
     },
     "another-array-type": {
       type: "boolean",
@@ -321,7 +321,7 @@ const generateCommand = defineCommand({
           ? HTTP_CLIENT.AXIOS
           : HTTP_CLIENT.FETCH,
       input: path.resolve(process.cwd(), args.path as string),
-      makeImmutable: args["make-immutable"],
+      immutable: args["immutable"],
       modular: args.modular,
       moduleNameFirstTag: args["module-name-first-tag"],
       moduleNameIndex: +args["module-name-index"] || 0,

src/configuration.ts

@@ -58,7 +58,7 @@ export class CodeGenConfig {
   /** CLI flag */
   addReadonly = false;
   /** CLI flag */
-  makeImmutable = false;
+  immutable = false;
   enumNamesAsValues = false;
   /** parsed swagger schema from getSwaggerObject() */
 

src/schema-parser/base-schema-parsers/array.ts

@@ -7,7 +7,7 @@ export class ArraySchemaParser extends MonoSchemaParser {
     const { type, description, items, readOnly } = this.schema || {};
 
     const readonly =
-      (readOnly && this.config.addReadonly) || this.config.makeImmutable;
+      (readOnly && this.config.addReadonly) || this.config.immutable;
 
     if (Array.isArray(items) && type === SCHEMA_TYPES.ARRAY) {
       const tupleContent = [];

src/schema-parser/base-schema-parsers/discriminator.ts

@@ -85,8 +85,7 @@ export class DiscriminatorSchemaParser extends MonoSchemaParser {
         ts.ObjectWrapper(
           ts.TypeField({
             readonly:
-              (readOnly && this.config.addReadonly) ||
-              this.config.makeImmutable,
+              (readOnly && this.config.addReadonly) || this.config.immutable,
             key: ts.StringValue(discriminator.propertyName),
             value: "Key",
           }),
@@ -132,7 +131,7 @@ export class DiscriminatorSchemaParser extends MonoSchemaParser {
             ts.TypeField({
               readonly:
                 (mappingSchema.readOnly && this.config.addReadonly) ||
-                this.config.makeImmutable,
+                this.config.immutable,
               key: discriminator.propertyName,
               value: mappingUsageKey,
             }),

src/schema-parser/base-schema-parsers/object.ts

@@ -74,7 +74,7 @@ export class ObjectSchemaParser extends MonoSchemaParser {
         value: fieldValue,
         field: this.config.Ts.TypeField({
           readonly:
-            (readOnly && this.config.addReadonly) || this.config.makeImmutable,
+            (readOnly && this.config.addReadonly) || this.config.immutable,
           optional: !required,
           key: fieldName,
           value: fieldValue,
@@ -105,7 +105,7 @@ export class ObjectSchemaParser extends MonoSchemaParser {
         field: this.config.Ts.InterfaceDynamicField({
           readonly:
             (additionalProperties.readOnly && this.config.addReadonly) ||
-            this.config.makeImmutable,
+            this.config.immutable,
           key: interfaceKeysContent,
           value: this.config.Ts.Keyword.Any,
         }),

src/schema-parser/base-schema-parsers/primitive.ts

@@ -8,7 +8,7 @@ export class PrimitiveSchemaParser extends MonoSchemaParser {
       this.schema || {};
 
     const readonly =
-      (readOnly && this.config.addReadonly) || this.config.makeImmutable;
+      (readOnly && this.config.addReadonly) || this.config.immutable;
 
     if (type === this.config.Ts.Keyword.Object && additionalProperties) {
       const propertyNamesSchema = this.schemaUtils.getSchemaPropertyNamesSchema(

src/schema-parser/schema-formatters.ts

@@ -85,7 +85,7 @@ export class SchemaFormatters {
             : this.config.Ts.RecordType({
                 readonly:
                   (parsedSchema.readOnly && this.config.addReadonly) ||
-                  this.config.makeImmutable,
+                  this.config.immutable,
                 key: this.config.Ts.Keyword.String,
                 value: this.config.Ts.Keyword.Any,
               }),

tests/spec/readonly-always/basic.test.ts

@@ -21,7 +21,7 @@ describe("basic", async () => {
       input: path.resolve(import.meta.dirname, "schema.json"),
       output: tmpdir,
       silent: true,
-      makeImmutable: true,
+      immutable: true,
       generateClient: false,
     });
 
@@ -37,7 +37,7 @@ describe("basic", async () => {
       input: path.resolve(import.meta.dirname, "schema.json"),
       output: tmpdir,
       silent: true,
-      makeImmutable: true,
+      immutable: true,
       generateClient: false,
       anotherArrayType: true,
     });

types/index.ts

@@ -557,7 +557,7 @@ export interface GenerateApiConfiguration {
     /** customise code generation constructs */
     codeGenConstructs?: (struct: CodeGenConstruct) => Partial<CodeGenConstruct>;
     /** extract response body type to data contract */
-    makeImmutable: boolean;
+    immutable: boolean;
     extractResponseBody: boolean;
     /** extract response error type to data contract */
     extractResponseError: boolean;