simple-vfs
v1.0.0
Published
Simple virtual file system, designed for file transformation pipelines
Readme
Simple virtual file system
Maintains a config object with dirs and files
this.config = {
opts,
dirs: {},
files: {}
}File operations
async copy(srcPath, targetPath)async fileExists(filePath)async makeDir(dirPath)async readFile(filePath)async writeFile(filePath, data)toString()returns lastWrittenfilePathclear()- clears file system
State
Maintains a lastWritten object which contains the last written file object (filePath and data)
Also maintains a files object, with entries for each file and a dirs object, with entries for each folder.
Copy
Copy will try to copy (via vfs writeFile) directly from vfs file via readFile.
If no such vfs file is present, it will copy "on disk" file content to target path in vfs (also via vfs writeFile).
Files
The files object has an entry for each file name generated. The value of each entry is a lastWritten object with filePath and data
async writeFile(filePath, data) {
let lastWritten = {
filePath,
data
}
this.config.files[filePath] = lastWritten
this.config.lastWritten = lastWritten
}Files entries
The files object would look like this:
{
'app/services/add/Readme.md': {
filePath: 'app/services/add/Readme.md'
data: 'addition'
},
'app/services/mul/Readme.md': {
filePath: 'app/services/mul/Readme.md'
data: 'multiplication'
}
}Testing
$ ava or $ npm test
Coverage tests
$ nyc ava or $ npm test:coverage
Scoped lerna
To update dependencies of a single project:
remove package.json.lock
Delete out all module dependencies in /node_modules
$ lerna clean --scope @tecla5/vfs
Bootstrap package, by installing/linking new modules
$ lerna bootstrap --scope @tecla5/vfs
This should also create a brand new package.json.lock
Lerna quick update
$ npm run lerna:update
# lerna info ...Update npm dependencies
Install CLI binary globally
npm i -g npm-check-updates
Update project dependencies:
$ ncu -ua
