https://github.com/louisgv/wtf.is

A CLI app that tell you what the fuck that file was supposed to do. API available too!
https://github.com/louisgv/wtf.is

Last synced: 7 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/louisgv/wtf.is
• Owner: louisgv
• License: mit
• Created: 2017-02-20T03:13:11.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-06-04T03:01:05.000Z (over 7 years ago)
• Last Synced: 2024-12-23T17:36:38.919Z (19 days ago)
• Language: JavaScript
• Size: 111 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# 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:

```json

{

  "name" : "package.json"

}

```

## For developer

1. Coding:

  - All code should be in `/src`

  - Do `npm link` to install the cli

  - Run build -> profit

2. Committing:

  - Use `npm run commit` instead of `git commit` (We're using comitizen)

3. 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!