better document the config options

2021-02-01 11:45:38 -05:00
parent c3609ebb44
commit 2bf3ad4ce5
1 changed files with 12 additions and 3 deletions
@@ -19,11 +19,17 @@ export interface Config {
  scaffolder?: {
    github?: {
      [key: string]: string;
-      visiblity?: string;
+      /**
+       * The visibility to set on created repositories.
+       */
+      visiblity?: 'public' | 'internal' | 'private';
    };
    gitlab?: {
      api: { [key: string]: string };
-      visiblity?: string;
+      /**
+       * The visibility to set on created repositories.
+       */
+      visiblity?: 'public' | 'internal' | 'private';
    };
    azure?: {
      baseUrl: string;
@@ -31,7 +37,10 @@ export interface Config {
    };
    bitbucket?: {
      api: { [key: string]: string };
-      visiblity?: string;
+      /**
+       * The visibility to set on created repositories.
+       */
+      visiblity?: 'public' | 'private';
    };
  };
 }