isotropy-ast-analyzer-fs v0.0.5

Isotropy AST Analyzer for FS

This module abstracts AST analysis for common filesystem operations so that they don't have to be repeated in every filesystem plugin. This is part of the isotropy framework (www.isotropy.org).

Create a module "fs.js" containing an array that mocks the filesystem. The filename can be changed in configuration.

//In fs.js
export default [
  {
    { dir: "pictures", filename: "stock_photo1.jpg", contents: "FF D8 FF ..." },
    { dir: "trash", filename: "not-passwords.txt", contents: "thisisnotpassword" }
  }
]

Create a file

import myFs from "./my-fs.js";

async function createFile() {
  myFs.docs = myFs.docs.concat({
    dir: "documents",
    filename: "report.txt",
    contents: "hello, world"
  });
}

Read a file

import myFs from "./my-fs.js";

async function readFile() {
  return myFs.docs.find(file => file.dir === "/some/path" && file.filename === "report.txt");
}

Get all files in a directory

import myFs from "../my-fs";

async function getFiles() {
  return myFs.docs.filter(file => file.dir === "/some/path");
}

Get all files in a directory recursively down to the last level of directories

import myFs from "../my-fs";

async function getFiles() {
  return myFs.docs.filter(
    file => file.dir === "/some/path" || file.dir.startsWith("/some/path/")
  );
}

Update a file

import myFs from "./my-fs.js";

async function updateFile() {
  myFs.docs = myFs.docs.map(
    file =>
      file.dir === "documents" && file.filename === "report.txt"
        ? { ...file, contents: "hello, universe" }
        : file
  );
}

Delete a file

import myFs from "../my-fs";

async function deleteFile() {
  myFs.docs = myFs.docs.filter(
    file => !(file.dir === "documents" && file.filename === "report.txt")
  );
}

Delete a directory

import myFs from "../my-fs";

async function deleteDir() {
  myFs.docs = myFs.docs.filter(file => !(file.dir === "documents"));
}

Move a file

import myFs from "../my-fs";

async function moveFile() {
  myFs.docs = myFs.docs.map(
    file =>
      file.dir === "documents" && file.filename === "report.txt"
        ? { ...file, dir: "reports", filename: "report.txt" }
        : file
  );
}

Move a directory

import myFs from "../my-fs";

async function moveFile() {
  myFs.docs = myFs.docs.map(
    file => (file.dir === "documents" ? { ...file, dir: "reports" } : file)
  );
}