Fileable Components

Components for use with Fileable.

List of Fileable components

• File - create files
• Folder - create folders and archives
• Clear - remove files and folders

Creating a Fileable Component

Creating fileable components is easy provided that components meet the following criteria.

1. Must be an asynchronous iterator yielding objects conforming to the "Fileable Component Protocol" (see below)

2. Must have key 'FILEABLE COMPONENT' equal to true.

Note: this repository exports a convenience method, createComponent, to make this easier.

import {createComponent} from 'fileable-components';
const prototypeCompoent = async function *(){
    //...
}
export default createComponent(prototypeCompoent);

Fileable Component Protocol

Fileable components must yield directives. Directives are object which are objects that have a 'directive' key, along with other keys, that and tell the renderer how to render the file tree.

Directive: FILE

The FILE directive has a 'directive' key set to 'FILE'. It's used to create files.

See the above File component for an example.

key: name

Name of file to create.

key: content

Content of file to create.

key: mode

Mode of file to create.

key: append

If set to true, content will be added to a file. Othewise, content will be ovewrwriten.

key: folder_context

Context in which to create file.

Directive: FOLDER

The FOLDER directive has a 'directive' key set to 'FOLDER'. It's used to create folders.

See the above Folder component for an example.

key: name

Name of folder to create.

key: folder_context

Context in which to create folder.

Directive: CLEAR

The CLEAR directive has a 'directive' key set to 'CLEAR'. It's used to delete files and folders.

See the above Clear component for an example.

key: target

String representing files or folders to delete. May be a glob. May use '!' to negate files.

API

Table of contents

Todo

• remove unnecessary dependencies
• add proper typescript typeings
• create template component