# wtf.is

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

Latest version **0.6.0** (published 2017-03-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install wtf.is
pnpm add wtf.is
yarn add wtf.is
bun add wtf.is
```

Provides the command `wtf`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.0 |
| Published | 2017-03-12 |
| First published | 2017-02-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | L |
| Maintainers | louisgv |
| Keywords | WTF, is |

## Links

- npm: https://www.npmjs.com/package/wtf.is
- Repository: https://github.com/louisgv/wtf-is
- Homepage: https://github.com/louisgv/wtf-is#readme
- Issues: https://github.com/louisgv/wtf-is/issues
- npm.io page: https://npm.io/package/wtf.is

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [blessed](https://npm.io/package/blessed.md) ^0.1.81
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^1.6.3
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.23.0

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 0.6.0 (latest) — 2017-03-12
- 0.5.0 — 2017-03-11
- 0.4.0 — 2017-03-11
- 0.3.0 — 2017-03-10
- 0.2.0 — 2017-03-01
- 0.1.0 — 2017-02-27
- 0.0.0 — 2017-02-21
- 0.0.0-development — 2017-02-21
- 1.0.0 — 2017-02-20

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

---
_Source: https://npm.io/package/wtf.is · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._