docs(gitpage): finish context api docs

apache · Mar 29, 2019 · 2b90d9b · 2b90d9b
1 parent d239fdf
commit 2b90d9b
Show file tree

Hide file tree

Showing 14 changed files with 71 additions and 13 deletions.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -2,18 +2,17 @@
 * [Getting Started](/getting-started)
 * [Plugin Development Guide](/plugin-development-guide)
 * [Context API](/context-api)
-  * [config](/toolbox-config)
-  * [open](/toolbox-open)
-  * [filesystem](/toolbox-fs)
-  * [semver](/toolbox-semver)
-  * [inquirer](/toolbox-inquirer)
-  * [http](/toolbox-http)
-  * [parameters](/toolbox-parameters)
-  * [print](/toolbox-logger)
-  * [strings](/toolbox-strings)
-  * [system](/toolbox-system)
-  * [template](/toolbox-template)
-  * [patching](/toolbox-patching)
+  * [parameters](/context-parameters)
+  * [config](/context-config)
+  * [open](/context-open)
+  * [filesystem](/context-fs)
+  * [semver](/context-semver)
+  * [inquirer](/context-inquirer)
+  * [http](/context-http)
+  * [print](/context-logger)
+  * [strings](/context-strings)
+  * [system](/context-system)
+  * [patching](/context-patching)
 * Tutorials
   * [Tutorial: Making a Extension](/tutorial-making-a-extension)
   * [Tutorial: Making a Plugin](/tutorial-making-a-plugin)

diff --git a/docs/context-api.md b/docs/context-api.md
@@ -1,3 +1,53 @@
 # Context API
 
-TODO
+Let's explore the inside of the Weex Toolkit "Context API".
+
+```js
+module.exports = {
+  name: 'dostuff',
+  alias: 'd',
+  run: async (context) => {
+    // great! now what?
+  },
+}
+```
+
+Here's what's available inside the `context` object you see all over Gluegun.
+
+| name           | provides the...                                    | 3rd party                      |
+| -------------- | -------------------------------------------------- | ------------------------------ |
+| **meta**       | information about the currently running CLI        |                                |
+| **config**     | configuration options from the app or plugin       |                                |
+| **fs** | ability to copy, move & delete files & directories | fs-jetpack                     |
+| **http**       | ability to talk to the web                         | apisauce                       |
+| **parameters** | command line arguments and options                 | yargs-parser                   |
+| **patching**   | manipulating file contents easily                  | fs-jetpack                     |
+| **print**      | tools to print output to the command line          | colors, ora                    |
+| **inquirer**     | tools to acquire extra command line user input     | inquirer                       |
+| **semver**     | utilities for working with semantic versioning     | semver                         |
+| **strings**    | some string helpers like case conversion, etc.     | lodash & ramda                 |
+| **system**     | ability to execute                                 | node-which, execa, cross-spawn |
+| **open**     | ability to open files                                 | open, chrome-opn |
+
+The `context` has "drawers" full of useful tools for building CLIs. For example, the `context.meta.version` function can be invoked like this:
+
+```js
+module.exports = {
+  name: 'dostuff',
+  alias: 'd',
+  run: async (context) => {
+    // use them like this...
+    context.logger.info(context.meta.version())
+
+    // or destructure!
+    const {
+      logger: { info },
+      meta: { version },
+    } = toolbox
+    info(version())
+  },
+}
+```
+
+To learn more about each tool, explore the rest of the `context-*.md` files in this folder.
+
diff --git a/docs/toolbox-config.md → docs/context-config.md b/docs/toolbox-config.md → docs/context-config.md
diff --git a/docs/toolbox-fs.md → docs/context-fs.md b/docs/toolbox-fs.md → docs/context-fs.md
diff --git a/docs/toolbox-http.md → docs/context-http.md b/docs/toolbox-http.md → docs/context-http.md
diff --git a/docs/toolbox-inquirer.md → docs/context-inquirer.md b/docs/toolbox-inquirer.md → docs/context-inquirer.md
diff --git a/docs/toolbox-logger.md → docs/context-logger.md b/docs/toolbox-logger.md → docs/context-logger.md
diff --git a/docs/toolbox-meta.md → docs/context-meta.md b/docs/toolbox-meta.md → docs/context-meta.md
diff --git a/docs/toolbox-open.md → docs/context-open.md b/docs/toolbox-open.md → docs/context-open.md
@@ -19,3 +19,12 @@ open('https://weex.io', 'chrome', (error) => {
   }
 })
 ```
+
+## chromeOpn
+
+Powered by [chrome-opn](https://www.npmjs.com/package/chrome-opn).
+
+```js
+const chromeOpn = context.chromeOpn
+chromeOpn('https://weex.io', null, false)
+```
diff --git a/docs/toolbox-parameters.md → docs/context-parameters.md b/docs/toolbox-parameters.md → docs/context-parameters.md
diff --git a/docs/toolbox-patching.md → docs/context-patching.md b/docs/toolbox-patching.md → docs/context-patching.md
diff --git a/docs/toolbox-semver.md → docs/context-semver.md b/docs/toolbox-semver.md → docs/context-semver.md
diff --git a/docs/toolbox-strings.md → docs/context-strings.md b/docs/toolbox-strings.md → docs/context-strings.md
diff --git a/docs/toolbox-system.md → docs/context-system.md b/docs/toolbox-system.md → docs/context-system.md