0.5.0 • Published 2 years ago
fakefilesystem v0.5.0
FakeFileSystem.js 💾
library to simulate a simple file system in javascript 💾
JsDelivr
<script src="https://cdn.jsdelivr.net/gh/SkwalExe/FakeFileSystem.js@v0.5.0/dist/ffs.min.js"></script>
Usage 📝
The module can be used in Node.js or in the browser.
npm install --save fakefilesystem
const FFS = require('fakefilesystem');
var myFFS = new FFS();
Wiki 📖
To learn more about how to use the module, check out the wiki. It contains very much a lot of informations
final
If you have any problem, don't hesitate to open an issue
Contributing
Start by forking this repository
Then clone your fork to your local machine.
git clone https://github.com/your-username/FakeFileSystem.js.git
Install dev dependencies
npm install --save-dev
Create a new branch
git checkout -b super-cool-feature
Then make your changes
Run tests
npm test
Update the changelog and version number if needed (using Semantic Versioning)
# bug fix npm version patch --no-git-tag-version # add a new feature npm version minor --no-git-tag-version # changes that break backwards compatibility npm version major --no-git-tag-version
List and correct linting errors
npm run lint
Update the minified version of the library
npm run build
Once you're done, commit your changes and push them to the remote repository.
git add --all git commit -m "Add super-cool-feature" git push origin super-cool-feature
Then, open a pull request on GitHub from your fork.
- Go to this link
- Click compare across forks
- On the right, on
head repository
select your fork - And on
compare
select the branch you just created - Click on
Create Pull Request
and submit your pull request