scratch_space 0.0.4+1

  • Readme
  • Changelog
  • Installing
  • 92

Build Status Pub Package

A ScratchSpace is a thin wrapper around a temporary directory. The constructor takes zero arguments, so making one is as simple as doing new ScratchSpace().

In general, you should wrap a ScratchSpace in a Resource, so that you can re-use the scratch space across build steps in an individual build. This is safe to do since you are not allowed to overwrite files within a build.

This should look something like the following:

final myScratchSpaceResource =
    new Resource(() => new ScratchSpace(), dispose: (old) => old.delete());

And then you can get access to it through the BuildStep#fetchResource api:

class MyBuilder extends Builder {
  Future build(BuildStep buildStep) async {
    var scratchSpace = await buildStep.fetchResource(myScratchSpaceResource);
  }
}

Adding assets to a ScratchSpace

To add assets to the ScratchSpace, you use the ensureAssets method, which takes an Iterable<AssetId> and an AssetReader (for which you should generally pass your BuildStep which implements that interface).

You must always call this method with all assets that your external executable might need in order to set up the proper dependencies and ensure hermetic builds.

Note: It is important to note that the ScratchSpace does not guarantee that the version of a file within it is the most updated version, only that some version of it exists. For this reason you should create a new ScratchSpace for each build using the Resource class as recommended above.

Deleting a ScratchSpace

When you are done with a ScratchSpace you should call delete on it to make sure it gets cleaned up, otherwise you can end up filling up the users tmp directory.

Note: You cannot delete individual assets from a ScratchSpace today, you can only delete the entire thing. If you have a use case for deleting individual files you can file an issue.

Getting the actual File objects for a ScratchSpace

When invoking an external binary, you probably need to tell it where to look for files. There are a few fields/methods to help you do this:

  • String get packagesDir: The packages directory in the ScratchSpace.
  • String get tmpDir: The root temp directory for the ScratchSpace.
  • File fileFor(AssetId id): The File object for id.

Copying back outputs from the temp directory #

After running your executable, you most likely have some outputs that you need to notify the build system about. To do this you can use the copyOutput method, which takes an AssetId and AssetWriter (for which you should generally pass your BuildStep which implements that interface).

This will copy the asset referenced by the AssetId from the temp directory back to your actual output directory.

Feature requests and bugs #

Please file feature requests and bugs at the issue tracker.

0.0.4+1 #

  • Fix ScratchSpace.fileFor on windows to normalize the paths so they dont contain mixed separators.

0.0.4 #

  • Add requireContent argument to copyOutput to allow asserting that a file produced in a scratch space is not empty.

0.0.3+2 #

  • Declare support for package:build version 1.x.x.

0.0.3+1 #

  • Increased the upper bound for the sdk to <3.0.0.

0.0.3 #

  • Use digests to improve ensureAssets performance.
    • Scratch spaces can now be used across builds without cleaning them up, and will check digests and update assets as needed.

0.0.2+1 #

  • Fix a bug where failing to read an asset in serve mode could get the build stuck.

0.0.2 #

  • Allow creating files at the root of the scratch space.

0.0.1+3 #

  • Allow package:build 0.12.0

0.0.1+2 #

  • Allow package:build 0.11.0

0.0.1+1 #

  • Fix a deadlock issue around the file descriptor pool, only take control of a resource right before actually touching disk instead of also encapsulating the readAsBytes call from the wrapped AssetReader.

0.0.1 #

  • Initial release, adds the ScratchSpace class.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  scratch_space: ^0.0.4+1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:scratch_space/scratch_space.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
92
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
92
Learn more about scoring.

We analyzed this package on Oct 16, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.1
  • pana: 0.12.21

Platforms

Detected platforms: Flutter, other

Primary library: package:scratch_space/scratch_space.dart with components: io, build.

Maintenance suggestions

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and scratch_space.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.3.0 <3.0.0
build >=0.10.0 <2.0.0 1.2.0
crypto >=2.0.3 <3.0.0 2.1.3
path ^1.1.0 1.6.4
pedantic ^1.0.0 1.8.0+1
pool ^1.0.0 1.4.0
Transitive dependencies
analyzer 0.38.5
args 1.5.2
async 2.4.0
charcode 1.1.2
collection 1.14.12
convert 2.1.1
csslib 0.16.1
front_end 0.1.27
glob 1.2.0
html 0.14.0+3
js 0.6.1+1
kernel 0.3.27
logging 0.11.3+2
meta 1.1.7
node_interop 1.0.3
node_io 1.0.1+2
package_config 1.1.0
pub_semver 1.4.2
source_span 1.5.5
stack_trace 1.9.3
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
watcher 0.9.7+12
yaml 2.2.0
Dev dependencies
build_runner ^1.0.0
build_test ^0.10.0
build_vm_compilers >=0.1.0 <2.0.0
test ^1.0.0