k_director 0.8.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5784bc2f8f9ea89bac4e9d195ed607c1785d1f92281ff7ed553f9edf47d5c29f
-  data.tar.gz: cf9f19744ba09d4ef876a4114e4a4d52161d7355255c8393c726f78295ad44a5
+  metadata.gz: '080f78bce274be30bf0b77765c7fe6b40c56a9a5f40b385dd55ed96cd81b440b'
+  data.tar.gz: 7f12eeaf1ccdac94be739700260e30282766f85f9d4fad8f6e9cb81bd47359f0
 SHA512:
-  metadata.gz: b5ae842246267f476569e932922db59431a4e5af70c164968a51e12447ab34ef0300aca3f9b2cf0fbb1574ca98c14a8ad857978e7ca672a9bfe38c3d1a55c91c
-  data.tar.gz: 9b10d1b7ab087e22656a486439cf2c71cf7d9b8d93c3de87e6d3df49b71ad1156a90eb605f8dbe93246a83e3faea722572f64cb4e7bb6ceb30867736529485ab
+  metadata.gz: 20fb925316d432b16e5ac5b5074f5e2d86845225262dae2460962b51199555d757e889a8a3fdd62b86dab2f60b7f35c5892a875b530369b9d83268e52d657be2
+  data.tar.gz: 2e5d5485a94a94cbfa2a86110e7bea1a5af50b32febc51830d935b5e4592ddc1bcd9d4424044acbb3d0ec0b606197e1c674bac57e43ccd5386a70bd1a0663272

data/.builders/boot.rb

@@ -40,10 +40,10 @@ def dasherize
 end
 
 def k_builder
-  @k_builder ||= KBuilder::BaseBuilder.init(KBuilder.configuration(CONFIG_KEY))
+  @k_builder ||= KBuilder::BaseBuilder.init(KConfig.configuration(CONFIG_KEY))
 end
 
-KBuilder.configure(CONFIG_KEY) do |config|
+KConfig.configure(CONFIG_KEY) do |config|
   builder_folder    = Dir.pwd
   base_folder       = File.expand_path('../', builder_folder)
   global_template   = File.expand_path('~/dev/kgems/k_templates/templates')
@@ -58,7 +58,7 @@ KBuilder.configure(CONFIG_KEY) do |config|
   # config.target_folders.add(:database             , :data, 'database')
 end
 
-KBuilder.configuration(CONFIG_KEY).debug
+KConfig.configuration(CONFIG_KEY).debug
 
 area = KManager.add_area(CONFIG_KEY)
 resource_manager = area.resource_manager

data/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "cSpell.words": [
+    "postcss"
+  ]
+}

data/docs/CHANGELOG.md

@@ -1,3 +1,37 @@
+## [0.10.1](https://github.com/klueless-io/k_director/compare/v0.10.0...v0.10.1) (2022-02-06)
+
+
+### Bug Fixes
+
+* package_json, add set by group, remove and re ove by group ([93317f8](https://github.com/klueless-io/k_director/commit/93317f8b590ac2551e72072e93ca9b7f0d54f568))
+
+# [0.10.0](https://github.com/klueless-io/k_director/compare/v0.9.0...v0.10.0) (2022-02-06)
+
+
+### Bug Fixes
+
+* package_json set key converted to string and stripped ([784b33d](https://github.com/klueless-io/k_director/commit/784b33db2a045e8273e4e5a30747f0b05cc50cfd))
+
+
+### Features
+
+* add package_json dsl support to nuxt3 and rubygem ([9b4650d](https://github.com/klueless-io/k_director/commit/9b4650d48deaeb158ef25300b12f9de5725bf2c0))
+* add sort package json keys to package_json dsl ([90e2041](https://github.com/klueless-io/k_director/commit/90e2041759714faa1333c51226102e7ab8041a0a))
+
+# [0.9.0](https://github.com/klueless-io/k_director/compare/v0.8.1...v0.9.0) (2022-02-05)
+
+
+### Features
+
+* add package_json dsl support ([15b3ad7](https://github.com/klueless-io/k_director/commit/15b3ad7472a3374e646c391a7271fb7782636afe))
+
+## [0.8.1](https://github.com/klueless-io/k_director/compare/v0.8.0...v0.8.1) (2022-02-05)
+
+
+### Bug Fixes
+
+* add tests for package_json configuration ([d900065](https://github.com/klueless-io/k_director/commit/d900065bf810771841b97de03dfa9011c48c8e43))
+
 # [0.8.0](https://github.com/klueless-io/k_director/compare/v0.7.3...v0.8.0) (2022-02-04)
 
 

data/lib/k_director/directors/base_director.rb

@@ -59,6 +59,10 @@ module KDirector
         }.merge(opts)
       end
 
+      def configuration
+        k_builder.configuration
+      end
+
       def director_name
         @options.director_name
       end

data/lib/k_director/dsls/children/package_json.rb

@@ -17,14 +17,6 @@ module KDirector
 
           set_package_file('package.json')
           set_dependency_type(:development)
-
-          # defaults = {
-          #   repo_name: opts[:repo_name], # || parent.builder.dom&[:PackageJson]&[:repo_name]
-          #   username: opts[:username] || default_PackageJson_username, # || parent.builder.dom&[:PackageJson]&[:username]
-          #   organization: opts[:organization] # || parent.builder.dom&[:PackageJson]&[:organization]
-          # }
-
-          # parent.builder.group_set(:PackageJson, **repo_info_hash(**defaults))
         end
 
         # ----------------------------------------------------------------------
@@ -44,6 +36,304 @@ module KDirector
 
           self
         end
+
+        # Init an NPN package
+        #
+        # run npm init -y
+        #
+        # Note: npm init does not support --silent operation
+        def npm_init
+          run_command 'npm init -y'
+
+          load
+
+          self
+        end
+
+        # Space separated list of packages
+        def npm_install(packages, options: nil)
+          npm_add_or_install(packages, parse_options(options))
+
+          self
+        end
+        alias npm_i npm_install
+
+        def npm_add(packages, options: nil)
+          npm_add_or_install(packages, parse_options(options, '--package-lock-only --no-package-lock'))
+
+          self
+        end
+        alias npm_a npm_add
+
+        def npm_add_group(key, options: nil)
+          group = get_group(key)
+
+          puts "Adding #{group.description}"
+
+          npm_add(group.package_names, options: options)
+
+          self
+        end
+        alias npm_ag npm_add_group
+
+        # Add a group of NPN packages which get defined in configuration
+        def npm_install_group(key, options: nil)
+          group = get_group(key)
+
+          puts "Installing #{group.description}"
+
+          npm_install(group.package_names, options: options)
+
+          self
+        end
+
+        # Load the existing package.json into memory
+        #
+        # ToDo: Would be useful to record the update timestamp on the package
+        # so that we only load if the in memory package is not the latest.
+        #
+        # The reason this can happen, is because external tools such are
+        # npm install are updating the package.json and after this happens
+        # we need to call load, but if there is any bug in the code we may
+        # for get to load, or we may load multiple times.
+        def load
+          raise KDirector::Error, 'package.json does not exist' unless File.exist?(package_file)
+
+          # puts 'loading...'
+
+          content = File.read(package_file)
+          @package = JSON.parse(content)
+
+          self
+        end
+
+        # Write the package.json file
+        def write
+          # puts 'writing...'
+
+          content = JSON.pretty_generate(@package)
+
+          File.write(package_file, content)
+
+          self
+        end
+
+        # Remove a script reference by key
+        def remove_script(key)
+          remove(key, group: 'scripts')
+          # load
+
+          # @package['scripts']&.delete(key)
+
+          # write
+
+          self
+        end
+
+        # Add a script with key and value (command line to run)
+        def add_script(key, value)
+          set(key, value, group: 'scripts')
+
+          self
+        end
+
+        # ----------------------------------------------------------------------
+        # Attributes: Think getter/setter
+        #
+        # The following getter/setters can be referenced both inside and outside
+        # of the fluent builder fluent API. They do not implement the fluent
+        # interface unless prefixed by set_.
+        #
+        # set_: Only setters with the prefix _set are considered fluent.
+        # ----------------------------------------------------------------------
+
+        # Package
+        # ----------------------------------------------------------------------
+
+        # Load the package.json into a memory as object
+        def package
+          return @package if defined? @package
+
+          load
+
+          @package
+        end
+
+        # Package.set
+        # ----------------------------------------------------------------------
+
+        # Set a property value in the package
+        def set(key, value, group: nil)
+          load
+
+          key = key.to_s.strip
+
+          if group.nil?
+            @package[key] = value
+          else
+            group = group.to_s.strip
+            @package[group] = {} unless @package[group]
+            @package[group][key] = value
+          end
+
+          write
+
+          self
+        end
+
+        def remove(key, group: nil)
+          load
+
+          key = key.to_s.strip
+
+          if group.nil?
+            @package.delete(key)
+          else
+            group = group.to_s.strip
+            @package[group]&.delete(key)
+          end
+
+          @package['scripts']&.delete(key)
+
+          write
+
+          self
+        end
+
+        # Package.sort using `npx sort-package-json`
+        # ----------------------------------------------------------------------
+
+        # Sort the package.json keys using `npx sort-package-json`
+        def sort
+          run_command 'npx sort-package-json'
+
+          load
+
+          self
+        end
+
+        # Dependency option
+        # ----------------------------------------------------------------------
+
+        # Getter for dependency option
+        def dependency_option
+          dependency_type == :development ? '-D' : '-P'
+        end
+
+        # Dependency type
+        # ----------------------------------------------------------------------
+
+        # Fluent setter for target folder
+        # rubocop:disable Naming/AccessorMethodName
+        def set_dependency_type(value)
+          self.dependency_type = value
+
+          self
+        end
+        # rubocop:enable Naming/AccessorMethodName
+
+        # Package file
+        # ----------------------------------------------------------------------
+
+        # Fluent setter for package file
+        # rubocop:disable Naming/AccessorMethodName
+        def set_package_file(value)
+          self.package_file = value
+
+          self
+        end
+        # rubocop:enable Naming/AccessorMethodName
+
+        # Setter for package file
+        def package_file=(_value)
+          @package_file = File.join(k_builder.target_folder, 'package.json')
+        end
+
+        # Remove package-lock.json
+        # ----------------------------------------------------------------------
+
+        def remove_package_lock
+          file = File.join(k_builder.target_folder, 'package-lock.json')
+
+          File.delete(file) if File.exist?(file)
+
+          self
+        end
+
+        # Remove yarn.lock
+        # ----------------------------------------------------------------------
+
+        def remove_yarn_lock
+          file = File.join(k_builder.target_folder, 'yarn.lock')
+
+          File.delete(file) if File.exist?(file)
+
+          self
+        end
+
+        # Create yarn.lock
+        # ----------------------------------------------------------------------
+
+        def create_yarn_lock
+          run_command 'yarn install --check-files'
+
+          self
+        end
+
+        # -----------------------------------
+        # Helpers
+        # -----------------------------------
+
+        def parse_options(options = nil, required_options = nil)
+          options = [] if options.nil?
+          options = options.split if options.is_a?(String)
+          options.reject(&:empty?)
+
+          required_options = [] if required_options.nil?
+          required_options = required_options.split if required_options.is_a?(String)
+
+          options | required_options
+        end
+
+        def options_any?(options, *any_options)
+          (options & any_options).any?
+        end
+
+        def execute(command)
+          puts "RUN: #{command}"
+          run_command command
+          load
+        end
+
+        def npm_add_or_install(packages, options)
+          # if -P or -D is not in the options then use the current builder dependency option
+          options.push dependency_option unless options_any?(options, '-P', '-D')
+          packages = packages.join(' ') if packages.is_a?(Array)
+          command = "npm install #{options.join(' ')} #{packages}"
+          execute command
+        end
+
+        # # Debug method to open the package file in vscode
+        # # ToDo: Maybe remove
+        # def vscode
+        #   puts "cd #{output_path}"
+        #   puts package_file
+        #   run_command "code #{package_file}"
+        # end
+
+        private
+
+        def get_group(key)
+          group = configuration.package_json.package_groups[key]
+
+          raise KConfig::PackageJson::Error, "unknown package group: #{key}" if group.nil?
+
+          group
+        end
+
+        def run_command(command)
+          parent.k_builder.run_command(command)
+        end
       end
     end
   end

data/lib/k_director/dsls/children/package_json_configuration.rb

@@ -37,11 +37,35 @@ module KDirector
 
         # Setup the default package groups
         def set_default_package_groups
-          set_package_group('webpack'         , 'Webpack V5', %w[webpack webpack-cli webpack-dev-server])
-          set_package_group('swc'             , 'SWC Transpiler', %w[@swc/cli @swc/core swc-loader])
-          set_package_group('babel'           , 'Babel Transpiler', %w[@babel/core @babel/cli @babel/preset-env babel-loader])
-          set_package_group('typescript'      , 'Typescript', %w[typescript ts-loader])
-          set_package_group('semantic-release', 'Semantic Release', %w[semantic-release github:klueless-js/semantic-release-rubygem @semantic-release/changelog @semantic-release/git])
+          set_package_group('webpack'         , 'Webpack V5'                , %w[webpack webpack-cli webpack-dev-server])
+          set_package_group('swc'             , 'SWC Transpiler'            , %w[@swc/cli @swc/core swc-loader])
+          set_package_group('babel'           , 'Babel Transpiler'          , %w[@babel/core @babel/cli @babel/preset-env babel-loader])
+          set_package_group('typescript'      , 'Typescript'                , %w[typescript ts-loader])
+          set_package_group('semver-ruby'     , 'Semantic Release for Ruby' , %w[semantic-release github:klueless-js/semantic-release-rubygem @semantic-release/changelog @semantic-release/git])
+
+          set_package_group('semver-nuxt'     , 'Semantic Release for Nuxt' , %w[
+                              semantic-release
+                              @semantic-release/changelog
+                              @semantic-release/git
+                            ])
+
+          set_package_group('tailwind-nuxt'   , 'TailwindCSS for Nuxt'      , %w[
+                              tailwindcss@latest
+                              postcss@latest
+                              autoprefixer@latest
+                            ])
+
+          # this does not work yet
+          set_package_group('storybook-nuxt'  , 'Storybook for (Vite/Nuxt)' , %w[
+                              @storybook/vue3@6.4.18
+                              @storybook/addon-postcss@2.0.0
+                              @storybook/addon-storysource@6.4.18
+                              storybook-builder-vite
+                            ])
+
+          # Currently these two need to be foreced
+          # @storybook/addon-docs@6.4.18
+          # @storybook/addon-essentials@6.4.18
         end
 
         def debug

data/lib/k_director/dsls/nuxt3_dsl.rb

@@ -10,14 +10,21 @@ module KDirector
 
       def github(**opts, &block)
         github = KDirector::Dsls::Children::Github.new(self, **opts)
-        github.instance_eval(&block)
+        github.instance_eval(&block) if block_given?
+
+        self
+      end
+
+      def package_json(**opts, &block)
+        package_json = KDirector::Dsls::Children::PackageJson.new(self, **opts)
+        package_json.instance_eval(&block) if block_given?
 
         self
       end
 
       def blueprint(**opts, &block)
         blueprint = KDirector::Dsls::Children::Blueprint.new(self, **opts)
-        blueprint.instance_eval(&block)
+        blueprint.instance_eval(&block) if block_given?
 
         self
       end

data/lib/k_director/dsls/ruby_gem_dsl.rb

@@ -15,6 +15,13 @@ module KDirector
         self
       end
 
+      def package_json(**opts, &block)
+        package_json = KDirector::Dsls::Children::PackageJson.new(self, **opts)
+        package_json.instance_eval(&block) if block_given?
+
+        self
+      end
+
       def blueprint(**opts, &block)
         blueprint = KDirector::Dsls::Children::Blueprint.new(self, **opts)
         blueprint.instance_eval(&block) if block_given?

data/lib/k_director/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KDirector
-  VERSION = '0.8.1'
+  VERSION = '0.10.2'
 end

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "k_director",
-  "version": "0.8.1",
+  "version": "0.10.2",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "k_director",
-      "version": "0.8.1",
+      "version": "0.10.2",
       "devDependencies": {
         "@klueless-js/semantic-release-rubygem": "github:klueless-js/semantic-release-rubygem",
         "@semantic-release/changelog": "^6.0.1",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "k_director",
-  "version": "0.8.1",
+  "version": "0.10.2",
   "description": "Command line and CI/CD tools for k_director",
   "scripts": {
     "release": "semantic-release"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_director
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.10.2
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-05 00:00:00.000000000 Z
+date: 2022-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k_config
@@ -100,6 +100,7 @@ files:
 - ".releaserc.json"
 - ".rspec"
 - ".rubocop.yml"
+- ".vscode/settings.json"
 - Gemfile
 - Guardfile
 - README.md