Skip to content

@stephansama packages / @stephansama/auto-readme / schema / configSchema

Variable: configSchema

ts
const configSchema: ZodOptional<ZodObject<{
  affectedRegexes: ZodDefault<ZodOptional<ZodArray<ZodString>>>;
  collapseHeadings: ZodDefault<ZodOptional<ZodArray<ZodString>>>;
  defaultLanguage: ZodDefault<ZodOptional<ZodEnum<{
     JS: "JS";
     RS: "RS";
  }>>>;
  disableEmojis: ZodDefault<ZodBoolean>;
  disableMarkdownHeadings: ZodDefault<ZodBoolean>;
  enableToc: ZodDefault<ZodBoolean>;
  enableUsage: ZodDefault<ZodOptional<ZodBoolean>>;
  headings: ZodDefault<ZodOptional<ZodDefault<ZodOptional<ZodRecord<ZodEnum<{
     ACTION: "ACTION";
     PKG: "PKG";
     USAGE: "USAGE";
     WORKSPACE: "WORKSPACE";
     ZOD: "ZOD";
  }>, ZodOptional<ZodArray<ZodEnum<...>>>>>>>>;
  onlyReadmes: ZodDefault<ZodBoolean>;
  onlyShowPublicPackages: ZodDefault<ZodBoolean>;
  removeScope: ZodDefault<ZodOptional<ZodString>>;
  templates: ZodDefault<ZodOptional<ZodObject<{
     downloadImage: ZodDefault<ZodOptional<ZodString>>;
     emojis: ZodDefault<ZodOptional<ZodRecord<ZodEnum<...>, ZodString>>>;
     registryUrl: ZodDefault<ZodOptional<ZodString>>;
     versionImage: ZodDefault<ZodOptional<ZodString>>;
  }, $strip>>>;
  tocHeading: ZodDefault<ZodOptional<ZodString>>;
  usageFile: ZodDefault<ZodOptional<ZodString>>;
  usageHeading: ZodDefault<ZodOptional<ZodString>>;
  verbose: ZodDefault<ZodBoolean>;
}, $strip>>;

Defined in: core/auto-readme/src/schema.js:129

Released under MIT license