Merge pull request #1061 from Tyriar/1048_enableBold

Support enableBold option

fixtures/typings-test/typings-test.ts

@@ -140,6 +140,7 @@ namespace methods_core {
       const r18: (data: string) => void = t.getOption('handler');
       const r19: string = t.getOption('bellSound');
       const r20: string = t.getOption('bellStyle');
+      const r21: boolean = t.getOption('enableBold');
       const r22: number = t.getOption('letterSpacing');
     }
     {
@@ -153,6 +154,7 @@ namespace methods_core {
       t.setOption('cursorBlink', true);
       t.setOption('debug', true);
       t.setOption('disableStdin', true);
+      t.setOption('enableBold', true);
       t.setOption('popOnBell', true);
       t.setOption('screenKeys', true);
       t.setOption('useFlowControl', true);

src/Interfaces.ts

@@ -135,6 +135,7 @@ export interface ITerminalOptions {
   cursorStyle?: string;
   debug?: boolean;
   disableStdin?: boolean;
+  enableBold?: boolean;
   fontSize?: number;
   fontFamily?: string;
   geometry?: [number, number];

src/Terminal.ts

@@ -77,6 +77,7 @@ const DEFAULT_OPTIONS: ITerminalOptions = {
   cursorStyle: 'block',
   bellSound: BellSound,
   bellStyle: 'none',
+  enableBold: true,
   fontFamily: 'courier-new, courier, monospace',
   fontSize: 15,
   lineHeight: 1.0,
@@ -411,6 +412,7 @@ export class Terminal extends EventEmitter implements ITerminal, IInputHandlingT
         this.renderer.clear();
         this.charMeasure.measure(this.options);
         break;
+      case 'enableBold':
       case 'letterSpacing':
       case 'lineHeight':
         // When the font changes the size of the cells may change which requires a renderer clear

src/renderer/BaseRenderLayer.ts

@@ -230,14 +230,14 @@ export abstract class BaseRenderLayer implements IRenderLayer {
       colorIndex = fg + 2;
     } else {
       // If default color and bold
-      if (bold) {
+      if (bold && terminal.options.enableBold) {
         colorIndex = 1;
       }
     }
     const isAscii = code < 256;
     // A color is basic if it is one of the standard normal or bold weight
     // colors of the characters held in the char atlas. Note that this excludes
-    // the normal weight light color characters
+    // the normal weight _light_ color characters.
     const isBasicColor = (colorIndex > 1 && fg < 16) && (fg < 8 || bold);
     const isDefaultColor = fg >= 256;
     const isDefaultBackground = bg >= 256;
@@ -245,10 +245,20 @@ export abstract class BaseRenderLayer implements IRenderLayer {
       // ImageBitmap's draw about twice as fast as from a canvas
       const charAtlasCellWidth = this._scaledCharWidth + CHAR_ATLAS_CELL_SPACING;
       const charAtlasCellHeight = this._scaledCharHeight + CHAR_ATLAS_CELL_SPACING;
+
       // Apply alpha to dim the character
       if (dim) {
         this._ctx.globalAlpha = DIM_OPACITY;
       }
+
+      // Draw the non-bold version of the same color if bold is not enabled
+      if (bold && !terminal.options.enableBold) {
+        // Ignore default color as it's not touched above
+        if (colorIndex > 1) {
+          colorIndex -= 8;
+        }
+      }
+
       this._ctx.drawImage(this._charAtlas,
           code * charAtlasCellWidth,
           colorIndex * charAtlasCellHeight,
@@ -280,7 +290,7 @@ export abstract class BaseRenderLayer implements IRenderLayer {
   private _drawUncachedChar(terminal: ITerminal, char: string, width: number, fg: number, x: number, y: number, bold: boolean, dim: boolean): void {
     this._ctx.save();
     this._ctx.font = `${terminal.options.fontSize * window.devicePixelRatio}px ${terminal.options.fontFamily}`;
-    if (bold) {
+    if (bold && terminal.options.enableBold) {
       this._ctx.font = `bold ${this._ctx.font}`;
     }
     this._ctx.textBaseline = 'top';

typings/xterm.d.ts

@@ -41,6 +41,11 @@ interface ITerminalOptions {
    */
   disableStdin?: boolean;
 
+  /**
+   * Whether to enable the rendering of bold text.
+   */
+  enableBold?: boolean;
+
   /**
    * The font size used to render text.
    */
@@ -402,7 +407,7 @@ declare module 'xterm' {
      * Retrieves an option's value from the terminal.
      * @param key The option key.
      */
-    getOption(key: 'cancelEvents' | 'convertEol' | 'cursorBlink' | 'debug' | 'disableStdin' | 'popOnBell' | 'screenKeys' | 'useFlowControl' | 'visualBell'): boolean;
+    getOption(key: 'cancelEvents' | 'convertEol' | 'cursorBlink' | 'debug' | 'disableStdin' | 'enableBold' | 'popOnBell' | 'screenKeys' | 'useFlowControl' | 'visualBell'): boolean;
     /**
      * Retrieves an option's value from the terminal.
      * @param key The option key.
@@ -452,7 +457,7 @@ declare module 'xterm' {
      * @param key The option key.
      * @param value The option value.
      */
-    setOption(key: 'cancelEvents' | 'convertEol' | 'cursorBlink' | 'debug' | 'disableStdin' | 'popOnBell' | 'screenKeys' | 'useFlowControl' | 'visualBell', value: boolean): void;
+    setOption(key: 'cancelEvents' | 'convertEol' | 'cursorBlink' | 'debug' | 'disableStdin' | 'enableBold' | 'popOnBell' | 'screenKeys' | 'useFlowControl' | 'visualBell', value: boolean): void;
     /**
      * Sets an option on the terminal.
      * @param key The option key.