Shikensu

Shikensu.

See the README and tests for examples.

Documentation

forkDefinition :: FilePath -> Definition -> Definition

Fork a Definition.

list :: [String] -> FilePath -> IO Dictionary

Make a single dictionary based on a path to a directory and multiple glob patterns.

1. Compile patterns so globDir can use them.
2. Run globDir function on the given (root) path.
3. We get a list back for each pattern (ie. a list of lists), here we put each child list in a tuple along with its pattern.
4. We make a Dictionary out of each tuple (this also needs the path).
5. Merge the dictionaries into one dictionary.

list ["*.md"] "/root/articles"

listF :: FilePath -> [String] -> IO Dictionary

Flipped version of list.

listRelative :: [String] -> FilePath -> IO Dictionary

Same as list, but given a relative directory.

listRelative ["*.md"] "./articles"

listRelativeF :: FilePath -> [String] -> IO Dictionary

Flipped version listRelative.

makeDefinition :: FilePath -> String -> FilePath -> Definition

Make a Definition.

Example definition, given:

• the root path `/Users/icidasset/Projects/shikensu`
• the pattern `example/**/*.md`
• the absolute path `/Users/icidasset/Projects/shikensu/example/test/hello.md`

Definition
    { basename = "hello"
    , dirname = "test"
    , extname = ".md"
    , pattern = "example/**/*.md"
    , rootDirname = "/Users/icidasset/Projects/shikensu"
    , workingDirname = "example"

    , content = Nothing
    , metadata = HashMap.empty
    , parentPath = "../"
    , pathToRoot = "../../"
    }

makeDictionary :: FilePath -> (String, [FilePath]) -> Dictionary

Make a Dictionary.

module Shikensu.Internal.Types