datacrafts-io-skeleton 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a8a7f1e3667328f825505e1b90a9f34548dc6a8426b48ff5125f5db2d9ede8d
-  data.tar.gz: 54b24bb63320fdd65259fe522603a76ef5c8331494ea966942442313f975b1a8
+  metadata.gz: e084eeb831e90582d312d578e13d6b93da910dae08de6e080509f8a1740742c4
+  data.tar.gz: 841209c86906ad895b93e1deea6e22a8b304ab784f28b56d45023db6cb7b0c68
 SHA512:
-  metadata.gz: 140634ed3abb87538160981b25b4f464f4f2eb867fbce41679cacb98e107e12d0f535f562db1487aed6fd4555f5ccc8a02a730172be2e2fbe8949b4062837bc2
-  data.tar.gz: 7a99a01212e82edc917b2bd542ae9f3ce57d62b06407555c8cc978402fbc24c3c88e17c9dec05836a670f1b9b0d73fa85c27a299b4cf21db38896982b871d6ef
+  metadata.gz: 95d4a8e8cfe849f390ab5bd217da9939ab2a2462d8ccc5ac8629fce038a604c35d9fa8c33fc432651c5e6b3cfe10d042f4bdb275f02365beebf0fb1955ed7bf3
+  data.tar.gz: 388886a4e2af257d7fa352e1eeb9fe1838eea19f36be74c4b42fc8755dc055fdbcacabc3915cfb59ec4c845a252b43186ce28b0935fa14aeba853e7f612e2561

data/Gemfile

@@ -3,5 +3,5 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in datacrafts_io_skeleton.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
+gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -117,7 +117,7 @@ GEM
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
-    rake (12.3.3)
+    rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -152,7 +152,7 @@ PLATFORMS
 
 DEPENDENCIES
   datacrafts-io-skeleton!
-  rake (~> 12.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH

data/README.md

@@ -17,6 +17,14 @@ This command will create new rails app with configured rails_helper.rb and .rubo
     $ datacrafts-io-skeleton create APP_NAME
     $ datacrafts-io-skeleton build APP_NAME
     $ datacrafts-io-skeleton new APP_NAME
+    
+### With frontend part.
+
+You can specify `--frontend (-f) FRONTEND_TYPE` option to additionally create frontend application inside `APP_NAME/frontend` directory. Use `-t` option to add typescript support.
+
+    $ datacrafts-io-skeleton create APP_NAME --frontend react -t 
+
+Allowed frontend types include only `react` for now.
 
 ## Development
 
@@ -35,4 +43,3 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Skeleton project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/datacrafts-io/skeleton/blob/master/CODE_OF_CONDUCT.md).
-g

data/lib/datacrafts_io_skeleton/composer.rb

@@ -1,34 +1,58 @@
 require "thor"
 require_relative "./version"
 require_relative "./rails_creator"
+require_relative "./react_creator"
 
 module DatacraftsIoSkeleton
   # Defines all CLI commands, their descriptions, params and aliases.
   class Composer < Thor
+    FRONTEND_CREATORS = {
+      "react" => ->(app_name, options) { ReactCreator.new(app_name, options).call },
+      nil => proc { |app_name| puts("The frontend is not specified for #{app_name}") }
+    }.freeze
+    ALLOWED_FRONTEND = FRONTEND_CREATORS.keys.freeze
+
     desc "create APP_NAME", "This will create new rails app."
     long_desc <<-CREATE_NEW_APP
-     This command will create new rails app with configured rails_helper.rb and .rubocop.yml files. 
-     All major gems are also included.
+      This command will create new rails app with configured rails_helper.rb and .rubocop.yml files. 
+      All major gems are also included.
+
+      You can use this command with next aliases:\n
 
-     You can use this command with next aliases:\n
+       `datacrafts-io-skeleton create APPNAME`\n
+       `datacrafts-io-skeleton build APPNAME`\n
+       `datacrafts-io-skeleton new APPNAME`\n
+
+      Skip boring start and let's code amazing stuff together.
 
-     `datacrafts-io-skeleton create APPNAME`\n
-     `datacrafts-io-skeleton build APPNAME`\n
-     `datacrafts-io-skeleton new APPNAME`\n
     CREATE_NEW_APP
+    option :frontend, type: :string, aliases: [:f], desc: <<~DESC.gsub(/\n/, "").squeeze
+      Additionally creates frontend client app, you can choose one type from the list: 
+      #{ALLOWED_FRONTEND.compact.join(', ')}.
+    DESC
+    option :typescipt, type: :boolean, aliases: [:t], desc: "Adds typescript support to frontend application."
     map %w[new build] => :create
     # Creates new app.
     #
     # @param [String] app_name  The name of app you are going to create.
     def create(app_name)
+      say("The specified frontend is not allowed", :red) && return unless specified_frontend_valid?
+
       DatacraftsIoSkeleton::RailsCreator.new(app_name).call
+      FRONTEND_CREATORS[options[:frontend]].call(app_name, options)
     end
 
     desc "version", "Display version"
     map %w[-v --version] => :version
     # Informs user about gem version.
     def version
-      say "datacrafts-io-skeleton #{DatacraftsIoSkeleton::VERSION}"
+      say("datacrafts-io-skeleton #{DatacraftsIoSkeleton::VERSION}")
+    end
+
+    private
+
+    def specified_frontend_valid?
+      ALLOWED_FRONTEND.include?(options[:frontend])
     end
   end
 end

data/lib/datacrafts_io_skeleton/helpers.rb

@@ -0,0 +1,23 @@
+require "thor"
+
+module DatacraftsIoSkeleton
+  # Shared logic.
+  module Helpers
+    # Defines gem templates folder which you can use to load template to the new app.
+    TEMPLATES_DIR = (File.dirname(__FILE__) + "/../../templates").freeze
+
+    def self.included(klass)
+      klass.class_eval do
+        include Thor::Actions
+      end
+    end
+
+    def commit(message, app_path=app)
+      run "cd #{app_path} && git add . && git commit -m '#{message}'"
+    end
+
+    def app(path=nil)
+      "#{@app_name}/#{path}"
+    end
+  end
+end

data/lib/datacrafts_io_skeleton/rails_creator.rb

@@ -1,13 +1,10 @@
 require "thor"
+require_relative "./helpers"
 
 module DatacraftsIoSkeleton
   # Responsible for the creation of rails projects.
   class RailsCreator < Thor
-    include Thor::Actions
-
-    # Defines gem templates folder which you can use to load template to the new app.
-    TEMPLATES_DIR = (File.dirname(__FILE__) + "/../../templates").freeze
-
+    include Helpers
     source_root TEMPLATES_DIR
 
     no_commands do
@@ -28,6 +25,7 @@ module DatacraftsIoSkeleton
         update_spec_config
         run_rubocop
         commit_project
+        say("Rails API part has built.", :green)
       end
     end
 
@@ -51,16 +49,12 @@ module DatacraftsIoSkeleton
       end
 
       def run_rubocop
-        run "cd #{app} && rubocop -a"
+        run "cd #{app} && bundle exec rubocop -A"
       end
 
       def commit_project
-        append_to_file app(".gitignore"), "/.idea/\n"
-        run "cd #{app} && git add . && git commit -m 'Initial commit.'"
-      end
-
-      def app(path=nil)
-        "#{@app_name}/#{path}"
+        append_to_file app(".gitignore"), "/.idea/"
+        commit("Initial commit.")
       end
     end
   end

data/lib/datacrafts_io_skeleton/react_creator.rb

@@ -0,0 +1,65 @@
+require "thor"
+require_relative "./helpers"
+
+module DatacraftsIoSkeleton
+  # Responsible for the creation of rails projects.
+  class ReactCreator < Thor
+    include Helpers
+    source_root TEMPLATES_DIR
+
+    DEFAULT_FOLDERS = %w[src/tests src/components].freeze
+
+    no_commands do
+      def initialize(app_name, options)
+        super()
+        @app_name = app_name # We use it to commit changes.
+        @front_name = "#{app_name}/frontend"
+        @ts = options[:typescipt]
+      end
+
+      def call
+        empty_directory @front_name
+        inside @front_name do
+          create_react_app
+          create_default_folders
+        end
+        copy_config_files
+        run_linters
+        commit("React frontend app was added.")
+        say("React frontend part has built.", :green)
+      end
+    end
+
+    private
+
+    no_commands do
+      def create_react_app
+        run "npx create-react-app . #{@ts && '--template typescript'}"
+        run "npm i -s #{react_libs}"
+        run "npm install"
+      end
+
+      def create_default_folders
+        DEFAULT_FOLDERS.each(&method(:empty_directory))
+      end
+
+      def copy_config_files
+        copy_file "eslintrc.js", app("frontend/.eslintrc.js")
+        copy_file "stylelintrc.json", app("frontend/.stylelintrc")
+        copy_file "prettierrc.json", app("frontend/.prettierrc.json")
+      end
+
+      def run_linters
+        run "cd #{app('frontend')} && npx eslint --quiet --fix --ext ts,tsx,js,jsx src"
+        run "cd #{app('frontend')} && npx stylelint --fix **/*.css"
+      end
+
+      def react_libs
+        %w[axios prettier @typescript-eslint/parser @typescript-eslint/eslint-plugin
+           eslint-plugin-react eslint-config-prettier eslint-plugin-prettier
+           stylelint stylelint-config-standard typescript
+           enzyme @testing-library/react msw].join(" ")
+      end
+    end
+  end
+end

data/lib/datacrafts_io_skeleton/version.rb

@@ -1,4 +1,4 @@
 module DatacraftsIoSkeleton
   # Defines gem version
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1".freeze
 end

data/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}

data/templates/eslintrc.js

@@ -0,0 +1,23 @@
+module.exports = {
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: "module",
+    ecmaFeatures: {
+      jsx: true
+    }
+  },
+  settings: {
+    react: {
+      version: "detect"
+    }
+  },
+  extends: [
+    "plugin:react/recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier/@typescript-eslint",
+    "plugin:prettier/recommended"
+  ],
+  rules: {
+  },
+};

data/templates/prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": false,
+  "singleQuote": true
+}

data/templates/rails.rb

@@ -29,7 +29,7 @@ end
 
 gem_group :test do
   gem "database_cleaner-active_record"
-  gem "factory_bot"
+  gem "factory_bot_rails"
   gem "simplecov", require: false
   gem "shoulda-matchers"
 end

data/templates/rubocop.yml.erb

@@ -5,6 +5,7 @@ require:
   - rubocop-faker
 
 AllCops:
+  NewCops: enable
   UseCache: false
   TargetRubyVersion: <%= RUBY_VERSION[/\d+\.\d+/] %>
   Exclude:

data/templates/stylelintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "stylelint-config-standard"
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datacrafts-io-skeleton
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Roman Ovcharov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-15 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,11 +76,17 @@ files:
 - exe/datacrafts-io-skeleton
 - lib/datacrafts_io_skeleton.rb
 - lib/datacrafts_io_skeleton/composer.rb
+- lib/datacrafts_io_skeleton/helpers.rb
 - lib/datacrafts_io_skeleton/rails_creator.rb
+- lib/datacrafts_io_skeleton/react_creator.rb
 - lib/datacrafts_io_skeleton/version.rb
+- renovate.json
+- templates/eslintrc.js
+- templates/prettierrc.json
 - templates/rails.rb
 - templates/rubocop.yml.erb
 - templates/spec.rb
+- templates/stylelintrc.json
 homepage: https://github.com/datacrafts-io/skeleton
 licenses:
 - MIT