jekyll-tsc 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ea5560f47a48dbde778b57ec1f170b9c3570b3554e2babef0a19e581a0f34e3
+  data.tar.gz: 1a671aac61e08773b3e963451a0eb1f62e5bf6590dd3959f11049b72510780c5
+SHA512:
+  metadata.gz: 00e3916c10baad4f0a2704b6faad9ba93f6228b79f42bb0ea3ede0c4b10e0367a36188956b9e7151519eee97a9e4abda6e4f83966e51da5aea8b5261005ef2d3
+  data.tar.gz: bcda3a7c08938c2641505609183589ddb2f69ab5e471765d461725dcea0652b19ef1d175e0e443918f83e4346447c5734e7ebafd3ad29eff6126c1515843aa99

data/lib/jekyll/typescript/config.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Typescript
+    # module adding methods to access the config variables for this
+    # plugin from the users _config.yml.
+    #
+    # these methods are also expected to attach the default values for
+    # these options should they be unassigned.
+    #
+    module Config
+      def ts_extensions
+        @ts_extensions ||= Array(config['extensions']) || %w[.ts .tsx]
+      end
+
+      def copy_extensions
+        @copy_extensions ||= Array(config['copy_ext']) || []
+      end
+
+      def temp_dir
+        @temp_dir ||= config['temp_dir'] || '.typescript'
+      end
+
+      def tsc_command
+        @tsc_command ||= Array(config['command']) || ['tsc']
+      end
+
+      private
+
+      def config
+        @config ||= site.config['typescript']
+      end
+    end
+  end
+end

data/lib/jekyll/typescript/converter.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Typescript
+    # This class just makes jekyll change the extensions of any typescript
+    # files to .js.
+    #
+    # To see where the actual conversion takes place, see ./manager.rb
+    class TypescriptConverter < Jekyll::Converter
+      priority :low
+
+      def matches(ext)
+        Manager.instance.typescript_ext?(ext)
+      end
+
+      def output_ext(_)
+        '.js'
+      end
+
+      def convert(content)
+        content
+      end
+    end
+  end
+end

data/lib/jekyll/typescript/generator.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Typescript
+    # Generator to ensure Manager is aware of any typescript (or related)
+    # files it may need to process. This in affect forces typescript files
+    # to be processed, even when they lack front matter.
+    #
+    class TypescriptGenerator < Jekyll::Generator
+      def generate(site)
+        @site = site
+        Manager.instance.site ||= site
+        Manager.instance.static_files.clear
+
+        ts_files = []
+        site.static_files.each do |file|
+          if Manager.instance.typescript_file?(file)
+            ts_files << file
+          elsif Manager.instance.copy_file?(file)
+            Manager.instance.static_files << file
+          end
+        end
+
+        # turn any needed typescript files into regular pages.
+        site.static_files -= ts_files
+        site.pages += ts_files.map do |static_file|
+          base = static_file.instance_variable_get('@base')
+          dir  = static_file.instance_variable_get('@dir')
+          name = static_file.instance_variable_get('@name')
+          Jekyll::Page.new(@site, base, dir, name)
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/typescript/manager.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'fileutils'
+require 'shellwords'
+require_relative './config'
+require_relative './tsconfig'
+
+module Jekyll
+  module Typescript
+    # manages typescript
+    class Manager
+      SyntaxError = Class.new(ArgumentError)
+
+      include ::Singleton
+      include Config
+      include TSConfig
+
+      # whether :ext is associated with a typescript extension.
+      #
+      def typescript_ext?(ext)
+        ts_extensions.include? ext
+      end
+
+      # whether :ext is associated with an extension tsc will need
+      # in the compilation directory, eg. .js
+      #
+      def copy_ext?(ext)
+        typescript_ext?(ext) || copy_extensions.include?(ext)
+      end
+
+      # whether :page has a typescript extension.
+      #
+      def typescript_file?(page)
+        typescript_ext? File.extname(page.name).downcase
+      end
+
+      # whether :page has a copy_file extension.
+      #
+      def copy_file?(page)
+        copy_ext? File.extname(page.name).downcase
+      end
+
+      def setup
+        unless @setup
+          FileUtils.mkdir_p(temp_dir)
+          @setup = true
+        end
+      end
+
+      def static_files
+        @static_files ||= []
+      end
+
+      attr_accessor :site, :pages
+
+      # Typescript hook run before the site is rendered. This is used to reset
+      # the typescript pages array and to assign the site instance used for the
+      # compilation.
+      #
+      def pre_render(site, _)
+        self.site = site
+        @pages = []
+        Jekyll.logger.debug('Typescript', 'clearing out temporary build directory.')
+        FileUtils.rm_rf(Dir.glob(File.join(temp_dir, '*')))
+      end
+
+      # Typescript hook run after a page has been rendered. This is used to add a
+      # a page to typescripts memory if that page is needed for typescript
+      # compilation.
+      #
+      def add_page(page)
+        @pages << page if copy_ext? page.ext
+      end
+
+      # Once all the site files have been processed, compile and replace the content
+      # of any typescript files.
+      #
+      def post_render(*args)
+        setup
+
+        populate_temp_dir
+        @pages.each do |page|
+          next unless typescript_ext? page.ext
+
+          # change the output extension. it's a hack... but it works so good enough.
+          page.send(:_renderer).instance_variable_set(:@output_ext, '.js')
+
+          command = compile_command(in_temp_dir(page.relative_path))
+          Jekyll.logger.debug('Typescript') {
+            "running compile command: #{Shellwords.join(command[1..])}" }
+          compile_output = IO.popen(command, &:read).chomp # spawn a cmd & read process output.
+
+          unless $?.success?
+            raise SyntaxError, "typescript failed to convert: #{page.path}\n" + compile_output
+          end
+
+          output_file = File.join(temp_dir,
+                                  File.dirname(page.relative_path),
+                                  File.basename(page.relative_path, '.*') + '.js')
+
+          page.output = File.open(output_file, 'r', &:read)
+        end
+      end
+
+      private
+
+      # return :path but from the typescript temporary directory.
+      #
+      def in_temp_dir(path)
+        File.join(temp_dir, path)
+      end
+
+      # copy all of the pages in pages to this plugins temporary directory.
+      #
+      def populate_temp_dir
+        Dir.chdir(temp_dir) do
+          (@pages + static_files).each do |page|
+
+            if page.is_a?(StaticFile)
+              FileUtils.mkdir_p('./' + page.instance_variable_get(:@dir))
+              FileUtils.copy(site.in_source_dir(page.relative_path),
+                             './' + page.relative_path)
+            else
+              FileUtils.mkdir_p('./' + page.dir) # make temp container for file
+              File.open(page.relative_path, 'w') { |fd| fd.write(page.content) }
+            end
+          end
+        end
+      end
+
+      # get a tsc compile command for use with popen, append :args to the end of it.
+      #
+      def compile_command(*args)
+        [ENV, *tsc_command, '--pretty', '--rootDir', temp_dir, *tsconfig_args, *args]
+      end
+
+      # value of the tsconfig.json file as an array of command flags.
+      #
+      def tsconfig_args
+        unless @tsconfig_args
+          config_file = 'tsconfig.json'
+
+          @tsconfig_args = if File.exists?(config_file)
+                             parse_tsconfig(dumb_read_json(config_file))
+                           else
+                             Jekyll.logger.warn('Typescript', "no config file found at #{config_file}")
+                             []
+                           end
+        end
+
+        @tsconfig_args
+      end
+
+      Jekyll::Hooks.register(:site,  :pre_render,  &instance.method(:pre_render))
+      Jekyll::Hooks.register(:pages, :post_render, &instance.method(:add_page))
+      Jekyll::Hooks.register(:site,  :post_render, &instance.method(:post_render))
+    end
+  end
+end

data/lib/jekyll/typescript/tsconfig.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Typescript
+    # Module providing methods to aid in the parsing of tsconfig.json files.
+    #
+    # WARN, some of this file is basically me ranting about how absurd tsc
+    # and some of the general web app standards are, as a Unix lover.
+    #
+    module TSConfig
+      # Parse a tsconfig.json JSON object into an array of equivalent commands
+      # line flags.
+      #
+      # For some dumb reason, tsc just outright ignores your tsconfig.json file
+      # when you're compiling a single file, instead of a project. See issue
+      # 6591 on Microsoft/Typescript.
+      #
+      def parse_tsconfig(json)
+        args = []
+        json['compilerOptions'].each_pair do |option, value|
+          flag = "--#{option}"
+
+          case value
+          when TrueClass, FalseClass
+            args << flag if value
+          when String
+            args << flag
+            args << value
+          when Array
+            args << flag
+            args << value.join(',')
+          else
+            Jekyll.logger.warn('Typescript',
+                               "unknown option type for #{option} of type #{value.class}")
+          end
+        end
+        args
+      end
+
+      private
+
+      # read a json file at :path, but allow for comments in the file.
+      #
+      # RANT
+      # Why in the great stallmans name does everyone use JSON as a config
+      # format when it doesn't support comments?
+      #
+      # RANT
+      # Why in gods name does JSON forbid comments when their pretty much
+      # ubiquotous?
+      #
+      # Adding an option to most parsers to allow comments doesn't seem too
+      # unreasonable, I mean it's not like JSON is solely used as a web
+      # interchange format anymore.
+      #
+      def dumb_read_json(path)
+        File.open(path, 'r') do |file|
+          # regxp partially sourced from https://stackoverflow.com/questions/19910002/remove-comments-from-json-data
+          JSON.parse(file.read.gsub(/(?:\/\/[^\n]+$)|(?:\/\*(?:[^*]+|\*+(?!\/))*\*\/)/m, ''))
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/typescript/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Typescript
+    VERSION = '0.0.2'
+  end
+end

data/lib/jekyll_tsc.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative './jekyll/typescript/manager'
+require_relative './jekyll//typescript/generator'
+require_relative './jekyll/typescript/converter'

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-tsc
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Mohsin Kaleem
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: |
+  provides automatic compilation of typescript files to javascript
+  files for your jekyll blog.
+email: mohkalsin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll/typescript/config.rb
+- lib/jekyll/typescript/converter.rb
+- lib/jekyll/typescript/generator.rb
+- lib/jekyll/typescript/manager.rb
+- lib/jekyll/typescript/tsconfig.rb
+- lib/jekyll/typescript/version.rb
+- lib/jekyll_tsc.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: compile typescript files on your jekyll blog.
+test_files: []