devcheck 0.4.0 → 0.4.1

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 +62 -19
  3. data/devcheck +1 -1
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e5261525f11e3d3219943815605bdd5ef4e8c51e56317668b0f88cfdea066c2b
4
- data.tar.gz: a12aec97e39efaf2ae385717bf0dd5ba4ae0fbd342893bd5f7f08562654f8019
3
+ metadata.gz: 6bef7ce735761025409136355663c512525e7154568c3ba615077b4651ee26f3
4
+ data.tar.gz: 63d8b5e9f9a21afab03591f587d0b8ffce7424ab9b2bec97ff5c70ae8613320d
5
5
  SHA512:
6
- metadata.gz: f6bed7325b21fd46b56ffc89192dfc4e0c739dd81446d5a9608e770dcf84deda6b12d8d0d74df27576d4a25409cc39e4dae48933253dd2677f6a1c73a6c1b106
7
- data.tar.gz: a759c287ccc0543eacb5b95bfd1b8de65b9da999b01b75265c27e2c1cd7b0c39414b0dc5099e538418f36c91d847d94c608a04bfe0d796f5de24c5f253df5a18
6
+ metadata.gz: 7cd876c558e7a6d722c70819509a8702445bd0c93cdf4356a71dba3f39eb6e073a65966cceeaa6dc6d8060fb7ee8995023930c75f01ed474b5cd69e2a7753803
7
+ data.tar.gz: 6d38140df5cd7d725e6be76337c1fe1a60201bd7ae143c94bbb4cccc8719e587c9d200b7d0cccee667921484b2143f85e2c92f594ce55b01ae500e0729ca211d
data/README.md CHANGED
@@ -1,6 +1,10 @@
1
1
  # devcheck
2
2
  A tool for checking development environments.
3
3
 
4
+ [![Gem Version](https://badge.fury.io/rb/devcheck.svg)](https://rubygems.org/gems/devcheck)
5
+ [![GitHub Release](https://img.shields.io/github/v/release/Bloomy52/devcheck)](https://github.com/Bloomy52/devcheck/releases/latest)
6
+
7
+
4
8
  `devcheck` is a command-line tool that helps developers ensure their development environments
5
9
  are configured correctly for the project they are working on. `devcheck` provides
6
10
  an easy way to set up your development environment checking by just creating a `.devcheck.rb` file
@@ -17,17 +21,37 @@ Ruby is required to install and run `devcheck`. You will need Ruby version 3.0 o
17
21
  macOS Users will need to install a newer version of Ruby since the version Apple ships does not
18
22
  meet the minimum Ruby version required by `devcheck`.
19
23
 
24
+ ## Configuration
25
+ Before you can use `devcheck`, you need to create a `.devcheck.rb` file. A sample `.devcheck.rb`
26
+ is below along with other useful information.
27
+
28
+ ```ruby
29
+ name "devcheck" # Project Name
30
+ id "devcheck" # Project ID
31
+
32
+ command "ruby" # A command needed
33
+ command "git" # Another command needed
34
+
35
+ file "README.md" # A file needed
36
+ file "LICENSE" # Another file needed
37
+ ```
38
+ - `name "name"` refers to the project's display-name/whatever the project is called.
39
+ - `id "name"` refers to the project's stable machine/repository-style identifier
40
+ - `command "name"` refers to a specific command that is required to be in your system's PATH variable.
41
+ - `file "path"` refers to a specific file that is required by the program in the project directory for it to function properly.
42
+
43
+
20
44
  ## Usage
21
45
  `devcheck` can be run by typing `devcheck` in your terminal. All you need is to have a
22
- `.devcheck.rb` file in your project directory and the Ruby interpreter. This program only
23
- checks for commands and files.
46
+ `.devcheck.rb` file in your project directory and the Ruby interpreter. You can find the
47
+ configuration information above. This program only checks for commands and files.
24
48
 
25
49
  ### Example
26
50
  ```bash
27
51
  devcheck
28
52
  ```
29
53
  ```text
30
- devcheck v0.3.3
54
+ devcheck v0.4.1
31
55
  Project Name: Go Choose Your License
32
56
  Project ID: go-choose-license
33
57
 
@@ -47,29 +71,48 @@ All checks passed!
47
71
  ```
48
72
  And there are even colors too! Green if you pass a check and red if a check is failed.
49
73
 
74
+ ### Environments
75
+ Starting with `devcheck` version `0.4.0`, you can now add environments to check
76
+ separate development environments. Check out an example of a `.devcheck.rb` file
77
+ ```ruby
78
+ name "IsUnicodeText?"
79
+ id "isunicodetext"
80
+
81
+ environment "vb" do
82
+ command "msbuild"
83
+ file "IsUnicodeText.slnx"
84
+ file "IsUnicodeText\\IsUnicodeText.vbproj"
85
+ file "IsUnicodeText\\Form1.vb"
86
+ file "IsUnicodeText\\Form1.Designer.vb"
87
+ file "IsUnicodeText\\App.config"
88
+ end
89
+
90
+ environment "c" do
91
+ command "cl"
92
+ file "test_unicode.c"
93
+ end
94
+
95
+ command "git"
96
+ ```
97
+ And when you want to call the `vb` environment, all you need to do type `devcheck vb` and you get
98
+ the checks for what is in the `vb` environment along with what is in the shared portion.
99
+
50
100
  ### Exit Codes
51
101
  This program uses exit codes to help indicate the status of the program.
52
102
  * `0`: All checks passed.
53
- * `1`: One or more checks failed or the `.devcheck.rb` file is missing.
103
+ * `1`: One or more checks failed.
104
+ * `2`: The `.devcheck.rb` file is missing.
54
105
 
55
- ## Configuration
56
- As mentioned earlier, all you need is a `.devcheck.rb` file in your project directory. A sample
57
- configuration file is shown and explained below.
106
+ ## Releases
58
107
 
59
- ```ruby
60
- name "devcheck" # Project Name
61
- id "devcheck" # Project ID
108
+ `devcheck` is distributed through [RubyGems](https://rubygems.org/gems/devcheck).
62
109
 
63
- command "ruby" # A command needed
64
- command "git" # Another command needed
110
+ For information about the latest release, previous versions, and
111
+ changes between releases, visit the
112
+ [GitHub Releases](https://github.com/Bloomy52/devcheck/releases) page.
65
113
 
66
- file "README.md" # A file needed
67
- file "LICENSE" # Another file needed
68
- ```
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.
114
+ Releases are automatically published to RubyGems, with corresponding
115
+ GitHub Releases providing version history and changelogs.
73
116
 
74
117
  ## Contributing
75
118
  We welcome contributions to the project and are so excited you have chosen to contribute!
data/devcheck CHANGED
@@ -84,7 +84,7 @@ begin
84
84
  load ".devcheck.rb"
85
85
  rescue LoadError
86
86
  puts "No .devcheck.rb file found"
87
- exit 1
87
+ exit 2
88
88
  end
89
89
 
90
90
 
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.4.0
4
+ version: 0.4.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Louie Bloomberg