1976049 - Add Types and documentation for Setting and Preference config-work

Status: RESOLVED FIXED

(Firefox :: Settings UI, task)

Description

[Mark Kennedy [:mark]]

Get type information and IDE intellisense hooked up for the following:

1. Preferences class in toolkit/content/preferencesBindings.js that is being used in browser/components/preferences/main.js
2. The Preference class in toolkit/content/preferencesBindings.js
3. The Setting class in toolkit/content/preferencesBindings.js
4. SettingGroup class in browser/components/preferences/widgets/setting-group/setting-group.mjs
5. SettingControl class in browser/components/preferences/widgets/setting-control/setting-control.mjs

The goal is not to use TypeScript to build or emit the types, since these files are being used in a non-TypeScript, JavaScript-based project. Acceptance Criteria:

1. Can use Intellisense in any IDE (including VSCode) that supports TypeScript (e.g. hovering over methods of the classes to see their documentation, providing type-hints, autocompletion, etc)
2. Can use tsc or mach ts check to run checks on the above files and output errors (we don't necessarily need all errors to pass because there will be a lot, just need for the files to be at least evaluated)

Comment 1

[Mark Kennedy [:mark]]

Attachment: Bug 1976049 - Type and document Settings and Preferences classes r=#recomp-reviewers

• Make Typescript work in VSCode via references, which also addresses performance issues (e.g. slowness of tsserver upon VSCode startup)

• Include preferenceBindings types in mjs and js files in toolkit and browser directories

• Move Setting and Preference classes out of Preferences IIFE so they can be referenced in setting-control.mjs and setting-group.mjs files.

• Ran mach ts paths to generate missing preferencesBindings.js path resolution

• Enable strict config (mainly to get `strictNullChecks`` to type check possible undefined/null values)

• Add Lit types in bundle-lit.sh that will get auto-generated with mach vendor command

• Add "lit" that aliases to lit types in toolkit/content/widgets/vendor/lit.all.d.ts to avoid the super long path resolution

Comment 2

[BugBot [:suhaib / :marco]]

The following patch is waiting for review from an inactive reviewer:

ID	Title	Author	Reviewer Status
D254993	Bug 1976049 - Get Settings and Preferences types working r=#recomp-reviewers	mkennedy	mstriemer: Back Jul 21, 2025

:mkennedy, could you please find another reviewer?

For more information, please visit BugBot documentation.

Comment 3

[Mark Kennedy [:mark]]

I don't believe we need to land this before :mstriemer (original reviewer) gets back in. So I'll leave keep that person as a reviewer. In the meantime, recomp-reviewers (everyone else on my team) is also marked as a reviewer. So we should be good there.

Comment 4

[Mark Kennedy [:mark]]

Attachment: Bug 1976049 - Use Typescript Project references approach for performance improvements in IDEs r=Standard8,zombie,#recomp-reviewers

Comment 5

[Mark Kennedy [:mark]]

Attachment: Bug 1976049 - Add and use Lit Types r=#recomp-reviewers

• Add Lit types in bundle-lit.sh that will get auto-generated with mach vendor command

• Add "lit" that aliases to lit types in toolkit/content/widgets/vendor/lit.all.d.ts to avoid the super long path resolution

Comment 6

[Phabricator Automation]

Comment on attachment 9504973 [details]
Bug 1976049 - Add and use Lit Types r=#recomp-reviewers

Revision D259851 was moved to bug 1989309. Setting attachment 9504973 [details] to obsolete.

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/5ad6c23e1367
https://hg.mozilla.org/integration/autoland/rev/18f09d79e9b3
Type and document Settings and Preferences classes r=Standard8,mstriemer,frontend-codestyle-reviewers

Comment 8

[agoloman]

https://hg.mozilla.org/mozilla-central/rev/18f09d79e9b3