devcheck 0.3.1 → 0.3.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.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +20 -10
  3. data/devcheck +2 -0
  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: c3daae8958d13219d8b43bdf0df0e95710dd060dea2ca401f20986580cd814c3
4
+ data.tar.gz: dae60285594a15ee530d54c19875b82f80db8dfbfb1acef1fc03c71bb137429b
5
5
  SHA512:
6
- metadata.gz: 90fc6526e53808237420e5a164868701436eaf409cb2e278fee1834d85b15fe5493e19294908aae5e0261cc069c303fef798ae40d19c108c99e9632cb1759213
7
- data.tar.gz: 5aa994406ab26c661092577db46dadb1bd5ff4414f40bb938ebbaccf03b27a2d3d329e0853ae0110be57c41108c8672f840dfd3ce9140f6fd034444a08753c61
6
+ metadata.gz: 1c6594c2f9eec27279de837c644f3836a29e9bd1a6578f2b9518b6d6595005800f287196de3ba488b78852c9fd96e6cf4c2943c25763220f0ad4a07cafc7613e
7
+ data.tar.gz: f16d78e1eb675ae313624b6261768da2fa1bbf518e6f24d31f28bedad19759dfac4cd39ab5084abc935f05d9900c07c6195fec411e4083352467f4b2c771edf6
data/README.md CHANGED
@@ -23,18 +23,23 @@ checks for commands and files.
23
23
  devcheck
24
24
  ```
25
25
  ```text
26
- devcheck
26
+ devcheck v0.3.1
27
+ Project Name: Go Choose Your License
28
+ Project ID: go-choose-license
29
+
27
30
  Checking Development Environment
28
31
 
29
- ✓ ruby
30
- ✓ irb
32
+ ✓ go
31
33
  ✓ git
32
34
 
33
35
  ✓ LICENSE
34
36
  ✓ README.md
37
+ ✓ go.mod
38
+ ✓ main.go
35
39
 
36
40
  All checks passed!
37
41
  ```
42
+ And there are even colors too! Green if you pass a check and red if a check is failed.
38
43
 
39
44
  ### Exit Codes
40
45
  This program uses exit codes to help indicate the status of the program.
@@ -46,14 +51,19 @@ As mentioned earlier, all you need is a `.devcheck.rb` file in your project dire
46
51
  configuration file is shown and explained below.
47
52
 
48
53
  ```ruby
49
- command "ruby"
50
- command "git"
54
+ name "devcheck" # Project Name
55
+ id "devcheck" # Project ID
56
+
57
+ command "ruby" # A command needed
58
+ command "git" # Another command needed
51
59
 
52
- file "README.md"
53
- file "LICENSE"
60
+ file "README.md" # A file needed
61
+ file "LICENSE" # Another file needed
54
62
  ```
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.
63
+ - `name "name"` refers to the project's display-name/whatever the project is called.
64
+ - `id "name"` refers to the project's stable machine/repository-style identifier
65
+ - `command "name"` refers to a specific command that is required to be in your system's PATH variable.
66
+ - `file "path"` refers to a specific file that is required by the program in the project directory for it to function properly.
57
67
 
58
68
  ## Contributing
59
69
  We welcome contributions to the project and are so excited you have chosen to contribute!
@@ -68,4 +78,4 @@ To contribute, please follow these steps:
68
78
  Please ensure that your code follows the existing style and conventions of the project.
69
79
 
70
80
  ## License
71
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
81
+ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
data/devcheck CHANGED
@@ -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.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Louie Bloomberg