-
Notifications
You must be signed in to change notification settings - Fork 294
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
top module as docs #10538
top module as docs #10538
Conversation
@@ -13,12 +13,12 @@ import { | |||
Uri, | |||
ViewColumn | |||
} from 'vscode'; | |||
import { IShowDataViewerFromVariablePanel } from '../../messageTypes'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are 59 file modified but most of them are import path changes and file movement.
@@ -1,13 +1,13 @@ | |||
// Copyright (c) Microsoft Corporation. All rights reserved. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In followup PRs, I would probably move these files to where they should be. For example, sendStartupTelemetry
is only used by extension.ts
so it should not sit in platform
as it's not used by anyone else.
import { SelectJupyterUriCommandSource } from './kernels/jupyter/serverSelector'; | ||
import { TerminalShellType } from './platform/terminals/types'; | ||
|
||
export * from './platform/telemetry/index'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We would move some of the functions into this file from platform/telemetry/index
instead of re-export in following PRs.
Codecov Report
@@ Coverage Diff @@
## main #10538 +/- ##
======================================
- Coverage 71% 71% -1%
======================================
Files 465 465
Lines 27905 27905
Branches 4699 4699
======================================
- Hits 19843 19826 -17
- Misses 6188 6202 +14
- Partials 1874 1877 +3
|
Re #10152
This PR covers the discussion we had in yesterday's standup: top level files for both core utilities and living docs. It introduces:
src/commands.ts
, which includes all the typings for command names and types for return result.src/telemetry.ts
, which includes all the typings for telemetry event names and value types.src/platform/telemetry
, they are not allowed to import typings from other top components but only serve as helper utilitiesWe would use these two files as living docs and type checking for command execution and telemetry. For telemetry, we might want to move towards VS Code's tooling and break it down, and when that happens, we will only keep
src/platform/telemetry
.package-lock.json
has been regenerated by runningnpm install
(if dependencies have changed).