appear 1.0.1 → 1.0.2
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/CHANGELOG.md +14 -0
- data/README.md +22 -2
- data/lib/appear/constants.rb +1 -1
- data/scripts/console +14 -7
- metadata +2 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9ae9214254735da9c4c3f4486584662287db0f2c
|
|
4
|
+
data.tar.gz: f7feb18dc44164b7b0ad0d9c53b5cbfe8099db47
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d9b7030ffe62dd6e71fb737bfb4f442b54007742217d499356bd1d9468c4ef0db91d4c85a52c624ed0e4cfbbf1cf388eff2a16659966187dde47c787595ad2ca
|
|
7
|
+
data.tar.gz: ee6c7147c70d61f142f01c0621f2249db5498c5d33b9d274ada31fc8ae962fa48f9f8e40dad3c3b38e7b54641c429c6aacb11cc152c5ab0a2c59f3be2c7df898
|
data/CHANGELOG.md
ADDED
data/README.md
CHANGED
|
@@ -2,9 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
Appear your terminal programs in your gui!
|
|
4
4
|
|
|
5
|
-
[](http://travis-ci.org/airbnb/appear)
|
|
5
|
+
[](https://github.com/airbnb/appear) [](http://travis-ci.org/airbnb/appear) [](https://badge.fury.io/rb/appear)
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Docs: [current gem](http://www.rubydoc.info/gems/appear), [github master](http://www.rubydoc.info/github/airbnb/appear/master), your branch: `bundle exec rake doc`
|
|
8
|
+
|
|
9
|
+
[](https://github.com/airbnb/appear/raw/master/screenshot.gif)
|
|
10
|
+
<!-- the above screenshot is purposefully broken for YARD docs: it's annoying
|
|
11
|
+
there, but nice on github :) -->
|
|
8
12
|
|
|
9
13
|
Appear is a tool for revealing a given process in your terminal. Given a
|
|
10
14
|
process ID, `appear` finds the terminal emulator view (be it a window, tab, or
|
|
@@ -99,3 +103,19 @@ config.log_file = '/tmp/my-app-appear.log'
|
|
|
99
103
|
|
|
100
104
|
Appear.appear(pid, config)
|
|
101
105
|
```
|
|
106
|
+
|
|
107
|
+
## contributing
|
|
108
|
+
|
|
109
|
+
First, get yourself set up:
|
|
110
|
+
|
|
111
|
+
1. make sure you have bundler. `gem install bundler`
|
|
112
|
+
2. inside a git clone of the project, run `./scripts/setup` or `bundle install`
|
|
113
|
+
|
|
114
|
+
Then, submit PRs from feature branches for review:
|
|
115
|
+
|
|
116
|
+
1. `git checkout -b my-name--my-branch-topic`
|
|
117
|
+
1. write code
|
|
118
|
+
1. run `./scripts/console` for a nice pry session with an instance ready to go
|
|
119
|
+
1. run `bundle exec rake` to run tests and doc coverage
|
|
120
|
+
1. commit and push your changes, however you do
|
|
121
|
+
1. [open a PR against airbnb master](https://github.com/airbnb/appear/compare?expand=1)
|
data/lib/appear/constants.rb
CHANGED
data/scripts/console
CHANGED
|
@@ -1,14 +1,21 @@
|
|
|
1
1
|
#!/usr/bin/env ruby
|
|
2
2
|
|
|
3
|
+
# This script starts a new Pry session with an instance and a config ready to
|
|
4
|
+
# go. You can create a new instance by running the create_appear_instance
|
|
5
|
+
# method at the default scope.
|
|
6
|
+
|
|
3
7
|
require "bundler/setup"
|
|
8
|
+
require "pry"
|
|
4
9
|
require "appear"
|
|
5
10
|
|
|
6
|
-
|
|
7
|
-
|
|
11
|
+
def create_appear_instance
|
|
12
|
+
config = Appear::Config.new
|
|
13
|
+
config.silent = false
|
|
14
|
+
instance = Appear::Instance.new(config)
|
|
15
|
+
return [instance, config]
|
|
16
|
+
end
|
|
8
17
|
|
|
9
|
-
|
|
10
|
-
#
|
|
11
|
-
# Pry.start
|
|
18
|
+
instance, config = create_appear_instance
|
|
19
|
+
puts "generated instance #{instance} from config #{config}"
|
|
12
20
|
|
|
13
|
-
|
|
14
|
-
IRB.start
|
|
21
|
+
binding.pry
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: appear
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.
|
|
4
|
+
version: 1.0.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Jake Teton-Landis
|
|
@@ -102,6 +102,7 @@ files:
|
|
|
102
102
|
- ".gitignore"
|
|
103
103
|
- ".rspec"
|
|
104
104
|
- ".travis.yml"
|
|
105
|
+
- CHANGELOG.md
|
|
105
106
|
- Gemfile
|
|
106
107
|
- LICENSE
|
|
107
108
|
- README.md
|