Skip to content

Qix-/wat

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

95 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wat

Your syntax nightmares are over.

Wat is nearing its launch, and you can help

Feel free to install and try Wat out. Wanted are suggestions on how to make Wat even more ridiculously easy to use and insanely helpful. All document contributions are welcome as well!

1.0 targets:

To do
  • Search commands implemented.
  • Preference commands implemented (syntax highlighting flavor, etc.).
  • Import / Export preference commands.
  • Raw command-line auto-completion implemented.
  • Change temp directory for all persistent local storage and configurations.
  • Finish readme / editing guidelines.
  • At least 20 complete libraries or languages documented.
  • Tests.
  • XO linting.
  • Suggestions? Wat is for you, and must be uncomprimisingly amazing.
Done
  • Babel transpiling.
  • Pass args into initial app call (i.e. make $ wat js array splice start up the application and return the results.)
  • Graceful exiting with CONTROL + C.

Finally, community-built cheat sheets for every coder, in every language and major framework. At the tip of your fingers.

Wat is an interactive app built to drastically reduce time spent searching for syntax and code usage questions. If you forgot how to write a CSS transition, simply type css transition. Wat finds what you want, providing exactly and only what you need: a basic description and usage samples.

Wat covers everything

Wat provides the only centralized source of syntax cheat sheets for every language and every major framework and library. If it has an API and is used by the community, it's supported here; be it jQuery, Go, React, Dragula or Rails.

It's smart

Wat combines a document index, edit-distance algorithms, tabbed auto-completion and common sense to make sure you get what you asked for. It auto-updates when the community adds content, and optimizes its performance based on the content you use most.

Wat shreds red tape like a frisky cat

Wat's content is not perfect, it isn't formal and it isn't pedantic. Wat doesn't aim to provide letter-perfect, offical documentation for languages. Work like that is in good hands.

If you're building a web browser, refer to W3C for specifications. Wat is targeted for the 99.99% of us who have the basic familiarity with a Library and simply need to look up API or usage samples.

It's easy

Wat was designed for ease. It takes you:

Contents

Made with ❤️ and a little secret sauce.

Install

Installation takes 60 seconds.

npm install -g wat

np-what? Oh, isn't that Node? I don't do Node.

Learn

This tour will show you how to use Wat in 5 minutes.

wat tour

Contribute

Help the community and submit a pull request within 15 minutes.

If you understand Markdown and are familiar with a language or library, you can contribute!

  1. Pick something you are passionate about.

  2. Read the contribution guidelines.

  3. Start!

Love Wat? Help spread the word. Every contribution helps the community even more.

Show off your repo Cheat Sheet on Wat

Made your project more accessible by contributing to Wat?

Show it off by copying the badge below into your README.md.

![Cheat Sheet on Wat](https://img.shields.io/badge/wat-cheat%20sheeted-blue.svg)

Projects now documented on Wat

Languages

JS

JS Front-End Frameworks
Node.js Frameworks

Chalk, RobotJS, Vantage

FAQ

Why Wat?

Because wat is forgetting the syntax to splice an Array for the 10th time.

Because wat is having to search js splice an array, sift through W3Schools and MSDN results, Command + Click three Stack Overflow tabs, close the first one, digest the second and then scroll to the answer to remember... again.

Because I would rather just type:

wat js array splice

Necessity is the mother of invention, and I needed this.

Sorry, I don't speak Node

Don't worry, it's really not a problem:

You're using a web browser, right? Web browsers interpret Javascript. You don't have to write JS to use a web browser. Node similarly interprets JS everywhere else. NPM is the package manager for Javascript.

Installation is easy and you really should do it: There's hundreds of incredible apps you'll be take advantage of without having to write a single line of Javascript.

Node installation links:

When done, open a terminal and type:

npm install --global wat

This automatically installs a software package from npmjs.com and makes the command wat recognized globally by your computer, so you just simply enter wat anywhere in your terminal. Easy, right? And you're still a proud [insert language here...] programmer.

You're ready to use it!

License

MIT

About

A unique end to syntax hell

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%