rguidepost 0.1.1 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +1 -2
- data/Gemfile.lock +2 -2
- data/README.md +42 -6
- data/lib/rguidepost/version.rb +1 -1
- data/rguidepost.gemspec +2 -0
- metadata +16 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 58fa140c13e18c7f354ff42a214cd98d98989812f359f8a5c79077ff73bac6f4
|
4
|
+
data.tar.gz: '093e32e327831871d9524325500f4bf2ae8b69219d069261bc24c2f434836d77'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 27d03926e59f28efa4ac2fce4a8cf6e805d8f3f9dd6ce322039407d3ab72d09ba5b28ebaab1d671c2418a102c4e8fe5ec87daea395277fe1b8fda6984c853af5
|
7
|
+
data.tar.gz: 22903df21dd357eef7d706df8c86a792fb4f306cc95f3246123123fe982cc133e6a7f653f4b3e27fbc45d10cda1ef3557a58bb9acc31cb312dea818c42c4ea1b
|
data/Gemfile
CHANGED
data/Gemfile.lock
CHANGED
@@ -1,7 +1,8 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
rguidepost (0.
|
4
|
+
rguidepost (0.2.0)
|
5
|
+
tty-prompt (= 0.21.0)
|
5
6
|
|
6
7
|
GEM
|
7
8
|
remote: https://rubygems.org/
|
@@ -46,7 +47,6 @@ DEPENDENCIES
|
|
46
47
|
rake (~> 12.0)
|
47
48
|
rguidepost!
|
48
49
|
rspec (~> 3.0)
|
49
|
-
tty-prompt
|
50
50
|
|
51
51
|
BUNDLED WITH
|
52
52
|
2.1.4
|
data/README.md
CHANGED
@@ -1,8 +1,10 @@
|
|
1
1
|
# Rguidepost
|
2
2
|
|
3
|
-
|
3
|
+
Guidepost that indicates useful commands to developers of a repository.
|
4
|
+
|
5
|
+
Rguidepost helps executing commands specific to a repository, like package.json's 'scripts' in a node repository.
|
6
|
+
You can use a YAML file (rguidepost.yml) to define commands instead of package.json in a Ruby repository.
|
4
7
|
|
5
|
-
TODO: Delete this and the text above, and describe your gem
|
6
8
|
|
7
9
|
## Installation
|
8
10
|
|
@@ -22,17 +24,51 @@ Or install it yourself as:
|
|
22
24
|
|
23
25
|
## Usage
|
24
26
|
|
25
|
-
|
27
|
+
Create rguidepost.yml like below.
|
28
|
+
|
29
|
+
```rguidepost.yml
|
30
|
+
commands:
|
31
|
+
"list all files": ls -lah
|
32
|
+
"cat rguidepost config file":
|
33
|
+
pre_command: list all files
|
34
|
+
ignore_pre: true (default: false)
|
35
|
+
command: cat rguidepost.yml
|
36
|
+
post_command: echo done message
|
37
|
+
ensure_post: true (default: false)
|
38
|
+
"echo done message": echo 'done!!'
|
39
|
+
```
|
40
|
+
|
41
|
+
Commands can be set under 'commands' key like above.
|
42
|
+
Keys (command names) under 'commands' should be unique.
|
43
|
+
|
44
|
+
rguidepost will abort executing next command if prior command failed (fail means status is not 0), but will execute next command regardless of pre_command status if ignore_pre/ensure_post is true.
|
45
|
+
|
46
|
+
Then,
|
47
|
+
|
48
|
+
```
|
49
|
+
$ rguidepost
|
50
|
+
```
|
26
51
|
|
27
52
|
## Development
|
28
53
|
|
29
|
-
|
54
|
+
### Test
|
55
|
+
|
56
|
+
Unfortunately, test is nothing yet.
|
30
57
|
|
31
|
-
|
58
|
+
### Docker
|
59
|
+
|
60
|
+
```
|
61
|
+
$ docker-compose build
|
62
|
+
$ docker-compose run ruby
|
63
|
+
$ cat .bundle/config
|
64
|
+
---
|
65
|
+
BUNDLE_PATH: "vendor/bundle"
|
66
|
+
$ bundle install
|
67
|
+
```
|
32
68
|
|
33
69
|
## Contributing
|
34
70
|
|
35
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/
|
71
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/ryokkkke/rguidepost. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rguidepost/blob/master/CODE_OF_CONDUCT.md).
|
36
72
|
|
37
73
|
|
38
74
|
## License
|
data/lib/rguidepost/version.rb
CHANGED
data/rguidepost.gemspec
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rguidepost
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.2.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- ryokkkke
|
@@ -9,7 +9,21 @@ autorequire:
|
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
11
|
date: 2020-05-08 00:00:00.000000000 Z
|
12
|
-
dependencies:
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: tty-prompt
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - '='
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 0.21.0
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - '='
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 0.21.0
|
13
27
|
description:
|
14
28
|
email:
|
15
29
|
- rrrtechrrr@gmail.com
|