configuration.d.ts 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. import { DisplayProcessor } from "./display-processor";
  2. export declare enum StacktraceOption {
  3. NONE = "none",
  4. RAW = "raw",
  5. PRETTY = "pretty"
  6. }
  7. export declare class Configuration {
  8. suite?: {
  9. /**
  10. * display each suite number (hierarchical)
  11. */
  12. displayNumber?: boolean;
  13. };
  14. spec?: {
  15. /**
  16. * display error messages for each failed assertion
  17. */
  18. displayErrorMessages?: boolean;
  19. /**
  20. * display stacktrace for each failed assertion
  21. */
  22. displayStacktrace?: StacktraceOption;
  23. /**
  24. * display each successful spec
  25. */
  26. displaySuccessful?: boolean;
  27. /**
  28. * display each failed spec
  29. */
  30. displayFailed?: boolean;
  31. /**
  32. * display each pending spec
  33. */
  34. displayPending?: boolean;
  35. /**
  36. * display each spec duration
  37. */
  38. displayDuration?: boolean;
  39. };
  40. summary?: {
  41. /**
  42. * display error messages for each failed assertion
  43. */
  44. displayErrorMessages?: boolean;
  45. /**
  46. * display stacktrace for each failed assertion
  47. */
  48. displayStacktrace?: StacktraceOption;
  49. /**
  50. * display summary of all successes after execution
  51. */
  52. displaySuccessful?: boolean;
  53. /**
  54. * display summary of all failures after execution
  55. */
  56. displayFailed?: boolean;
  57. /**
  58. * display summary of all pending specs after execution
  59. */
  60. displayPending?: boolean;
  61. /**
  62. * display execution duration
  63. */
  64. displayDuration?: boolean;
  65. };
  66. /**
  67. * Colors are displayed in the console via colors package: https://github.com/Marak/colors.js.
  68. * You can see all available colors on the project page.
  69. */
  70. colors?: {
  71. /**
  72. * enable colors
  73. */
  74. enabled?: boolean;
  75. /**
  76. * color for successful spec
  77. */
  78. successful?: string;
  79. /**
  80. * color for failing spec
  81. */
  82. failed?: string;
  83. /**
  84. * color for pending spec
  85. */
  86. pending?: string;
  87. /**
  88. * color for pretty stacktrace filename
  89. */
  90. prettyStacktraceFilename?: string;
  91. /**
  92. * color for pretty stacktrace line number
  93. */
  94. prettyStacktraceLineNumber?: string;
  95. /**
  96. * color for pretty stacktrace column number
  97. */
  98. prettyStacktraceColumnNumber?: string;
  99. /**
  100. * color for pretty stacktrace error
  101. */
  102. prettyStacktraceError?: string;
  103. };
  104. prefixes?: {
  105. /**
  106. * prefix for successful spec
  107. */
  108. successful?: string;
  109. /**
  110. * prefix for failing spec
  111. */
  112. failed?: string;
  113. /**
  114. * prefix for pending spec
  115. */
  116. pending?: string;
  117. };
  118. stacktrace?: {
  119. /**
  120. * Customize stacktrace filtering
  121. */
  122. filter?(stacktrace: string): string;
  123. };
  124. /**
  125. * list of display processor to customize output
  126. * see https://github.com/bcaudan/jasmine-spec-reporter/blob/master/docs/customize-output.md
  127. */
  128. customProcessors?: (typeof DisplayProcessor)[];
  129. /**
  130. * options for custom processors
  131. */
  132. customOptions?: any;
  133. /**
  134. * Low-level printing function, defaults to console.log.
  135. * Use process.stdout.write(log + '\n'); to avoid output to
  136. * devtools console while still reporting to command line.
  137. */
  138. print?: (log: string) => void;
  139. }