Unable to use --extract in a workspace?

[osa1]

Does --extract support workspaces? I can't figure out how to use it in a workspace.

I'm trying it with https://github.com/google/protobuf.dart. I want to extract the API for protobuf. Using the master branch I get this: (in the repo root)

$ dart-apitool extract --input protobuf
Preparing protobuf
Copying sources from protobuf
Could not find workspace for package protobuf
Could not find workspace for package /tmp/JITPPV
Error: PathNotFoundException: Cannot open file, path = 'protobuf/.dart_tool/package_config.json' (OS Error: No such file or directory, errno = 2)

If I use . as the input I get this:

$ dart-apitool extract --input .
 Preparing .
Copying sources from .
Omitting pub get (package config already present)
Analyzing .
Cleaning up
{
    "version": 3,
    "packageApi": {
        "packageName": "workspace",
        "packageVersion": null,
        "packagePath": "/tmp/NSKLVJ",
        "interfaceDeclarations": [],
        "executableDeclarations": [],
        "fieldDeclarations": [],
        "typeAliasDeclarations": [],
        "semantics": [
            "containsPlatformConstraints"
        ],
        "iosPlatformConstraints": null,
        "androidPlatformConstraints": null,
        "sdkType": "dart",
        "minSdkVersion": "3.7.0",
        "packageDependencies": []
    },
    "missingEntryPoints": []
}

Which doesn't show the API so I'm guessing it's not doing anything?

What's the expected output of this command when it works? It might be useful to show it in the README.

I also can't figure out how to extract APIs using git://... as --input. As an example, what's the full command for generating the API of https://github.com/dart-lang/core/tree/main/pkgs/collection ? I think the syntax shown in the README with git://https://... is probably wrong as they generate "Unknown package ref".

[jakemac53]

Note that there is package:package_config which is the canonical (and Dart team supported) way of resolving package configs as well, you may want to use that package.

[devmil]

The issue is the relative path. Fixed with #238

Note that there is package:package_config which is the canonical (and Dart team supported) way of resolving package configs as well, you may want to use that package.

Nice! Thanks for that hint. This solves a couple of hairy places in dart_apitool. #239 changes dart_apitool to use that package

[osa1]

@devmil I still can't use extract in a workspace. I'm on main branch of apitool.

$ dart-apitool extract --input protobuf
Preparing protobuf
Copying sources from protobuf
Could not find workspace for package protobuf
Could not find workspace for package /tmp/OREZPY
Error: PathNotFoundException: Cannot open file, path = 'protobuf/.dart_tool/package_config.json' (OS Error: No such file or directory, errno = 2)

[devmil]

@osa1 that's weird.
I will have a look later.

[devmil]

Hey @osa1
Sorry for the late reply.
I think this issue is fixed with #239 which will be part of the next release (happening in the next few days)