Skip to content

Updating markdown description of LogFiles - #5185

Closed
FMorschel wants to merge 4 commits into
Dart-Code:masterfrom
FMorschel:master
Closed

FMorschel wants to merge 4 commits into
Dart-Code:masterfrom
FMorschel:master

Conversation

@FMorschel

Copy link
Copy Markdown
Contributor

This PR is to address the following part of a comment I made:

Also, here are all the files I'm setting:

image

Although some of the markdown hints you changed it so it would show that ${workspaceName} would work, only flutterTestLogFile does show that we can also use ${name}:

image

And the extensionLogFile shows neither.

image

Originally posted by @FMorschel in #5154 (comment)

Comment thread package.json
],
"default": null,
"markdownDescription": "The path to a log file for very detailed logging in the Dart Analysis Server that may be useful when trying to diagnose Analysis Server issues. Use `${workspaceName}` to insert the name of the current workspace in the file path.",
"markdownDescription": "The path to a log file for very detailed logging in the Dart Analysis Server that may be useful when trying to diagnose Analysis Server issues. Use `${name}` in the log file name to insert the Debug Session name to prevent concurrent debug sessions overwriting each others logs. Use `${workspaceName}` to insert the name of the current workspace in the file path.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

${name} isn't supported here, it's only supported in the loges that are debug-session specific (that is DAP, DartTest, FlutterRun, FlutterTest, WebDaemon).

I think as of the current master version, the descriptions should all be accurate.

setupLog(config.analyzerLogFile, LogCategory.Analyzer);
setupLog(config.flutterDaemonLogFile, LogCategory.FlutterDaemon);
setupLog(config.toolingDaemonLogFile, LogCategory.DartToolingDaemon);
setupLog(config.dapLogFile, LogCategory.DAP);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be reverting some changes I just pushed to master to support "dynamic" DAP log file names.

import { CategoryLogger } from "../../shared/logging";

export class DartDebugAdapterLoggerFactory implements DebugAdapterTrackerFactory {
constructor(private readonly logger: EmittingLogger) { }

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here and below, I think you've reverted this PR to before my changes so it's trying to undo them.

@FMorschel

Copy link
Copy Markdown
Contributor Author

Since I'm not sure how to fix this besides going through every file changed and fixing them by hand, I'll recreate this PR with only the changes for package.json.

@FMorschel FMorschel closed this Jul 16, 2024
@DanTup

DanTup commented Jul 16, 2024

Copy link
Copy Markdown
Member

sgtm - though it's not clear to me what still needs fixing - I thought I'd updated everything to be accurate in my last few changes (I didn't see you were also working on these until afterwards unfortunately!).

@FMorschel

FMorschel commented Jul 16, 2024 •

Copy link
Copy Markdown
Contributor Author

${name} isn't supported here, it's only supported in the loges that are debug-session specific (that is DAP, DartTest, FlutterRun, FlutterTest, WebDaemon).

I think as of the current master version, the descriptions should all be accurate.

I see what you mean then. The only thing my PR would add is more consistency between all of the descriptions and a typo fix. Will rename it then.

Here it is #5188.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants