Skip to content
/ wtf.is Public

A CLI app that tell you what the fuck that file was supposed to do. API available too!

License

Notifications You must be signed in to change notification settings

louisgv/wtf.is

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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:

{
  "name" : "package.json"
}

For developer

  1. Coding:
  • All code should be in /src
  • Do npm link to install the cli
  • Run build -> profit
  1. Committing:
  • Use npm run commit instead of git commit (We're using comitizen)
  1. 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!

About

A CLI app that tell you what the fuck that file was supposed to do. API available too!

Resources

License

Stars

Watchers

Forks

Packages

No packages published