Adapt paths for different development environments

[maple135790]

related: #335

---

• I’ve reviewed the contributor guide and applied the relevant portions to this PR.

Contribution guidelines:

• See our contributor guide for general expectations for PRs.
• Larger or significant changes should be discussed in an issue before creating a PR.
• Contributions to our repos should follow the Dart style guide and use dart format.
• Most changes should add an entry to the changelog and may need to rev the pubspec package version.
• Changes to packages require corresponding tests.

Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.

[srujzs]

I think Directory.current.uri.toFilePath() makes more sense here than us manually modifying the path.

[maple135790]

Oh, I missed that. Thank you for the mention.

Since the issue trying to fix here is to force yaml using POSIX-like path (here is the lint), so the upcomming fix will use Directory.current.uri.toFilePath(windows: false).

[maple135790]

I think this fix will encounter another problem.

For example, web path in Windows is C:\a\b, the lint suggests the fix is to simply change \ to /.
The correct path is C:/a/b.
This results C:/a/b is not Windows path nor POSIX path, so it cannot be fixed by using uri.toFilePath(windows: false) since the output will be something like /C:/a/b/

Perhaps there's an approach to avoid manually modifying the path that I'm unaware of ?

[srujzs]

I see, it looks like it's not correctly interpreting the C: as the authority. We've tried different APIs to see what the right way of emitting a POSIX path from a Windows path is, but everything else also seems janky (maybe adding a directory:/// or something similar may help, but that doesn't look like it's sufficient anyways), so I'm okay keeping the p.current.replaceAll(r'\', '/') change you initially had. I'd just add a comment mentioning why we do it like:

// Convert the current path to a POSIX path to avoid 'path_not_posix' lint.

Thanks for investigating!

[maple135790]

As a minor detail, I think the beat looking comment position is above the writeFile() because we have full control of the yaml file.

      // set up project
      // COMMENT_HERE
      writeFile(tempDir, 'pubspec.yaml', '''
...
 ''');

There are another two options

1. commenting inside the yaml.
2. commenting out of multiline string.

Since none of them look concise enough comparing to the above, so I choose to the above over the others.

1. inside yaml:

      writeFile(tempDir, 'pubspec.yaml', '''
name: test_project
environment:
  sdk: '^$sdkVersion'
dependencies:
  web:
    # COMMENT_HERE
    path: ${p.current.replaceAll(r'\', '/')}
  ''');

2. out of multiline string:

      writeFile(tempDir, 'pubspec.yaml', '''
name: test_project
environment:
  sdk: '^$sdkVersion'
dependencies:
  web:
  '''
    // COMMENT_HERE
    'path: ${p.current.replaceAll(r'\', '/')}');

[srujzs]

I agree that it makes sense to keep it outside of the yaml as an implementation detail and place it above writeFile.

[srujzs]

I see, it looks like it's not correctly interpreting the C: as the authority. We've tried different APIs to see what the right way of emitting a POSIX path from a Windows path is, but everything else also seems janky (maybe adding a directory:/// or something similar may help, but that doesn't look like it's sufficient anyways), so I'm okay keeping the p.current.replaceAll(r'\', '/') change you initially had. I'd just add a comment mentioning why we do it like:

// Convert the current path to a POSIX path to avoid 'path_not_posix' lint.

Thanks for investigating!