JS-0368 @ fe59603 • CIDARLAB / 3DuF

Run summary

6 months ago

11da5c0..fe59603

1 min 9 s

Private members should be marked as readonly JS-0368

Anti-pattern

Major

14 occurrences in this check

Member '__originalPosition' is never reassigned; mark it as readonly

src/app/view/tools/generateArrayTool.ts

  7
  8export default class GenerateArrayTool extends MouseTool {
  9    private __currentComponent?: any;
 10    private __originalPosition?: any; 11    
 12    /**
 13     * Creates an instance of GenerateArrayTool.

Member '_paperlayer' is never reassigned; mark it as readonly

src/app/view/render2D/paperComponentPortView.ts

 8    private _viewManagerDelegate: ViewManager;
 9    private _componentAndRenderMap: Map<string, Array<any>>;
10    private _activeRenders: Array<any>;
11    private _paperlayer: paper.Group;12    private _enabled: boolean;
13
14    constructor(paperlayer: paper.Group, viewmanager: ViewManager) {

Member '_componentAndRenderMap' is never reassigned; mark it as readonly

src/app/view/render2D/paperComponentPortView.ts

 6export default class PaperComponentPortView {
 7
 8    private _viewManagerDelegate: ViewManager;
 9    private _componentAndRenderMap: Map<string, Array<any>>;10    private _activeRenders: Array<any>;
11    private _paperlayer: paper.Group;
12    private _enabled: boolean;

Member '_viewManagerDelegate' is never reassigned; mark it as readonly

src/app/view/render2D/paperComponentPortView.ts

 5
 6export default class PaperComponentPortView {
 7
 8    private _viewManagerDelegate: ViewManager; 9    private _componentAndRenderMap: Map<string, Array<any>>;
10    private _activeRenders: Array<any>;
11    private _paperlayer: paper.Group;

Member '__viewManagerDelegate' is never reassigned; mark it as readonly

src/app/view/paperView.ts

  58    selectedComponents: Array<Component>;
  59    selectedConnections: Array<Connection>;
  60    inactiveAlpha: number;
  61    private __viewManagerDelegate: any;  62    featureRegistry: Map<string, any>;
  63    lastTargetSet: string | null = null;
  64    protected _paperComponentPortView: PaperComponentPortView;

Member '__parchmintFeatures' is never reassigned; mark it as readonly

src/app/core/device.ts

  36    private __valveMap: Map<string, string>;
  37    private __valveTypeMap: Map<string, ValveType>;
  38    private __groups: Array<string>;
  39    private __parchmintFeatures: Array<GeometryElement>;  40
  41    /**
  42     * Default Constructor

Member '__groups' is never reassigned; mark it as readonly

src/app/core/device.ts

  35    private __connections: Array<Connection>;
  36    private __valveMap: Map<string, string>;
  37    private __valveTypeMap: Map<string, ValveType>;
  38    private __groups: Array<string>;  39    private __parchmintFeatures: Array<GeometryElement>;
  40
  41    /**

Member '__valveTypeMap' is never reassigned; mark it as readonly

src/app/core/device.ts

  34    private __nameMap: Map<string, number>;
  35    private __connections: Array<Connection>;
  36    private __valveMap: Map<string, string>;
  37    private __valveTypeMap: Map<string, ValveType>;  38    private __groups: Array<string>;
  39    private __parchmintFeatures: Array<GeometryElement>;
  40

Member '__valveMap' is never reassigned; mark it as readonly

src/app/core/device.ts

  33    private __components: Array<Component>;
  34    private __nameMap: Map<string, number>;
  35    private __connections: Array<Connection>;
  36    private __valveMap: Map<string, string>;  37    private __valveTypeMap: Map<string, ValveType>;
  38    private __groups: Array<string>;
  39    private __parchmintFeatures: Array<GeometryElement>;

Member '__connections' is never reassigned; mark it as readonly

src/app/core/device.ts

  32    private __name: string;
  33    private __components: Array<Component>;
  34    private __nameMap: Map<string, number>;
  35    private __connections: Array<Connection>;  36    private __valveMap: Map<string, string>;
  37    private __valveTypeMap: Map<string, ValveType>;
  38    private __groups: Array<string>;

Member '__components' is never reassigned; mark it as readonly

src/app/core/device.ts

  30    private __textLayers: Array<Layer>;
  31    private __params: Params;
  32    private __name: string;
  33    private __components: Array<Component>;  34    private __nameMap: Map<string, number>;
  35    private __connections: Array<Connection>;
  36    private __valveMap: Map<string, string>;

Member '__params' is never reassigned; mark it as readonly

src/app/core/device.ts

  28export default class Device {
  29    private __layers: Array<Layer>;
  30    private __textLayers: Array<Layer>;
  31    private __params: Params;  32    private __name: string;
  33    private __components: Array<Component>;
  34    private __nameMap: Map<string, number>;

Member '__textLayers' is never reassigned; mark it as readonly

src/app/core/device.ts

  27 */
  28export default class Device {
  29    private __layers: Array<Layer>;
  30    private __textLayers: Array<Layer>;  31    private __params: Params;
  32    private __name: string;
  33    private __components: Array<Component>;

Member '__layers' is never reassigned; mark it as readonly

src/app/core/device.ts

  26 * The Device stores information about a design.
  27 */
  28export default class Device {
  29    private __layers: Array<Layer>;  30    private __textLayers: Array<Layer>;
  31    private __params: Params;
  32    private __name: string;

Description

Private members are marked as readonly if they're never modified outside of the constructor.

Bad Practice

class Container {
  // These member variables could be marked as readonly
  private neverModifiedMember = true;
  private onlyModifiedInConstructor: number;

  public constructor(
    onlyModifiedInConstructor: number,
    // Private parameter properties can also be marked as readonly
    private neverModifiedParameter: string,
  ) {
    this.onlyModifiedInConstructor = onlyModifiedInConstructor;
  }
}

class Container {
  // Public members might be modified externally
  public publicMember: boolean;

  // Protected members might be modified by child classes
  protected protectedMember: number;

  // This is modified later on by the class
  private modifiedLater = 'unchanged';

  public mutate() {
    this.modifiedLater = 'mutated';
  }
}

CIDARLAB / 3DuF

Bad Practice

Recommended