Merge pull request #2 from jaebradley/add-language-client

Add language client

Author: jaebradley

.babelrc

@@ -2,12 +2,11 @@
   "presets": [
     "@babel/preset-env"
   ],
-  "env": {
-    "production": {
-      "presets": ["minify"]
-    }
-  },
   "ignore": [
     "node_modules"
+  ],
+  "plugins": [
+    "@babel/transform-runtime",
+    "@babel/transform-async-to-generator"
   ]
 }

.npmignore

@@ -7,3 +7,4 @@ src/
 test/
 *.test.js
 coverage/
+scripts/

README.md

@@ -0,0 +1,108 @@
+# GitHub Languages Client
+
+[![Build Status](https://travis-ci.org/jaebradley/github-languages-client.svg?branch=master)](https://travis-ci.org/jaebradley/github-languages-client)
+[![npm](https://img.shields.io/npm/dt/express.svg)](github-https://www.npmjs.com/package/github-languages-client-client)
+[![npm](https://img.shields.io/npm/v/npm.svg)](https://www.npmjs.com/package/github-languages-client)
+
+
+A `NodeJS` client to get languages GitHub knows about for [`Advanced Search`](https://github.com/search/advanced), for example.
+
+![advanced-search](https://imgur.com/TYoc7Qy.png)
+
+## Implementation
+
+`GitHub` maintains [a `linguist` repository](https://github.com/github/linguist) that contains [a `languages.yml` file](https://raw.githubusercontent.com/github/linguist/master/lib/linguist/languages.yml) that seems to represent the set of languages that `GitHub` knows about.
+
+I have [a script](~/scripts/getLanguages.js) that makes a request to [the `raw.githubusercontent` API for this file](https://raw.githubusercontent.com/github/linguist/master/lib/linguist/languages.yml), converts the `YAML` to `JSON`, `camelCases` fields (and adds in some default values), and writes the output to [the `src/languages.json`](~/src/languages.json) file.
+
+I then read from this file when instantiating the `GitHubLanguagesClient`.
+
+For fuzzy-searching, I use [the `fuse` library](http://fusejs.io/).
+
+## API
+
+### Constructor
+
+The default constructor parameters, used for fuzzy-searching, are
+
+```javascript
+{
+  maxPatternLength = 32,
+  caseSensitive = false,
+  includeScore = false,
+  shouldSort = true,
+  threshold = 0.6,
+  location = 0,
+  distance = 100,
+  minMatchCharLength = 1,
+}
+```
+
+The [`fuse.io` site](http://fusejs.io/) gives a good explanation of why and how these values are used.
+
+### `getAllLanguages`
+
+This `static` method returns the complete array of all languages available, and the metadata associated with each language.
+
+```javascript
+import GitHubLanguagesClient from 'github-languages-client';
+
+const allLanguages = GitHubLanguagesClient.getAllLanguages();
+```
+
+### `search`
+
+This `class` method returns fuzzy-search text matching on the language's name, aliases, and extensions.
+
+```javascript
+import GitHubLanguagesClient from 'github-languages-client';
+
+const matchingLanguages = GitHubLanguagesClient.get('JavaScript');
+
+// {
+//   type: 'programming',
+//   tmScope: 'source.js',
+//   aceMode: 'javascript',
+//   codemirrorMode: 'javascript',
+//   codemirrorMimeType: 'text/javascript',
+//   color: '#f1e05a',
+//   aliases: [ 'js', 'node', 'javascript' ],
+//   extensions:
+//     [ '.js',
+//       '._js',
+//       '.bones',
+//       '.es',
+//       '.es6',
+//       '.frag',
+//       '.gs',
+//       '.jake',
+//       '.jsb',
+//       '.jscad',
+//       '.jsfl',
+//       '.jsm',
+//       '.jss',
+//       '.mjs',
+//       '.njs',
+//       '.pac',
+//       '.sjs',
+//       '.ssjs',
+//       '.xsjs',
+//       '.xsjslib' ],
+//   filenames: [ 'Jakefile' ],
+//   interpreters: [ 'node' ],
+//   languageId: 183,
+//   name: 'JavaScript',
+//   wrap: 'false',
+//   searchable: 'true' },
+// { type: 'programming',
+//   color: '#00a6a6',
+//   extensions: [ '.ms', '.mcr' ],
+//   tmScope: 'source.maxscript',
+//   aceMode: 'text',
+//   languageId: 217,
+//   name: 'MAXScript',
+//   aliases: [ 'maxscript' ],
+//   wrap: 'false',
+//   searchable: 'true' },
+//   etc., etc.
+```