Skip to content

Cannot generate docs with a local version of the snippets tool #144408

@goderbauer

Description

@goderbauer

Steps to reproduce:

  1. Checkout the snippets tool from https://github.com/flutter/assets-for-api-docs/tree/main/packages/snippets
  2. Modify https://github.com/flutter/flutter/blob/master/dev/bots/docs.sh to activate the snippets tool from the local checkout:
"$DART" pub global activate --source path <path/to/local/snippets/tool>
  1. Run dev/bots/docs.sh to generate the docs
  2. It fails with strange permission errors:
dartdoc:stderr:   error: tool execution failed: Tool "dartpad" returned non-zero exit code (1) when run as "/Users/goderbauer/dev/flutter/bin/cache/dart-sdk/bin/dart pub global run snippets --output-directory=doc/snippets --type=dartpad" from /private/tmp/dartdoc.n04eN
dartdoc:stderr: Input to dartpad was:
dartdoc:stderr: This sample shows how to override the default label [Text]
dartdoc:stderr: widget with one that forces the menu entry to appear on one line
dartdoc:stderr: by specifying [Text.maxLines] and [Text.overflow].
dartdoc:stderr:
dartdoc:stderr: ** See code in examples/api/lib/material/dropdown_menu/dropdown_menu_entry_label_widget.0.dart **
dartdoc:stderr: Stderr output was:
dartdoc:stderr: Could not make "/Users/goderbauer/.pub-cache/bin/snippets" executable (exit code 1):
dartdoc:stderr: chmod: /Users/goderbauer/.pub-cache/bin/snippets: No such file or directory
dartdoc:stderr:
dartdoc:stderr:
dartdoc:stderr:     from material.DropdownMenuEntry.labelWidget: (file:///Users/goderbauer/dev/flutter/packages/flutter/lib/src/material/dropdown_menu.dart:80:17)
dartdoc:stderr:   error: tool execution failed: Tool "snippet" returned non-zero exit code (1) when run as "/Users/goderbauer/dev/flutter/bin/cache/dart-sdk/bin/dart pub global run snippets --output-directory=doc/snippets --type=snippet" from /private/tmp/dartdoc.n04eN
dartdoc:stderr: Input to snippet was:
dartdoc:stderr:
dartdoc:stderr: This example, which would be inserted into a [CustomScrollView.slivers]
dartdoc:stderr: list, shows twenty boxes in a pretty teal grid:
dartdoc:stderr:
dartdoc:stderr: ```dart
dartdoc:stderr: SliverGrid(
dartdoc:stderr:   gridDelegate: const SliverGridDelegateWithMaxCrossAxisExtent(
dartdoc:stderr:     maxCrossAxisExtent: 200.0,
dartdoc:stderr:     mainAxisSpacing: 10.0,
dartdoc:stderr:     crossAxisSpacing: 10.0,
dartdoc:stderr:     childAspectRatio: 4.0,
dartdoc:stderr:   ),
dartdoc:stderr:   delegate: SliverChildBuilderDelegate(
dartdoc:stderr:     (BuildContext context, int index) {
dartdoc:stderr:       return Container(
dartdoc:stderr:         alignment: Alignment.center,
dartdoc:stderr:         color: Colors.teal[100 * (index % 9)],
dartdoc:stderr:         child: Text('grid item $index'),
dartdoc:stderr:       );
dartdoc:stderr:     },
dartdoc:stderr:     childCount: 20,
dartdoc:stderr:   ),
dartdoc:stderr: )
dartdoc:stderr: ```
dartdoc:stderr: Stderr output was:
dartdoc:stderr: Could not make "/Users/goderbauer/.pub-cache/bin/snippets" executable (exit code 1):
dartdoc:stderr: chmod: /Users/goderbauer/.pub-cache/bin/snippets: No such file or directory

Running the command from the error directly works without issues. The file it is complaining about not existing definitely exists.

Metadata

Metadata

Assignees

Labels

P2Important issues not at the top of the work listd: api docsIssues with https://api.flutter.dev/dependency: dartDart team may need to help usfound in release: 3.20Found to occur in 3.20frameworkflutter/packages/flutter repository. See also f: labels.has reproducible stepsThe issue has been confirmed reproducible and is ready to work onteam-frameworkOwned by Framework teamtriaged-frameworkTriaged by Framework team

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions