Headroom.FileType

This application can generate source code headers from templates for various type of source code files. Such headers are usually represented as a top level comment, the application must render such header with correct syntax. The FileType represents such type of source code file, which is recognized by this application and for which the license headers can be manipulated.

Documentation

data FileType

Represents supported type of source code file, where license headers may be added, replaced or removed.

Constructors

CSS

CSS source code file

Haskell

Haskell source code file

HTML

HTML source code file

Java

Java source code file

JS

JavaScript source code file

Scala

Scala source code file

Instances

Bounded FileType

Defined in Headroom.FileType

Methods

minBound :: FileType

maxBound :: FileType

Enum FileType

Defined in Headroom.FileType

Methods

succ :: FileType -> FileType

pred :: FileType -> FileType

toEnum :: Int -> FileType

fromEnum :: FileType -> Int

enumFrom :: FileType -> [FileType]

enumFromThen :: FileType -> FileType -> [FileType]

enumFromTo :: FileType -> FileType -> [FileType]

enumFromThenTo :: FileType -> FileType -> FileType -> [FileType]

Eq FileType

Defined in Headroom.FileType

Methods

(==) :: FileType -> FileType -> Bool

(/=) :: FileType -> FileType -> Bool

Ord FileType

Defined in Headroom.FileType

Methods

compare :: FileType -> FileType -> Ordering

(<) :: FileType -> FileType -> Bool

(<=) :: FileType -> FileType -> Bool

(>) :: FileType -> FileType -> Bool

(>=) :: FileType -> FileType -> Bool

max :: FileType -> FileType -> FileType

min :: FileType -> FileType -> FileType

Read FileType

Defined in Headroom.FileType

Methods

readsPrec :: Int -> ReadS FileType

readList :: ReadS [FileType]

readPrec :: ReadPrec FileType

readListPrec :: ReadPrec [FileType]

Show FileType

Defined in Headroom.FileType

Methods

showsPrec :: Int -> FileType -> ShowS

show :: FileType -> String

showList :: [FileType] -> ShowS

fileTypeByExt

Arguments

:: Text

file extension to search for

-> Maybe FileType

corresponding FileType (if found)

Returns FileType for given file extension (without dot).

>>> fileTypeByExt "hs"
Just Haskell

listExtensions

Arguments

:: FileType

FileType to list extensions for

-> [Text]

list of found file extensions

Lists all recognized file extensions for given FileType.

>>> listExtensions Haskell
["hs"]

fileTypeByName

Arguments

:: Text

textual representation of FileType

-> Maybe FileType

corresponding FileType (if found)

Reads FileType from its textual representation.

>>> fileTypeByName "haskell"
Just Haskell