microsoft / TypeScript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
https://www.typescriptlang.org
Apache License 2.0
100.4k stars 12.41k forks source link

[suggest] constructor init delegation with "strictPropertyInitialization" #59997

Open jonlepage opened 1 week ago

jonlepage commented 1 week ago

🔍 Search Terms

strictPropertyInitialization, Property has no initializer and is not definitely assigned in the constructor.

✅ Viability Checklist

⭐ Suggestion

Hello, have you ever considered adding a special hack to delegate the role of a class constructor when using strictPropertyInitialization: true in the tsconfig file?

In fact, I have an issue with an architecture that makes the constructor unnecessary until the class is injected into a facade that activates the system and creates the private dependencies of the class.

There is no other solution except to disable this rule, which is frankly not great and very limiting when a project uses several design patterns requiring a distinct approach. To take advantage of the security of strictPropertyInitialization, would it be possible to have maybe a special utility type that tells TypeScript to check this method instead of the constructor?

Here are examples that could potentially be good solutions: I personally prefer examples 2 and 3. The first example can bring more complexity


📃 Motivating Example

Suggest 1: method with special type

We add methodname( this:ThisConstructor )

class SystemA {
    public readonly instanceNeedDependancyAvaibleLater: object; // Property 'instanceNeedDependancyAvaibleLater' has no initializer and is not definitely assigned in the constructor.

    constructor() {
    }

    // ThisConstructor can be a special type flag thas tell to tsserveur with "strictPropertyInitialization" to ignore the constructor and scan asignation in this method instead
    init( this:ThisConstructor ) {
        this.instanceNeedDependancyAvaibleLater = {};
    }
}

issues:


Suggest 2: detect with illegal this in constructor. It is currently illegal to use "this" in the constructor. We could take this opportunity to tell ts to check another methods for props initialisation. I using "string" here, but is juste for give the idea.

class SystemA {
    public readonly instanceNeedDependancyAvaibleLater: object; // Property 'instanceNeedDependancyAvaibleLater' has no initializer and is not definitely assigned in the constructor.

    //  this:'methodName' can maybe tell ts to find this method and scan assignation instead use this constructor
    constructor( this:'init' ) {
    }

    init( ) {
        this.instanceNeedDependancyAvaibleLater = {};
    }
}

issues:


Suggest 3: using comment

class SystemA {
    public readonly instanceNeedDependancyAvaibleLater: object; // Property 'instanceNeedDependancyAvaibleLater' has no initializer and is not definitely assigned in the constructor.

    //  using a comment flag to scan .init method instead of constructor
    //@ts-strictPropertyInitialization {SystemA.prototype.init}
    constructor( ) {
    }

    init( ) {
        this.instanceNeedDependancyAvaibleLater = {};
    }
}

issues:


Suggest 4: tracking the flow from constructor: https://github.com/microsoft/TypeScript/issues/32194 https://github.com/microsoft/TypeScript/issues/30462

class SystemA {
    public readonly instanceNeedDependancyAvaibleLater: object; // Property 'instanceNeedDependancyAvaibleLater' has no initializer and is not definitely assigned in the constructor.

    constructor() {
        this.init();
    }

    // ThisConstructor can be a special type flag thas tell to tsserveur with "strictPropertyInitialization" to ignore the constructor and scan asignation in this method instead
    init() {
        this.instanceNeedDependancyAvaibleLater = {};
    }

issues:

💻 Use Cases

  1. What do you want to use this for? This is to address the need for an architecture that requires initialization after adding a loosely coupled facade. The idea is to maintain the security of declarations, which current solutions do not allow. This approach can also open the door to design patterns that are difficult to manage with TypeScript.

  2. What shortcomings exist with current approaches? Currently, there are various tricks that do not allow to maintain the security and philosophy of TypeScript. 1: //@ts-ignore 2: public props!:object 3: strictPropertyInitialization:false

  3. What workarounds are you using in the meantime? public props!:object

jcalz commented 1 week ago

Is this just like an opt-in version of #32194 and #30462?

jonlepage commented 1 week ago

Is this just like an opt-in version of #32194 and #30462?

thank you i add a 4er suggest. The issues dates seems to indicate a certain difficulty in adding this functionality to the current TypeScript architecture. This is a widely used design pattern, for instance in an ECS architecture.