https://github.com/dodevops/file-hierarchy

Turn an entire directory tree into a js-hierarchy node
https://github.com/dodevops/file-hierarchy

filesystem hierarchical hierarchy javascript js-hierarchy nodejs typescript

Last synced: about 2 months ago
JSON representation

Turn an entire directory tree into a js-hierarchy node

• Host: GitHub
• URL: https://github.com/dodevops/file-hierarchy
• Owner: dodevops
• Created: 2017-11-28T13:36:43.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-01-16T10:12:20.000Z (almost 7 years ago)
• Last Synced: 2024-10-13T16:09:40.804Z (3 months ago)
• Topics: filesystem, hierarchical, hierarchy, javascript, js-hierarchy, nodejs, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/file-hierarchy
• Size: 121 KB
• Stars: 1
• Watchers: 7
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# file-hierarchy - Turn an entire directory tree into a js-hierarchy node

[![Build Status](https://travis-ci.org/dodevops/file-hierarchy.svg?branch=master)](https://travis-ci.org/dodevops/file-hierarchy) [![Coverage Status](https://coveralls.io/repos/github/dodevops/file-hierarchy/badge.svg?branch=master)](https://coveralls.io/github/dodevops/file-hierarchy?branch=master)  [![npm](https://img.shields.io/npm/v/file-hierarchy.svg)](https://www.npmjs.com/package/file-hierarchy)

## Introduction

File-Hierarchy provides a JS-Hierarchy Node implementation, that turns a directory tree into a JS-Hierarchy tree using

the `scan`-method.

Every directory entry is processed and its statistics data is gathered and saved. You can traverse the tree using

JS-Hierarchy's standard `walk` feature.

Unlike JS-Hierarchy, this module is not available for the browser (like, duh!).

## Installation

Install the module using

    npm install file-hierarchy --save

If you're using Typescript, you might want to add the following typings:

    npm install @types/bluebird @types/loglevel @types/node --save-dev

## Usage

Typescript:

```typescript

import { FileNode, ScanOptions } from '../lib/FileNode'

new FileNode().scan(new ScanOptions('/my/path'))

  .then(

    fileNode => {

      console.log(fileNode.path)

    }

  )

```

Javascript:

```javascript

const fileHierarchy = require('file-hierarchy')

new fileHierarchy.FileNode().scan(new fileHierarchy.ScanOptions('/my/path'))

  .then(

    fileNode => {

      console.log(fileNode.path)

    }

  )

```

See the [API-docs](https://dodevops.github.io/file-hierarchy/) for details.

## Building

To test and build this package, simply use grunt:

    grunt test