konstruct 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec56690144a9bfa295c5e4cc565f7f73c3fea9fb
-  data.tar.gz: 1baf284a2ce48390e87f5472cde3e4d538d3ca0b
+  metadata.gz: 1e0f8d6d9d08df5fb4a6e2df306fdacd027e5cb7
+  data.tar.gz: fc1a9f444179125cd001e292e99a2f3dcf4c0010
 SHA512:
-  metadata.gz: 0c2fe2a8a224f964b70bc1cfb0bf1701333e13b203f1ba4b9afed9a6c74b27bb563597c3a7e2f5429f1f5eb7b5d6691cc99741a8835623fddd41a65f4f27d30e
-  data.tar.gz: 82999b8b525750fed0364c721f0251486070e69010c6c60f9bc3ac702b1b99dd4af9cd754895058a3008538367d02f579ce24bb1c03434aba190c763d7b4b645
+  metadata.gz: 9ba67d6b48d82cb6c0bc42ef1d3b948d04701e524c4fb20f0db5ed9deb230009fc2a9c19610b30a534b97d8e332f85f223a0c6563f4d632b2c17903b96fbc492
+  data.tar.gz: 0cbd097cdeea548afb160c85535ac8b8a5097da3212a72d3a5383377ef1db69c350fde198b9918704f4e9a8d28b0ee4fcbb0f4473386c032417ab3be76346df2

data/README.md

@@ -9,6 +9,10 @@ The Konstruct Cli provides tools to make working with Konstruct painless and qui
 You can install Konstruct Cli by running:
 
     $ gem install konstruct
+    
+When it's installed simply run:
+
+    $ konstruct
 
 ## Usage
 
@@ -40,6 +44,12 @@ This feature is coming soon.
     
 Loads up the [Konstruct Documentation](http://konstruct.github.io/) in your default browser.
 
+#### Init
+
+    $ konstruct init
+    
+Initialises the Cli by installing any libraries and extensions you might require to work with Konstruct. This command only runs once (usually when you run `$ konstruct` for the first time), and then simply displays a welcome screen.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/konstruct/konstruct.cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/{utilities/artwork.rb → cli/init.rb}

@@ -1,21 +1,29 @@
-# KONSTRUCT CLI [ UTILITIES ] =========================================================================================
+# KONSTRUCT CLI [ KONSTRUCT MODULE ] ==================================================================================
 
 # ====== INDEX  =======================================================================================================
 # ==
-# == A. ARTWORK
+# == A. INIT SCRIPT
 # ==
 # ====== INDEX  =======================================================================================================
 
-# A. ARTWORK ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# A. INIT SCRIPT ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-module Util
+module Konstruct
    
-    class Art
+    class Cli
         
-        # B.1. GIT COMMANDS -------------------------------------------------------------------------------------------
-       
-        def icon
+        def init
             
+            # B.1. INITIALISE FUNCTIONS -------------------------------------------------------------------------------
+            
+            msg = Util::Message.new()
+            
+            # B.1. END ------------------------------------------------------------------------------------------------
+            
+            msg.heading("WELCOME TO THE KONSTRUCT CLI!")
+            
+            # B.2. SHOW THE HELLO SCREEN ------------------------------------------------------------------------------
+        
             puts ""
             puts ""
             puts Paint['    $III7IIIIIIIIIIIIIIIIIIIIIIIIII: ', "#de544b"]
@@ -44,15 +52,19 @@ module Util
             puts ""
             puts Paint['    GO BUILD SOMETHING AWESOME!', "#999999"]
             puts ""
+            puts Paint['    Run "$ konstruct --help" or "$ konstruct documentation" whenever you get stuck!', "#999999"]
+            puts ""
+            
+            exit(0)
+            
+            # B.3. END ------------------------------------------------------------------------------------------------
             
         end
         
-        # B.1. END ----------------------------------------------------------------------------------------------------
-        
     end
     
 end
 
-# A. END ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# B. END ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# END OF FILE =========================================================================================================
+# END OF FILE =========================================================================================================

data/lib/konstruct.rb

@@ -22,7 +22,6 @@ require 'launchy'
 
 #A.2.1. UTILITIES
 
-require_relative 'utilities/artwork'
 require_relative 'utilities/utils'
 
 # A.2.2. CLI SCRIPTS
@@ -30,12 +29,12 @@ require_relative 'utilities/utils'
 require_relative 'cli/scaffold'
 require_relative 'cli/skeleton'
 require_relative 'cli/documentation'
+require_relative 'cli/init'
 
 # A.2. END ------------------------------------------------------------------------------------------------------------
 
 # A.3. INITIALISE DEPENDENCIES ----------------------------------------------------------------------------------------
 
-art = Util::Art.new()
 msg = Util::Message.new()
 fs = Util::FS.new()
 cli = Konstruct::Cli.new()
@@ -59,7 +58,30 @@ program :description, 'The Konstruct CLI provides scaffolding and other tools to
 
 # B.1. END ------------------------------------------------------------------------------------------------------------
 
-# B.2. COMMAND: SKELETON ----------------------------------------------------------------------------------------------
+# B.2. COMMAND: DOCUMENTATION -----------------------------------------------------------------------------------------
+
+# -- DESCRIPTION: Launches Konstruct documentation in a browser
+
+# -- USAGE: $ konstruct documentation
+
+command :init do |c|
+    
+    c.syntax = 'konstruct init'
+    c.summary = 'Initialises the Konstruct Cli'
+    c.description = 'Initialises the Konstruct Cli by installing libraries and other extensions you might need.'
+    c.action do |args, options|
+        
+        cli.init()
+
+    end
+
+end
+
+default_command :init
+
+# B.2. END ------------------------------------------------------------------------------------------------------------
+
+# B.3. COMMAND: SKELETON ----------------------------------------------------------------------------------------------
 
 # -- DESCRIPTION: Scaffolds a skeleton project folder structure for you.
 
@@ -72,8 +94,6 @@ command :skeleton do |c|
     c.description = 'Builds out a new global project file structure for you to get started with quickly.'
     c.example 'Structure:', '[1--ci, 2--design, 3--working, 4--www]'
     c.action do |args, options|
-        
-        art.icon()
 
         cli.skeleton(projectDir)
 
@@ -81,9 +101,9 @@ command :skeleton do |c|
 
 end
 
-# B.2. END ------------------------------------------------------------------------------------------------------------
+# B.3. END ------------------------------------------------------------------------------------------------------------
 
-# B.3. COMMAND: DOCUMENTATION -----------------------------------------------------------------------------------------
+# B.4. COMMAND: DOCUMENTATION -----------------------------------------------------------------------------------------
 
 # -- DESCRIPTION: Launches Konstruct documentation in a browser
 
@@ -95,8 +115,6 @@ command :documentation do |c|
     c.summary = 'Launches Konstruct documentation in a browser'
     c.description = 'Launches Konstruct documentation in a browser'
     c.action do |args, options|
-        
-        art.icon()
 
         cli.documentation()
 
@@ -104,7 +122,7 @@ command :documentation do |c|
 
 end
 
-# B.3. END ------------------------------------------------------------------------------------------------------------
+# B.4. END ------------------------------------------------------------------------------------------------------------
 
 # B. END ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 

data/lib/konstruct/version.rb

@@ -1,3 +1,3 @@
 module Konstruct
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/utilities/utils.rb

@@ -66,6 +66,8 @@ module Util
        
         def heading(msg)
             
+            puts ""
+            
             puts Paint["----------------------------------------------------------------------------", :cyan]
 
             puts Paint["--", :cyan]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: konstruct
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Adrian Kirsten
@@ -117,11 +117,11 @@ files:
 - bin/setup
 - konstruct.gemspec
 - lib/cli/documentation.rb
+- lib/cli/init.rb
 - lib/cli/scaffold.rb
 - lib/cli/skeleton.rb
 - lib/konstruct.rb
 - lib/konstruct/version.rb
-- lib/utilities/artwork.rb
 - lib/utilities/commands.rb
 - lib/utilities/utils.rb
 homepage: https://github.com/konstruct/konstruct.cli