Initial release cleanup.

This commit is contained in:
Erik C. Thauvin 2022-01-26 16:39:22 -08:00
parent 89b7769e1e
commit 334f34d84d
5 changed files with 47 additions and 13 deletions

10
.gitignore vendored
View file

@ -5,7 +5,13 @@
*.class
*.code-workspace
*.ctxt
*.dart.js
*.info.json
*.iws
*.js
*.js.deps
*.js.map
*.js_
*.log
*.nar
*.rar
@ -15,6 +21,9 @@
.DS_Store
.classpath
.dart_tool/
.env*
.flutter-plugins
.flutter-plugins-dependencies
.gradle
.history
.kobalt
@ -66,6 +75,7 @@ dependency-reduced-pom.xml
deploy/
dist/
doc/
doc/api/
ehthumbs.db
fabric.properties
gen/

18
.pubignore Normal file
View file

@ -0,0 +1,18 @@
*.dart.js
*.info.json
*.js
*.js.deps
*.js.map
*.js_
*.sh
.dart_tool/
.env*
.flutter-plugins
.flutter-plugins-dependencies
.packages
analysis_options.yaml
bin/dcat
bin/dcat.exe
build/
coverage
doc/api/

View file

@ -50,6 +50,10 @@ dart compile exe bin/dcat.dart
```
## Library Usage
```sh
dart pub add dcat
```
```dart
import 'package:dcat/dcat.dart';
@ -88,10 +92,12 @@ A `CatResult` object is returned which contains the `exitCode` (`exitSuccess` or
final result =
await cat(['path/to/file'], stdout, showLineNumbers: true);
if (result.exitCode == exitSuccess) { // or result.isSuccess
...
// ...
} else {
for (final error in result.errors) {
stderr.writeln("Error with '${error.path}': ${error.message}");
}
}
```
```
[View Full Example](https://github.com/ethauvin/dcat/blob/master/example/example.dart)

View file

@ -7,14 +7,14 @@ packages:
name: _fe_analyzer_shared
url: "https://pub.dartlang.org"
source: hosted
version: "29.0.0"
version: "34.0.0"
analyzer:
dependency: transitive
description:
name: analyzer
url: "https://pub.dartlang.org"
source: hosted
version: "2.6.0"
version: "3.2.0"
args:
dependency: "direct main"
description:
@ -70,7 +70,7 @@ packages:
name: coverage
url: "https://pub.dartlang.org"
source: hosted
version: "1.0.3"
version: "1.1.0"
crypto:
dependency: transitive
description:
@ -189,7 +189,7 @@ packages:
name: path
url: "https://pub.dartlang.org"
source: hosted
version: "1.8.0"
version: "1.8.1"
pool:
dependency: transitive
description:
@ -252,7 +252,7 @@ packages:
name: source_span
url: "https://pub.dartlang.org"
source: hosted
version: "1.8.1"
version: "1.8.2"
stack_trace:
dependency: transitive
description:
@ -287,21 +287,21 @@ packages:
name: test
url: "https://pub.dartlang.org"
source: hosted
version: "1.19.0"
version: "1.20.1"
test_api:
dependency: transitive
description:
name: test_api
url: "https://pub.dartlang.org"
source: hosted
version: "0.4.6"
version: "0.4.9"
test_core:
dependency: transitive
description:
name: test_core
url: "https://pub.dartlang.org"
source: hosted
version: "0.4.6"
version: "0.4.11"
typed_data:
dependency: transitive
description:
@ -315,7 +315,7 @@ packages:
name: vm_service
url: "https://pub.dartlang.org"
source: hosted
version: "7.3.0"
version: "8.1.0"
watcher:
dependency: transitive
description:
@ -345,4 +345,4 @@ packages:
source: hosted
version: "3.1.0"
sdks:
dart: ">=2.14.3 <3.0.0"
dart: ">=2.15.1 <3.0.0"

View file

@ -5,7 +5,7 @@ repository: https://github.com/ethauvin/dcat
issue_tracker: https://github.com/ethauvin/dcat/issues
environment:
sdk: '>=2.14.3 <3.0.0'
sdk: '>=2.15.1 <3.0.0'
dev_dependencies:
lints: ^1.0.0