core: convert audit types to modules #12870
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brendankenny
commented
Aug 5, 2021
|
|
||
| /** | ||
| * @param {LH.Audit.SimpleCriticalRequestNode} tree | ||
| * @param {LH.Audit.Details.SimpleCriticalRequestNode} tree |
There was a problem hiding this comment.
going through all of our d.ts files, this was the only type change that needed to happen in a JS file. SimpleCriticalRequestNode really is an audit details type, it just predates the file audit-details.d.ts. Moving it to audit-details avoids a circular dependency of audit-details.d.ts back to SimpleCriticalRequestNode in audit.d.ts.
| @@ -5,7 +5,7 @@ | |||
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. | |||
| */ | |||
|
|
|||
| import Audit = require('../lighthouse-core/audits/audit.js'); | |||
| import AuditClass = require('../lighthouse-core/audits/audit.js'); | |||
There was a problem hiding this comment.
this is what I was talking about in #12860, where some changes lead to Audit in this file to refer to the global LH.Audit namespace, not this very explicit local import to a (type) variable named Audit.
This can be reverted when config.d.ts moves off global declarations
connorjclark
approved these changes
Aug 6, 2021
This was referenced Aug 7, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To give an idea of what #12860 would look like, this moves
audit.d.tsandaudit-details.d.tsto exports instead of directly writing toglobal.LH.*types, then starts a centralized place to do the global declaration to maintain current type behavior.Much easier to review with
?w=1since there's an indentation change. Also divided into two commits if you want to see the changes to the two files (and associated references) separately.