What the fuck is this?
It basically tell you what the fuck is that file, what it is suppose to do, and how to open/work with it.
This program uses the following feature to identify a file:
+ File meta-data (name, type, etc)
+ Current directory
+ Sibling files
+ Sibling directories
+ File content (must specified if allowed or not. Default: false
At the end, it will return a description, which if called via the public api, will return this JSON:
For developer
- Coding:
- All code should be in
/src
- Do
npm link
to install the cli - Run build -> profit
- Committing:
- Use
npm run commit
instead ofgit commit
(We're using comitizen)
- Publishing:
- Do a PR.
Source Order:
- ./package.json
- ./bin
- ./src/api/FileSystem.js
- ./src/api/index.js
- ./src/cli/Terminal.js
- ./src/cli/Content.js
- ./src/cli/index.js
NOTE: This is a guide to Read and Partially understand this repos. Just go through them in this order. If you asked why, then the reason is probably because you are not a main contributor of this repo, Dood!
License
MIT, dood!