devcheck 0.3.1 → 0.3.3

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.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +26 -10
  3. data/devcheck +4 -2
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1a539fe629ceb074ec4374bd32ab1ccd1fe667e695e53e6bb4725f7979e5f699
4
- data.tar.gz: ad9118e687c78ffe284b6f5985fe6c69f5b834b935e1b120e3c692d10e0cb2e3
3
+ metadata.gz: 4557f8583d166864d19e37c1c297a2fc62b98ba311e6201f8c9d1c08fe599523
4
+ data.tar.gz: c99270276bf19211e96fb0d24bae594d15b8c1b44de17993ea388f18538c18fc
5
5
  SHA512:
6
- metadata.gz: 90fc6526e53808237420e5a164868701436eaf409cb2e278fee1834d85b15fe5493e19294908aae5e0261cc069c303fef798ae40d19c108c99e9632cb1759213
7
- data.tar.gz: 5aa994406ab26c661092577db46dadb1bd5ff4414f40bb938ebbaccf03b27a2d3d329e0853ae0110be57c41108c8672f840dfd3ce9140f6fd034444a08753c61
6
+ metadata.gz: 4ea1d4b518510ebf88e39fd2fdacef55ee28e6f8df8881402bc072f331a3094b19ae603775de902d1bca9960cf3fb355f7c60ac2d87dfac8cbd6b46ee1b10878
7
+ data.tar.gz: d30704fd11ba862151c0211747994903ea38372c30fc229859794f16f230d3ea0906edb84135841084814b0fccadf881ff677250fa702b79e2d0e5d5f4f96a17
data/README.md CHANGED
@@ -6,6 +6,10 @@ are configured correctly for the project they are working on. `devcheck` provide
6
6
  an easy way to set up your development environment checking by just creating a `.devcheck.rb` file
7
7
  and populating it with the required commands and files needed for the project to function properly.
8
8
 
9
+ What makes `devcheck` unique is its ability to be flexible. Unlike compiled development environment
10
+ checkers, `devcheck` allows you to customize what commands and files to check for. You can also
11
+ personalize your project's name and ID to show up when running `devcheck`.
12
+
9
13
  ## Installation
10
14
  `devcheck` can be installed by running the `gem install devcheck` command from your terminal.
11
15
 
@@ -23,18 +27,25 @@ checks for commands and files.
23
27
  devcheck
24
28
  ```
25
29
  ```text
26
- devcheck
30
+ devcheck v0.3.2
31
+ Project Name: Go Choose Your License
32
+ Project ID: go-choose-license
33
+
27
34
  Checking Development Environment
28
35
 
29
- ✓ ruby
30
- ✓ irb
36
+ Commands:
37
+ ✓ go
31
38
  ✓ git
32
39
 
40
+ Files:
33
41
  ✓ LICENSE
34
42
  ✓ README.md
43
+ ✓ go.mod
44
+ ✓ main.go
35
45
 
36
46
  All checks passed!
37
47
  ```
48
+ And there are even colors too! Green if you pass a check and red if a check is failed.
38
49
 
39
50
  ### Exit Codes
40
51
  This program uses exit codes to help indicate the status of the program.
@@ -46,14 +57,19 @@ As mentioned earlier, all you need is a `.devcheck.rb` file in your project dire
46
57
  configuration file is shown and explained below.
47
58
 
48
59
  ```ruby
49
- command "ruby"
50
- command "git"
60
+ name "devcheck" # Project Name
61
+ id "devcheck" # Project ID
62
+
63
+ command "ruby" # A command needed
64
+ command "git" # Another command needed
51
65
 
52
- file "README.md"
53
- file "LICENSE"
66
+ file "README.md" # A file needed
67
+ file "LICENSE" # Another file needed
54
68
  ```
55
- - `command "name"` refers to a specific command that might be run by the program or require you to have said command installed on your device.
56
- - `file "path"` refers to a specific file that might be required by the program or need to be present in the project directory for it to function properly.
69
+ - `name "name"` refers to the project's display-name/whatever the project is called.
70
+ - `id "name"` refers to the project's stable machine/repository-style identifier
71
+ - `command "name"` refers to a specific command that is required to be in your system's PATH variable.
72
+ - `file "path"` refers to a specific file that is required by the program in the project directory for it to function properly.
57
73
 
58
74
  ## Contributing
59
75
  We welcome contributions to the project and are so excited you have chosen to contribute!
@@ -68,4 +84,4 @@ To contribute, please follow these steps:
68
84
  Please ensure that your code follows the existing style and conventions of the project.
69
85
 
70
86
  ## License
71
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
87
+ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
data/devcheck CHANGED
@@ -45,8 +45,8 @@ def command_exists?(cmd)
45
45
  checker = Gem.win_platform? ? 'where' : 'which'
46
46
 
47
47
  # Suppress output and check exit status
48
- system("#{checker} #{cmd} > /dev/null 2>&1")
49
- if $?.success?
48
+ #system("#{checker} #{cmd} > /dev/null 2>&1")
49
+ if system(checker, cmd, out: File::NULL, err: File::NULL )
50
50
  puts "\e[32m✓ #{cmd}\e[0m"
51
51
  else
52
52
  puts "\e[31m✗ #{cmd}\e[0m"
@@ -86,6 +86,7 @@ puts ""
86
86
  if $commands.empty?
87
87
  puts "No Commands Specified."
88
88
  else
89
+ puts "Commands:"
89
90
  $commands.each do |cmd|
90
91
  command_exists?(cmd)
91
92
  end
@@ -96,6 +97,7 @@ puts ""
96
97
  if $files.empty?
97
98
  puts "No Files Specified."
98
99
  else
100
+ puts "Files:"
99
101
  $files.each do |file|
100
102
  file_exists?(file)
101
103
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: devcheck
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.1
4
+ version: 0.3.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Louie Bloomberg