Linter: Warn about mixed `self` and local object name

[sparkprime]

Ok: { local mything = self, x: 1, y: mything.x, wrapped: { z: mything.x } }
Not ok: { local mything = self, x: 1, y: self.x, wrapped: { z: mything.x } }
Ok: local obj = { a: obj.sth, b:obj.sth }
Not ok: local obj = { a: obj.sth, b:self.sth }

[seh]

Can you clarify what is not acceptable about the "Not OK" variants?

[sbarzowski]

Ok: { local mything = self, x: 1, y: mything.x, wrapped: { z: mything.x } }
Not ok: { local mything = self, x: 1, y: self.x, wrapped: { z: mything.x } }

Mixed use of self and a local name for self, which are equivalent. It's a consistency issue. It helps prevent bugs where you refer to a different self from what you meant (e.g. when copying pieces of code in nested objects).

Ok: local obj = { a: obj.sth, b:obj.sth }
Not ok: local obj = { a: obj.sth, b:self.sth }

Mixed use of self and a variable which holds an object (obj in this case).
Here the meaning of obj and self is different (if you inherit from this object, obj will still refer to the same thing and self will refer to the combined object). It's a bit weird to mix the two - probably a mistake. Normally I would expect a self-referencing object to either be defined entirely in terms of fixed values (with obj) or entirely with late biding (self).

[seh]

Thank you. I understand it better now. The results are all correct, but you're trying to correct potential confusion and errors that could arise as the code evolves.

I think I've been guilty of the first "Not OK," where I use self fruitfully until I find a case in which I can't (in a nested object), but then I don't go back and unify all the previous use of self to use the newly introduced local alias instead.