json-directory: Load JSON from files in a directory structure

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]

Warnings:

These packages miss upper bounds: - aeson - attoparsec-aeson - bytestring - directory - filepath - mtl - process - text - unordered-containers Please add them, using `cabal gen-bounds` for suggestions. For more information see: https://pvp.haskell.org/

Load JSON from files in a directory structure. The object created mirrors the directory structure, using filenames as keys. Useful for breaking apart large JSON structures.

[Skip to Readme]

Properties

Versions	0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.0.3
Change log	CHANGELOG.md
Dependencies	aeson (>=2.2.2.0), attoparsec-aeson (>=2.2.2.0), base (>=4.11 && <5.0), bytestring, directory, filepath, json-directory, mtl, process, text, unordered-containers [details]
License	BSD-3-Clause
Copyright	(c) 2019 Luke Clifton
Author	Luke Clifton
Maintainer	lukec@themk.net
Category	Codec
Bug tracker	https://github.com/luke-clifton/json-directory/issues
Source repo	head: git clone https://github.com/luke-clifton/json-directory
Uploaded	by lukec at 2024-07-26T06:34:00Z

Modules

[Index] [Quick Jump]

Data
- JSON
  - Data.JSON.Directory

Downloads

json-directory-0.1.0.3.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

lukec

For package maintainers and hackage trustees

edit package information

Readme for json-directory-0.1.0.3

[back to package description]

JSON Directory

Provides utilities for reading JSON structures out of directories. Directory entries become keys in a map, and the values are sourced from the contets of each entry.

By default

Directories are recured into
Files ending with .json are read as JSON values
Everything else is interpreted as a string

However, these can be modified with rules, that allow for interpreting any sort of file as JSON.

The example directory in this repository would result in the following JSON value.

{
  "empty": {},
  "a": "This is files will have its contents written into a JSON string.\n",
  "d": {
    "example": "Sometimes it's convenient to embed some raw JSON"
  },
  "b": 42,
  "c": {
    "nested": "You can nest directories to create a tree structure.\n"
  }
}

`jsondir`

This package also includes an executable for turning directories into JSON blobs.

jsondir [--help] [--rule <SUFFIX> <FILTER> ...]
        [--[no-]default{s,-json,-text}] <ROOT> ...

  Turn a directory structure into a JSON value

 --rule <SUFFIX> <FILTER>     Filter the contents of files with the given
                              SUFFIX with FILTER. The default rules use .json
                              files as is, and treat everything else as strings.
                              Can be specified multiple times. Rule are tried in
                              the order specified.
 --[no-]defaults              Enable or disable the default rules. Default on.
 --[no-]default-json          Enable or disable the .json file rule
 --[no-]default-text          Enable or disable the raw file to JSON string rule.
 <ROOT>                       Directory root to turn into a JSON value

 EXAMPLE
  jsondir --rule '.yml' yaml2json ./my-dir