René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"RFC: Support __proto__ literal in object initializers","articleBody":"This is a new issue to specifically propose and elaborate on a feature I raised [in this comment](https://github.com/microsoft/TypeScript/issues/30587#issuecomment-614855795) on #30587.\r\n\r\n## Search Terms\r\n\r\n- \\_\\_proto__\r\n- prototype\r\n- object literal\r\n- object spread\r\n- object initializer\r\n\r\n## Suggestion\r\nWhile accessing or mutating an _existing_ object via the `Object.protptype.__proto__` getter/setter is deprecated, to the best of my knowledge defining the prototype of a _new_ object via the object initializer `__proto__` literal is very much encouraged.\r\n\r\nThe rules for specifying the prototype of a new object via these semantics are very well-specified and safe. [See the relevant section of the spec here.](https://www.ecma-international.org/ecma-262/6.0/index.html#sec-__proto__-property-names-in-object-initializers)\r\n\r\n\r\n### Basic support\r\nGiven the following:\r\n```ts\r\nconst foo = {\r\n  __proto__: { a: \"a\" },\r\n  b: \"b\"\r\n};\r\n```\r\n\r\nTypescript currently thinks that `foo` is the following shape:\r\n```ts\r\ntype foo = {\r\n  [\"__proto__\"]: { a: string };\r\n  b: string;\r\n};\r\n```\r\n\r\nwhen in reality, it is:\r\n```ts\r\ntype foo = {\r\n  a: string;\r\n  b: string;\r\n};\r\n```\r\n\r\nTypeScript should be able to correctly detect the type of this object initialization.\r\n\r\n### Strict validity checks\r\nAdditionally, TypeScript should prevent invalid `__proto__` assignments that are \"ignored\" by the spec, and require all values to be `null` or an object. This should fail validation:\r\n\r\n```ts\r\nconst invalid = { __proto__: \"hello\" }\r\n```\r\n\r\n### Correct handling of computed properties\r\n\r\nIt's important to note that per the spec, `__proto__` literals are _not_ the same as regular property assignments.\r\n\r\nThis object initialization, for example:\r\n\r\n```ts\r\nconst foo = {\r\n  __proto__: { a: \"a\" },\r\n  b: \"b\",\r\n  [\"__proto__\"]: { c: \"c\"},\r\n};\r\n```\r\ncreates an object of the following shape:\r\n```ts\r\ntype foo = {\r\n  a: string;\r\n  b: string;\r\n  [\"__proto__\"]: { c: string};\r\n};\r\n```\r\n\r\nGiven this, I would recommend that a `__proto__` literal be forbidden in _type/interface definitions_, such that this is considered a syntax error:\r\n```ts\r\ntype foo = {\r\n  __proto__: { a: string }\r\n}\r\n```\r\nwhile this is an allowable way to specify a **property** named `__proto__` on the type `foo`.\r\n```ts\r\ntype foo = {\r\n  [\"__proto__\"]: string\r\n}\r\n```\r\n\r\n## Use-Cases \u0026 Examples\r\n\r\nThis feature allows TypeScript to correctly understand the shape of objects defined with standard JS semantics. While this pattern isn't especially prevalent, it is an important feature of the language, and should be much more common in one particular use-case where TypeScript currently has a rather severe blind spot:\r\n\r\nTypeScript currently _PREVENTS_ the creation of safe indexed objects derived from existing indexed objects. For example:\r\n\r\nGiven this object, and the goal of \"spreading\" it into a new map:\r\n```ts\r\n// All safe map objects MUST have a `null` prototype.\r\nconst someMapObject: { [key: string]: boolean } = Object.create(null);\r\n```\r\n\r\nThe following is UNSAFE, and probably the most common approach I see people using. TypeScript _should_ catch this, and _should_ issue a compile-time error. See bug #37963. \r\n\r\n```ts\r\nconst unsafeSpreadMapObject: { [key: string]: boolean | undefined } = {\r\n  ...someMapObject,\r\n  foo: false\r\n};\r\n\r\nconsole.log(typeof unsafeSpreadMapObject[\"constructor\"]);\r\n// =\u003e function\r\n\r\nconsole.log(typeof safeSpreadMapObject[\"foo\"]);\r\n// =\u003e boolean\r\n```\r\n\r\nThe following is also UNSAFE. While using `Object.assign` and `Object.create` is a perfectly valid alternative, the `any` returned by `Object.create` propagates through the statement and breaks type safety. (Perhaps the result of `Object.create` should be `unknown` instead of `any`?)\r\n\r\n```ts\r\nconst unsafeAssignMapObject: { [key: string]: boolean | undefined  } = Object.assign(\r\n  Object.create(null),\r\n  { foo: \"this is not boolean\" }\r\n);\r\n\r\nconsole.log(typeof safeSpreadMapObject[\"constructor\"]);\r\n// =\u003e undefined\r\n\r\nconsole.log(typeof safeSpreadMapObject[\"foo\"]);\r\n// =\u003e string\r\n```\r\n\r\nThis is the SAFE way to accomplish this while using object spreads, but TypeScript currently forbids it, since it lacks support for the `__proto__` literal, and incorrectly believes a _property_ of type `null` is being defined:\r\n```ts\r\nconst safeSpreadMapObject: { [key: string]: boolean | undefined } = {\r\n  __proto__: null,\r\n  ...someMapObject,\r\n  foo: false\r\n};\r\n\r\nconsole.log(typeof safeSpreadMapObject[\"constructor\"]);\r\n// =\u003e undefined\r\n\r\nconsole.log(typeof safeSpreadMapObject[\"foo\"]);\r\n// =\u003e boolean\r\n```\r\n\r\n\r\n## Checklist\r\n\r\nMy suggestion meets these guidelines:\r\n\r\n* [x] This wouldn't be a breaking change in existing TypeScript/JavaScript code\r\n* [x] This wouldn't change the runtime behavior of existing JavaScript code\r\n* [x] This could be implemented without emitting different JS based on the types of the expressions\r\n* [x] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)\r\n* [x] This feature would agree with the rest of [TypeScript's Design Goals](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals).\r\n\r\n\r\n## References\r\n- [Object initialization: Prototype mutation (MDN)](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Object_initializer#Prototype_mutation)\r\n- [\\_\\_proto__ Property Names in Object Initializers (ECMAScript Spec)](https://tc39.es/ecma262/#sec-__proto__-property-names-in-object-initializers)","author":{"url":"https://github.com/mike-marcacci","@type":"Person","name":"mike-marcacci"},"datePublished":"2020-05-07T04:43:16.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":17},"url":"https://github.com/38385/TypeScript/issues/38385"}