jscop 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfcb068c701434605b2f0c9b0493a63da87b7c38cac2ed9a1863c455a96c709a
-  data.tar.gz: 0f3b9fafaa1827044fd26dd3d0ae1ff376ddcbac0acefe58167999806deb640e
+  metadata.gz: 2cc2232c173339355f33b21707cdee6063a15a0fdce311f67fe2727e7a09dd1a
+  data.tar.gz: b9d78f2dd4071da98d8e081ca4a4bb5473c169362226460fb3cbb6fd1a03f483
 SHA512:
-  metadata.gz: 9874c505f8f141e9442455798f5b6f36f611ef4d318fec1796a0ac50d9ba3fc80f28000eea7c23080580f5f10001c0078b584ce3ae8659469e061eab7650da50
-  data.tar.gz: 225eadd3a11c805980f442f18538db222fba198791dc93fbb0cb4a4f44de9bcdda3807269f5886f73e297e7f48e12427d5786f8a7f268737d5458c2fff20deea
+  metadata.gz: b6ae88acec4fdc5ba41b6020d2931318494311c8d2709245d2bea6c664fd047cd40cd0aa43b399948e43d68d89081f845f40dc1feca2be1dbb75c3546cbb9c9e
+  data.tar.gz: 89f46e2cd210c120fba2dcd17a7d2daaddfb32f01f25b35991cedb2381204d383cba96a351d0698a4c2e388df331854946d932e483ce7df1020549ba9db57581

data/.gitignore

@@ -6,7 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
-/vendor/
+/vendor/**/*/
 
 # rspec failure tracking
 .rspec_status

data/.replit

@@ -1,2 +1,2 @@
 language = "ruby"
-run = "bin/main.rb ."
+run = "exe/jscop"

data/.rubocop.yml

@@ -5,7 +5,8 @@ AllCops:
     - "Guardfile"
     - "Rakefile"
     - "rof_work.rb"
-    - "vendor"
+    - "vendor/**/*"
+    - "jscop.gemspec"
 
   DisplayCopNames: true
 

data/.stickler.yml

@@ -10,4 +10,5 @@ files:
     - "node_modules/**/*"
     - "spec/spec_helper.rb"
     - "rof_work.rb"
-    - "vendor"
+    - "vendor/**/*"
+    - "jscop.gemspec"

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in jscop.gemspec
 gemspec

data/README.md

@@ -1,15 +1,37 @@
-[![Run on Repl.it](https://repl.it/badge/github/codecell/js-companion)](https://repl.it/github/codecell/js-companion)
+[![Gem Version](https://badge.fury.io/rb/jscop.svg)](https://badge.fury.io/rb/jscop) [![Run on Repl.it](https://repl.it/badge/github/codecell/js-companion)](https://repl.it/github/codecell/js-companion)
 
-# Js-Companion
+# Jscop
 
 This is a Linter for checking errors in Javascript code, built with Ruby. 
 
-## PREVIEW
-   ![image](https://user-images.githubusercontent.com/46686100/78828956-6eb04300-79dd-11ea-8529-598e8dc3011e.png) 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jscop'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jscop
+
+## Usage
+- once in desired path in the terminal/console, RUN
+
+```ruby
+a. jscop # To lint all *.js files in the current Path.
+b. jscop ./**/path_to_file.js # To lint JUST a specific file.
+c. jscop foldername # To lint all *.js files in a specific folder.
+```
 
 ## Outline
-  - Title, Description and Preview Above
-  - Errors currently detectable by js-companion
+  - Title, Description, Installation, Usage Above
+  - Errors currently detectable by jscop
     - variable naming errors
     - class naming errors
     - Extra or redundant spacing errors 
@@ -17,12 +39,11 @@ This is a Linter for checking errors in Javascript code, built with Ruby.
     - Unused variables are detected
   - Arguments supported to initiate linting
   - Testing Javascript files with Js-Companion
-    - without cloning
     - cloning Locally to local machine
   - Unit Tests
   - Tools used
+  - Code of conduct
   - Contributing
-  - Author Details
 
 ## ERRORS that can currently be detected include
 
@@ -34,8 +55,10 @@ This is a Linter for checking errors in Javascript code, built with Ruby.
 ### CLASS NAME ERRORS 
   - if class names begin With small letters and/or
   - if class names is Snake-Cased or both e.g
-    - `*Bad practice* class badclass {} or class Bad-class {}`    
+    - `*Bad practice* class badclass {} or class Bad-class {}`   
     - `*Good Practice* class GoodClass {} or class Good_Class {}`
+  - Or if underscores and hyphen are mixed
+    `*Bad practice* class Bad_class-Name {}`
     
 ### SPACING ERRORS
   - if Spaces are found at beginning of lines
@@ -48,6 +71,7 @@ This is a Linter for checking errors in Javascript code, built with Ruby.
 
 ### UNUSED VARIABLE ERROR
   - if a variable (var, let, const) is defined and never used.
+  - A lot of edge cases is covered here.
 
 ## Arguments Supported By Js-Companion to check Javascript code
   - You can pass in file(s) or a folder in any of the following cases in your terminal
@@ -55,26 +79,16 @@ This is a Linter for checking errors in Javascript code, built with Ruby.
     - `You can pass in a Folder and all Javascript files in it will be checked and finally`
     - `Everything Js can be linted all at once (both files and Folders)`
 
-## Testing Your Javscript code
-  -  ### Without Cloning
-  - If You don't want to clone this repository, you can simply click the `Run On Replit badge` above
-    to quickly test the project on Replit. *Note* However that the the Replit console(terminal) does not support the colors and font gems used, so it will appear black/white
-
-    ### To clone and test Javascript files locally
-  - Once in the Path you intend to keep this project in the terminal of your machine
-  - Clone with this command `git clone [repo](https://github.com/codecell/js-companion.git)`
-  - Enter into the folder `cd js-companion`
-  - Install project dependencies with the command `bundle install`
-  - You can make the bin/main.rb executable with the command `chmod +x bin/main.rb` if permission is not granted.
-
-  ### Finally To Check Javascript File;
-  - use the command `bin/main.rb ./**/path_to_file.js` To lint JUST a specific file.
-  - use the command `bin/main.rb FolderName` To lint all `*.js` files a specific folder.
-  - To lint everything, use the command *bin/main.rb dot* => `bin/main.rb .` to lint (all files and folders) visible from the root of the current folder.
+## Testing This Repo
+- Once in the Path you intend to keep this project in the terminal of your machine
+- Clone with this command git clone [repo](https://github.com/codecell/jscop.git)
+- change directory into the folder cd jscop
+- Install project dependencies with the command bundle install
+- You can make the exe/jscop executable with the command chmod a+x exe/jscop if permission is not granted
 
 ## Unit Tests
 - Ensure you have `rspec` installed, or ensure the `gem 'rspec` is listed among the gems in the `Gemfile` => then run `bundle install`
-- in your console, run `rspec` to run all the unit tests written for this project
+- in your console, run `rspec` or `rake` to run all the unit tests written for this project
 
 ## Built With
 - Ruby
@@ -82,8 +96,13 @@ This is a Linter for checking errors in Javascript code, built with Ruby.
 - Rubocop Linter
 - Stickler CI
 
-## Contributing 
-- Your contributions are highly welcome on improving this project
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/codecell/jscop. 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.
+
+## Code of Conduct
+
+Everyone interacting in the Jscop project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/codecell/jscop/blob/master/CODE_OF_CONDUCT.md).
 
 ## Author
 
@@ -92,10 +111,6 @@ This is a Linter for checking errors in Javascript code, built with Ruby.
 - Github: [@codecell](https://github.com/codecell)
 - Twitter: [@the_codecell](https://twitter.com/the_codecell) 
 - Linkedin: [ezaka alfred](https://www.linkedin.com/in/alfrednoble/)
+## License
 
-
-## Show your support
-
-Give a ⭐️ if you like this project!
-## Licence
-MIT
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/console

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
+require 'bundler/setup'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -9,5 +9,5 @@ require "bundler/setup"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/exe/jscop

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require "jscop/version"
+require 'jscop/version'
 require_relative '../lib/helpers/lint_ware'
 require 'tty-font'
 require 'colorize'
@@ -26,7 +26,6 @@ def jscop_init
   show_title
 
   path = ARGV[0]
-  
   path = '.' if ARGV.empty?
 
   error_bin = []

data/jscop.gemspec

@@ -1,32 +1,29 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "jscop/version"
+require 'jscop/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "jscop"
-  spec.version       = Jscop::VERSION
-  spec.authors       = ["Ezaka Alfred"]
-  spec.email         = ["ezakaphil@gmail.com"]
-
-  spec.summary       = %q{A linter for checking errors in javascript code}
-  spec.homepage      = "https://github.com/codecell/jscop"
-  spec.license       = "MIT"
+  spec.name = 'jscop'
+  spec.version = Jscop::VERSION
+  spec.authors = ['Ezaka Alfred']
+  spec.email = ['ezakaphil@gmail.com']
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.summary = 'A linter for checking errors in javascript code'
+  spec.homepage = 'https://github.com/codecell/jscop'
+  spec.license = 'MIT'
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.executables << "jscop"
-  spec.require_paths = ["lib", "spec"]
+  
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables << 'jscop'
+  spec.require_paths = %w[lib spec]
 
-  spec.add_runtime_dependency "colorize", "~> 0.8"
-  spec.add_runtime_dependency "tty-font", "~> 0.5"
+  spec.add_runtime_dependency 'colorize', '~> 0.8'
+  spec.add_runtime_dependency 'tty-font', '~> 0.5'
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/helpers/lint_ware.rb

@@ -31,7 +31,7 @@ module LintWare
   def self.init_dir_linting(error_bin, path)
     if CheckJsFiles.find_dir(path)
       files = CheckJsFiles.seek_js(path)
-      files.each { |file| start_all(error_bin, file) } if files
+      files.each { |file| start_all(error_bin, file) } && files
     else
       CheckJsFiles.find_dir(path)
     end

data/lib/jscop/version.rb

@@ -1,3 +1,3 @@
 module Jscop
-  VERSION = "0.1.2"
+  VERSION = '0.1.3'.freeze
 end

data/lib/jscop.rb

@@ -1,4 +1,4 @@
-require "jscop/version"
+require 'jscop/version'
 
 module Jscop
   class Error < StandardError; end