hakyll-typescript: Typescript and javascript hakyll compilers.

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Provides typescript to javascript hakyll compilers and a js minifying hakyll compiler. This is a simple wrapper around other common utilities found in hakyll projects, particularly hjsmin.


[Skip to Readme]

Properties

Versions 0.0.1.0, 0.0.2.0, 0.0.2.0
Change log CHANGELOG.md
Dependencies base (>=4.7 && <5), bytestring (>=0.10.8.2 && <0.11), hakyll (>=4.12.0.0 && <4.14), hakyll-process (>=0.0.2.0 && <0.0.3), hjsmin (>=0.2.0.2 && <0.3) [details]
License BSD-3-Clause
Copyright 2019 Jim McStanton
Author Jim McStanton
Maintainer jim@jhmcstanton.com
Category web
Home page https://github.com/jhmcstanton/hakyll-typescript#readme
Source repo head: git clone https://github.com/jhmcstanton/hakyll-typescript
Uploaded by jhmcstanton at 2020-11-02T16:05:31Z

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees


Readme for hakyll-typescript-0.0.2.0

[back to package description]

hakyll-typescript

Hackage Badge

A simple hakyll typescript compiler for typescript and javascript resources. Uses hjsmin for compression.

Assumes that the typescript compiler is installed and available to the user running hakyll.

Example Usage

In your hakyll site simply import the compiler you are interested in using and provide it as the compiler for your relevant script files.

import Hakyll.Typescript.TS

main = hakyll $ do
  -- Matches any file inside the directory ./scripts
  match "scripts/**" $ do
    route   $ setExtension "js"
    -- compiles all typescript and javascript to the js target
    -- then compresses the result
    compile compressJtsCompiler

See the documentation for other available compilers.

Build the Source

This project uses stack. Clone the project, then run stack build from the root.

Build the Docs

For whatever reason stack haddock fails to pull down some necessary packages. To build the docs run stack exec haddock -- --html --hoogle --html-location=../$pkg-$version/ --hyperlinked-source --quickjump src/**/*.hs -o doc. The index will be found in ./doc/.