https://github.com/mcmah309/sheller
Sheller brings ergonomic scripting to Dart by providing utilities for interacting with shells and converting output to Dart types. Allowing users to replace most or all of their scripts (e.g. bash or python) with Dart.
https://github.com/mcmah309/sheller
dart scripting shell shell-scripting
Last synced: 7 months ago
JSON representation
Sheller brings ergonomic scripting to Dart by providing utilities for interacting with shells and converting output to Dart types. Allowing users to replace most or all of their scripts (e.g. bash or python) with Dart.
- Host: GitHub
- URL: https://github.com/mcmah309/sheller
- Owner: mcmah309
- License: mit
- Created: 2023-11-12T21:43:41.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-16T13:47:46.000Z (over 1 year ago)
- Last Synced: 2025-06-25T08:03:07.717Z (7 months ago)
- Topics: dart, scripting, shell, shell-scripting
- Language: Dart
- Homepage:
- Size: 98.6 KB
- Stars: 23
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# sheller
[](https://pub.dev/packages/sheller)
[](https://pub.dev/documentation/sheller/latest/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/mcmah309/sheller/actions)
Sheller brings ergonomic scripting to Dart by providing utilities for interacting with shells and converting output to Dart types. Allowing users to replace most or all of their scripts (e.g. bash or python) with Dart. e.g.
```dart
List files = $("cd $dir && find . -maxdepth 1 -type f").lines();
```
### Table of Contents
1. [Example](#examples)
2. [Valid Conversion Types](#valid-conversion-types)
3. [Custom Conversion Types](#custom-conversion-types)
4. [Real Use Case - Protobuf Package Generation Script](#real-use-case---protobuf-package-generation-script)
### Example
With Sheller you can easily write sync or async Dart scripts that interact with the host platform on `Linux`, `MacOs`, or `Windows`.
```dart
import 'sheller/sync.dart';
// import 'sheller/async.dart'; // alternative
// Linux
void main() {
// run process and print stdout to terminal
print($("netstat")());
// run process and convert to Dart type
int number = $("echo 1")();
assert(number == 1);
// built in support for types like json
String data ='{\\"id\\":1, \\"name\\":\\"lorem ipsum\\", \\"address\\":\\"dolor set amet\\"}';
Map json = $('echo $data')();
assert(json.entries.length == 3);
// split by spaces then convert
List doubleList = $('echo 1 2 3').spaces();
assert(doubleList.length == 3);
// The class
$ shellClassInstance = $("echo 1");
int id = shellClassInstance.pid;
int exitCode = shellClassInstance.exitCode;
int convertedResult = shellClassInstance();
assert(convertedResult == 1);
// split by lines then convert
List files = $("find . -maxdepth 1 -type f").lines();
// Writing to a file
$("echo 1") > File("./temp");
// Appending to a file
$("echo 2") >> File("./temp");
}
```
### Valid Conversion Types
Built in conversions for `stdout` of successful shells to
```dart
int
double
num
BigInt
String
bool // empty is false, non-empty is true.
Map
Object
FileSystemEntity
Directory
File
Link
```
### Custom Conversion Types
Easily add your own custom conversion types to convert the output of the shell to a dart type. e.g.
```dart
class IntConverter extends Converter {
const IntConverter();
@override
int convert(String input) {
int? result = int.tryParse(input);
if (result == null) {
throw ShellConversionException(int, input);
}
return 99999;
}
}
void main() {
ShellConfig.addConverter(const IntConverter());
int number = $("echo 1")();
assert(number == 99999);
}
```
### Real Use Case - Protobuf Package Generation Script
```dart
void main() async {
const protoFilesDir = "../../proto";
const outputDir = "../generated";
const outputSrcDir = "../generated/lib/src";
if(Directory(outputDir).existsSync()){
Directory(outputDir).deleteSync(recursive: true);
}
Directory(outputSrcDir).createSync(recursive: true);
final protoFiles = Directory(protoFilesDir)
.listSync()
.whereType()
.where((file) => file.path.endsWith(".proto"))
.map((file) => file.path)
.toList();
final generateDartProtoFilesCommand = "protoc -I=$protoFilesDir --dart_out=grpc:$outputSrcDir ${protoFiles.join(' ')}";
print($(generateDartProtoFilesCommand)());
// Contains desired pubspec.yaml
const toCopyOver = "./to_copy_over";
print($("cp -r $toCopyOver/* $outputDir")());
final generateBarrelFileCommand = "cd $outputDir && dart pub run index_generator";
print($(generateBarrelFileCommand)());
print("Done.");
}
```