dopstick 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 561b26205dfef50b8f164c6a3db683fe509e4c98811a2c2619947e6b25c4e3a0
-  data.tar.gz: c755f5a46d109f4af6ff7293d43df4de7c3a18cd148757e1b08ccb60e38ad0b9
+  metadata.gz: 17fe9695f451b433549bf25b5d8d5484388771739fc32333c4d3a4a6bcfa9348
+  data.tar.gz: 4791e172a00147a6e7e920eff00e15b26c6ec73d3964a4854e91847989049da3
 SHA512:
-  metadata.gz: 2e34355f973760582c98eb094f8c9292b049be619a2a397f47abb6423a165e8eb43cc4c1646c8e6a0970912c747808f078ffe1e5199ea9eab36f769251a56ff2
-  data.tar.gz: 97c0bae838da251a639950b5f4a43fd22777976ad20680af66a78038096cf6fe3e490aaca2139d75be22d14834eb508180d58feec9517d2d02c0f975968283ff
+  metadata.gz: 65edec1f5c5d373b5ead2dd1631fe4b5638cd396a11d10ad727e35ac6fc8f010134a06f9fb0c4b27b4b95ef62fb9d4556abfe2123252e3d933a07a36348065f1
+  data.tar.gz: df7abe336abf35acaea9cc3e295cd547a5c376f448ffe80e9862d909d78b15d3ad300930c376c50c0a0ee2d5f3415b9a18b595ec75e9ff2ee94a7752aaf86ada

data/.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# You can read more about CODEOWNERS at
+# https://help.github.com/github/creating-cloning-and-archiving-repositories/about-code-owners
+
+* @fnando

data/.github/FUNDING.yml

@@ -1,4 +1,4 @@
 # These are supported funding model platforms
 
 github: [fnando]
-other: https://paypal.me/nandovieira/🍕
+custom: ["https://www.paypal.me/nandovieira/🍕"]

data/.rubocop.yml

@@ -11,11 +11,16 @@ AllCops:
     - vendor/**/*
 
 Metrics/BlockLength:
-  Exclude:
-    - test/**/*
-    - "**/*.gemspec"
+  Enabled: false
 
 Metrics/ClassLength:
-  Exclude:
-    - test/**/*
-    - "**/*.gemspec"
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false

data/CHANGELOG.md

@@ -11,6 +11,36 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
+## Unreleased
+
+- [Fixed] Babel loader's order is backwards, so TypeScript first, then
+  JavaScript.
+
+## v0.0.5 - 2020-11-14
+
+- [Fixed] Jest configuration wasn't considering the full import path.
+
+## v0.0.4 - 2020-11-14
+
+- [Added] Generate
+  [dependabot](https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates)
+  configuration.
+- [Changed] Add Postgres env vars so tests can run smoothly.
+- [Added] Add helper method to create migration classes with `--active-record`.
+- [Added] Generate `.github/CODEOWNERS` template.
+- [Changed] Generate Ruby packages with `--type gem`
+- [Added] Generate NPM packages with `--type npm`.
+
+## v0.0.3 - 2020-11-03
+
+- [Changed] Remove unused `--repository` switch.
+- [Changed] Make `--help` and `-h` work with `dopstick new`.
+
+## v0.0.2 - 2020-11-02
+
+- [Fixed] Link added to gemspec's meta info now open the correct code browser.
+- [Fixed] Use correct key name for custom funding urls.
+
 ## v0.0.1 - 2020-11-02
 
 - Initial release.

data/CONTRIBUTING.md

@@ -38,7 +38,7 @@ your contribution is according to how this project works.
    "Unreleased" section. If this section is not available, create one right
    before the last version.
 5. Push to your branch - `git push origin my_branch`
-6. [Create a pull request](https://docs.github.com/articles/creating-a-pull-request)
+6. [Create a pull request](https://help.github.com/articles/creating-a-pull-request)
 7. That's it!
 
 ## Styleguides

data/README.md

@@ -1,18 +1,31 @@
-# dopstick
+<p align="center">
+  <a href="https://github.com/fnando/dopstick/">
+    <img width="250" src="https://github.com/fnando/dopstick/raw/main/dopstick.svg" alt="Dopstick">
+  </a>
+</p>
 
-[![Tests](https://github.com/fnando/dopstick/workflows/Tests/badge.svg)](https://github.com/fnando/dopstick)
-[![Code Climate](https://codeclimate.com/github/fnando/dopstick/badges/gpa.svg)](https://codeclimate.com/github/fnando/dopstick)
-[![Gem](https://img.shields.io/gem/v/dopstick.svg)](https://rubygems.org/gems/dopstick)
-[![Gem](https://img.shields.io/gem/dt/dopstick.svg)](https://rubygems.org/gems/dopstick)
+<p align="center">
+  Generate a project skeleton for creating a Ruby/Node package.
+</p>
 
-Generate a project skeleton for creating a rubygem.
+<p align="center">
+  <a href="https://github.com/fnando/dopstick"><img src="https://github.com/fnando/dopstick/workflows/Tests/badge.svg" alt="Tests"></a>
+  <a href="https://codeclimate.com/github/fnando/dopstick"><img src="https://codeclimate.com/github/fnando/dopstick/badges/gpa.svg" alt="Code Climate"></a>
+  <a href="https://rubygems.org/gems/dopstick"><img src="https://img.shields.io/gem/v/dopstick.svg" alt="Gem"></a>
+  <a href="https://rubygems.org/gems/dopstick"><img src="https://img.shields.io/gem/dt/dopstick.svg" alt="Gem"></a>
+</p>
 
-Includes:
+---
+
+Features:
 
 - Github templates
 - Changelog
-- ActiveRecord setup (via `--active-record`)
-- CLI setup (via `--bin NAME`)
+- Generate Ruby packages
+  + ActiveRecord setup (via `--active-record`)
+  + CLI setup (via `--bin NAME`)
+- Generate NPM packages
+  + Setup TypeScript, Jest, and more!
 
 ## Installation
 

data/dopstick.gemspec

@@ -8,13 +8,14 @@ Gem::Specification.new do |spec|
   spec.authors = ["Nando Vieira"]
   spec.email   = ["me@fnando.com"]
 
-  spec.summary     = "Generate a project skeleton for creating a rubygem"
+  spec.summary     = "Generate a project skeleton for creating a Ruby/NPM " \
+                     "package."
   spec.description = spec.summary
   spec.license     = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   github_url = "https://github.com/fnando/dopstick"
-  github_tree_url = "#{github_url}/blob/v#{spec.version}"
+  github_tree_url = "#{github_url}/tree/v#{spec.version}"
 
   spec.homepage = github_url
   spec.metadata["homepage_uri"] = spec.homepage

data/dopstick.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="2283" height="512" viewBox="0 0 2283 512"><g fill="none"><path fill="#E8546A" d="M220.504 9.988L10.5 129.992v252.004L220.504 502l210.004-120.004V129.992z"/><path fill="#C42B4C" d="M350.508 333.996v2.711l-130.004 71.988-130-71.988V175.281l130-71.988 130.004 71.988z"/><path fill="#000" d="M130.504 291.996c-5.52 0-10 4.48-10 10s4.48 10 10 10 10-4.48 10-10-4.48-10-10-10z"/><path fill="#000" d="M435.504 121.332l-.035-.023-210.004-120a10.061 10.061 0 0 0-9.922 0l-210.004 120-.035.023C2.5 123.062.5 126.363.5 129.992v252.004c0 6.067 5.023 8.633 5.125 8.73L215.543 510.68l.066.035a10.177 10.177 0 0 0 4.895 1.285c1.633 0 3.371-.43 4.894-1.285l.067-.035s209.902-119.946 209.914-119.95c3.254-2.367 5.129-4.171 5.129-8.734V129.992c0-.047-.008-.094-.008-.14-.047-3.665-2.102-6.856-4.996-8.52zm-205-94.11l180.215 102.981-58.063 34.84-122.152-67.645V27.223zm-20 0v70.176L88.352 165.043l-58.063-34.84 180.215-102.98zM20.5 147.653l60.004 36.004v144.676L20.5 364.336V147.652zm190.004 337.114L30.289 381.786l58.066-34.84 122.149 67.644v70.176zm10-87.5l-120-66.454V181.177l120-66.453 120.004 66.453v149.637l-120.004 66.453zm10 87.5V414.59l122.152-67.645 58.063 34.84-180.215 102.98zm190.004-120.43l-60-36.004V183.656l60-36.004v216.684z"/><path fill="#000" d="M175.66 162.422l-50.004 27.691a10.003 10.003 0 0 0-5.152 8.75v63.13c0 5.523 4.476 10 10 10 5.52 0 10-4.477 10-10v-57.24l44.844-24.835c4.832-2.676 6.582-8.762 3.906-13.59-2.676-4.832-8.762-6.578-13.594-3.906z"/><path fill="#434C50" d="M653.311 372c29.222 0 50.896-13.942 58.25-35.242h3.677v33.5H794V92h-78.762v102.628h-3.677c-7.354-21.3-29.028-34.855-58.25-34.855-45.283 0-74.311 34.08-74.311 98.174v15.491c0 63.9 29.028 98.562 74.311 98.562zm34.092-59C671.66 313 660 299.654 660 271.61v-11.412C660 232.346 671.66 219 687.403 219 703.145 219 715 232.152 715 260.198v11.411C715 299.654 703.145 313 687.403 313zm247.388 61C1000.648 374 1039 336.8 1039 269.569v-10.463C1039 198.656 1000.648 157 934.79 157 868.547 157 830 199.238 830 259.688v10.268C830 336.8 868.546 374 934.79 374zm-.195-57c-21.108 0-24.47-25.01-24.592-43.178L910 257.045c0-20.567 3.843-44.045 24.596-44.045 20.56 0 24.404 23.09 24.404 44.045v15.716c0 18.627-3.075 44.239-24.404 44.239zm217.237 122V336.107h3.874c8.135 21.315 28.86 35.267 58.108 35.267 45.518 0 74.185-33.523 74.185-98.63v-15.502c0-65.3-28.667-98.242-74.185-98.242-29.247 0-49.973 13.564-58.108 34.879h-3.874v-33.135H1073V439h78.833zm27.667-126c-15.603 0-27.5-13.346-27.5-41.39v-11.412c0-28.046 11.897-41.198 27.5-41.198 16.188 0 27.5 13.346 27.5 41.198v11.411c0 28.045-11.312 41.391-27.5 41.391zm230.438 61c64.28 0 98.062-28.288 98.062-73.044 0-35.262-20.848-52.7-58.297-59.481-4.36-.79-9.073-1.46-13.856-2.134l-4.317-.611-2.877-.42c-18.66-2.769-36.28-6.555-36.28-18.729 0-6.975 5.79-14.143 18.917-14.143 13.898 0 20.268 8.137 21.812 17.05h67.177c0-45.144-37.835-65.488-88.217-65.488-49.61 0-93.236 19.762-93.236 69.556 0 39.913 28.183 57.156 63.315 64.519 22.778 4.844 50.575 5.425 50.575 20.15 0 7.362-6.756 13.95-19.496 13.95-13.706 0-22.778-7.556-23.55-17.631H1314c0 37.006 30.5 66.456 95.938 66.456zm231.066-4c15.437 0 27.4-1.162 32.996-1.936v-55.182c-1.93.193-8.49.387-14.279.387-15.244 0-24.699-6.196-24.699-20.718v-73.189H1674v-58.086h-38.978V115h-75.061v46.276H1526v58.086h31.645v90.615c0 45.114 27.787 60.023 83.359 60.023zm114.593-227c22.144 0 40.403-13.349 40.403-35.597C1796 85.35 1777.741 72 1755.597 72 1733.26 72 1715 85.349 1715 107.403c0 22.248 18.259 35.597 40.597 35.597zM1794 370V161h-78v209h78zm138.801 4c51.577 0 95.813-24.219 96.199-87.188h-69.348c-.387 14.92-5.023 28.87-23.567 28.87-16.42 0-26.078-15.888-26.078-46.307V257.75c0-25.769 10.431-42.238 25.885-42.238 14.101 0 23.373 13.175 23.76 29.45H2029c-.386-52.506-36.51-87.962-95.813-87.962C1869.441 157 1831 197.881 1831 257.944v12.4C1831 338.93 1872.145 374 1932.801 374zm209.606-4v-65.582l8.112-11.608 42.293 77.19H2283l-71.455-119.364 66.434-89.184h-86.712l-44.997 75.835h-3.863V92H2064v278h78.407z"/></g></svg>

data/lib/dopstick.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
 
+require "json"
 require "date"
 require "pathname"
 require "thor"
 
 module Dopstick
-  require_relative "dopstick/refinements"
   require_relative "dopstick/version"
+  require_relative "dopstick/refinements"
   require_relative "dopstick/generator"
+  require_relative "dopstick/generator/options"
+  require_relative "dopstick/generator/gem/options"
+  require_relative "dopstick/generator/gem/generator"
+  require_relative "dopstick/generator/npm/options"
+  require_relative "dopstick/generator/npm/generator"
   require_relative "dopstick/cli"
 end

data/lib/dopstick/cli.rb

@@ -9,10 +9,14 @@ module Dopstick
       true
     end
 
-    desc "new PATH", "Create a new gem"
+    desc "new PATH", "Create a new package"
+    option :type,
+           default: "",
+           desc: "Set the package type you want to create. Must be one of " \
+                 "#{Generator.registered.keys.inspect}."
     option :name,
            default: "",
-           desc: "Set the gem name. Defaults to path's basename."
+           desc: "Set the package name. Defaults to path's basename."
     option :active_record,
            default: false,
            type: :boolean,
@@ -30,12 +34,9 @@ module Dopstick
            default: "",
            desc: "Set Paypal account for donations. Defaults to " \
                  "`git config user.paypal`."
-    option :repository,
-           default: "",
-           desc: "Set Github repository name. Defaults to gem name."
     option :description,
-           default: "",
-           desc: "Set gem description."
+           default: "TODO: add a description",
+           desc: "Set package description."
     option :version,
            default: "0.0.0",
            desc: "Set package initial version."
@@ -51,29 +52,64 @@ module Dopstick
            type: :array,
            desc: "Set Ruby versions that are officially supported. Multiple " \
                  "versions must separated by space."
-    def new(path)
-      options = dup_options
-      gem_name, namespace = expand_gem_name_and_namespace(path)
+    option :node_versions,
+           default: %w[14.x 12.x],
+           type: :array,
+           desc: "Set Node versions that are officially supported. Multiple " \
+                 "versions must separated by space."
+    option :skip_install,
+           default: false,
+           type: :boolean,
+           desc: "Skip `bundle install` (gem) and `yarn install` (npm)"
+    option :help,
+           aliases: "-h",
+           type: :boolean,
+           hide: true
+    def new(path = nil)
+      interrupt_with_help(:new) if options[:help] || path.to_s.strip.empty?
 
-      generator = Generator.new
+      unless Generator.registered.include?(options[:type])
+        interrupt_with_error(
+          "--type must be one of #{Generator.registered.keys.inspect}"
+        )
+      end
+
+      package_name, namespace = expand_gem_name_and_namespace(path)
+
+      generator_module = Generator.registered[options[:type]]
+      generator_class = generator_module.const_get(:Generator)
+      options_class = generator_module.const_get(:Options)
+      generator = generator_class.new
       generator.destination_root = File.expand_path(path)
-      generator.options = options.merge(
-        gem_name: gem_name,
-        namespace: namespace,
-        entry_path: namespace.underscore("/")
+      generator.options = options_class.new(
+        dup_options.merge(
+          package_name: package_name,
+          namespace: namespace,
+          entry_path: namespace.underscore("/")
+        )
       )
 
       generator.invoke_all
     end
 
     no_commands do
+      private def interrupt_with_help(command)
+        help(command)
+        exit
+      end
+
+      private def interrupt_with_error(message)
+        shell.say "ERROR: #{message}", :red
+        exit 1
+      end
+
       private def dup_options
         options.each_with_object({}) do |(key, value), buffer|
           buffer[key.to_sym] = value
         end
       end
 
-      private def expand_gem_name_and_namespace(path) # rubocop:disable Metrics/AbcSize
+      private def expand_gem_name_and_namespace(path)
         if options[:name].presence && options[:namespace].presence
           [options[:name], options[:namespace]]
         elsif options[:name].presence

data/lib/dopstick/generator.rb

@@ -1,214 +1,9 @@
 # frozen_string_literal: true
 
 module Dopstick
-  class Generator < Thor::Group # rubocop:disable Metrics/ClassLength
-    using Dopstick::Refinements
-
-    include Thor::Actions
-
-    def self.exit_on_failure?
-      true
-    end
-
-    attr_accessor :options
-
-    desc "Generate a new gem folder structure"
-
-    def self.source_root
-      File.join(__dir__, "templates")
-    end
-
-    def copy_gemspec
-      template "gemspec.erb", "#{gem_name}.gemspec"
-    end
-
-    def copy_license
-      template "license.erb", "LICENSE.md"
-    end
-
-    def copy_coc
-      template "coc.erb", "CODE_OF_CONDUCT.md"
-    end
-
-    def copy_readme
-      template "readme.erb", "README.md"
-    end
-
-    def copy_changelog
-      copy_file "CHANGELOG.md"
-    end
-
-    def copy_contributing
-      template "contributing.erb", "CONTRIBUTING.md"
-    end
-
-    def copy_github_templates
-      template "funding.erb", ".github/FUNDING.yml"
-      template "tests_workflow.erb", ".github/workflows/tests.yml"
-      template "bug_report.erb", ".github/ISSUE_TEMPLATE/bug_report.md"
-      template "feature_request.erb",
-               ".github/ISSUE_TEMPLATE/feature_request.md"
-      template "pull_request.erb", ".github/PULL_REQUEST_TEMPLATE.md"
-    end
-
-    def copy_rakefile
-      template "rakefile.erb", "Rakefile"
-    end
-
-    def copy_rubocop
-      template "rubocop.erb", ".rubocop.yml"
-    end
-
-    def copy_gitignore
-      template "gitignore.erb", ".gitignore"
-    end
-
-    def copy_gemfile
-      template "gemfile.erb", "Gemfile"
-    end
-
-    def copy_bins
-      template "console.erb", "bin/console"
-      template "setup.erb", "bin/setup"
-      in_root { run "chmod +x bin/*" }
-    end
-
-    def create_entry_file
-      if entry_path.include?("/")
-        template "gem_entry_file.erb", "lib/#{gem_name}.rb"
-      end
-
-      template "entry_file.erb", "lib/#{entry_path}.rb"
-    end
-
-    def create_version_file
-      template "version.erb", "lib/#{entry_path}/version.rb"
-    end
-
-    def copy_test_files
-      template "test_helper.erb", "test/test_helper.rb"
-      template "test_file.erb", "test/#{entry_path}_test.rb"
-    end
-
-    def copy_binary_files
-      return unless options[:bin].presence
-
-      template "cli.erb", "lib/#{entry_path}/cli.rb"
-      template "generator.erb", "lib/#{entry_path}/generator.rb"
-      template "bin.erb", "exe/#{options[:bin]}"
-      create_file "lib/#{entry_path}/templates/.keep"
-      in_root { run "chmod +x exe/*" }
-    end
-
-    def copy_active_record_files
-      return unless options[:active_record]
-
-      template "active_record.erb", "test/support/active_record.rb"
-    end
-
-    def initialize_repo
-      in_root do
-        run "git init --initial-branch=main", capture: true
-        run "git add .", capture: true
-        run "git add bin --force", capture: true
-      end
-    end
-
-    no_commands do # rubocop:disable Metrics/BlockLength
-      def gem_name
-        options[:gem_name]
-      end
-
-      def entry_path
-        options[:entry_path]
-      end
-
-      def user_name
-        @user_name ||= options[:author_name].presence ||
-                       `git config --global user.name`.chomp
-      end
-
-      def user_email
-        @user_email ||= options[:author_email].presence ||
-                        `git config --global user.email`.chomp
-      end
-
-      def github_user
-        @github_user ||= options[:author_github].presence || begin
-          user = `git config --global user.github`.chomp
-          user.empty? ? "[USER]" : user
-        end
-      end
-
-      def paypal_user
-        @paypal_user ||= options[:author_paypal].presence || begin
-          user = `git config --global user.paypal`.chomp
-          user.empty? ? "[USER]" : user
-        end
-      end
-
-      def github_url
-        "https://github.com/#{github_user}/#{gem_name}"
-      end
-
-      def ruby_versions
-        options[:ruby_versions]
-      end
-
-      def const_names
-        @const_names ||= options[:namespace].split("::")
-      end
-
-      def const_names_size
-        @const_names_size ||= const_names.size
-      end
-
-      def render_tree(skip_content_spaces = false, &block) # rubocop:disable Style/OptionalBooleanParameter
-        content = []
-
-        const_names.each_with_index do |name, count|
-          content << ("  " * count) + "module #{name}"
-        end
-
-        spacer = skip_content_spaces ? "" : "  "
-
-        content << (spacer * const_names_size) + block.call
-
-        (const_names_size - 1).downto(0) do |count|
-          content << "#{'  ' * count}end"
-        end
-
-        content.join("\n")
-      end
-
-      def erb(file)
-        ERB.new(File.read("#{__dir__}/templates/#{file}")).result binding
-      end
-
-      def render_cli
-        cli_class = erb("cli_class.erb")
-                    .chomp
-                    .gsub(/^(.)/m, "#{'  ' * const_names_size}\\1")
-
-        render_tree(true) { cli_class }
-      end
-
-      def render_generator
-        generator_class = erb("generator_class.erb")
-                          .chomp
-                          .gsub(/^(.)/m, "#{'  ' * const_names_size}\\1")
-
-        render_tree(true) { generator_class }
-      end
-
-      def oldest_ruby_version
-        version = options[:ruby_versions]
-                  .map {|v| Gem::Version.new(v) }
-                  .min
-                  .canonical_segments
-
-        [*version, 0].take(3).join(".")
-      end
+  module Generator
+    def self.registered
+      @registered ||= {}
     end
   end
 end