Merge pull request latticework#121 from latticework/v0.1.0

latticework#120 Project Documentation 🔨
surgeforward · Mar 3, 2017 · 76e3090 · 76e3090
2 parents cf0e6a2 + 0e64f69
commit 76e3090
Show file tree

Hide file tree

Showing 15 changed files with 746 additions and 70 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -2,11 +2,11 @@
 [//]: # ( <!-- markdownlint-disable no-duplicate-header -->            )
 [//]: # (                                                              )
 [//]: # (Keep lines to 72 characters to leave room for the preview     )
-[//]: # (pane.                                                         )
+[//]: # (pane while editing.                                           )
 [//]: # (Note: Comment format explained by:                            )
 [//]: # (http://stackoverflow.com/a/32190021                           )
 
-> Important: Following the [ISSUE-TEMPLATE-INSTRUCTIONS.md](https://github.com/latticework/jali/blob/master/ISSUE-TEMPLATE-INSTRUCTIONS.md),
+> Important: Following the [ISSUE-TEMPLATE-INSTRUCTIONS.md](https://github.com/latticework/jali/blob/master/project/ISSUE-TEMPLATE-INSTRUCTIONS.md),
 > choose the appropriate template form, `Question`, `Idea`, `Bug`,
 > `Enhancement`, or `Epic`. Delete the other forms, and fill out the
 > remaining form according to the instructions.
@@ -49,29 +49,79 @@
 ## Desired Behavior
 
 
+[//]: # ( ############################################################ )
+[//]: # ( # FORM: Task                                                 )
+# Task: `<Task-type-name>`
+
+- Parent: #NNN (▶️️|🐞)
+
+## Details
+
+
 [//]: # ( ############################################################ )
 [//]: # ( # FORM: Enhancement                                          )
 # Enhancement `<commit-type-name>`
 
+[//]: # ( Item Links )
+
+- Replaces #ISSUE
+- Completed by #PULL
+- Replaced by #ISSUE
+
+
 ## Definition
+[//]: # ( User Story )
 [//]: # ( Format follows http://blog.crisp.se/2014/09/25/david-evans/as-a-i-want-so-that-considered-harmful)
-In order to ...,
+**In order to** …,
+
+**As a** `<persona-name>`,
+
+**I want to** …(,
+
+**Whereas currently** …).
+
+[//]: # ( Job Story )
+[//]: # ( Format follows https://jtbd.info/replacing-the-user-story-with-the-job-story-af7cdee10c27)
+**In order to** …,
+
+**When** …,
+
+**The system should** …(,
+
+**Whereas currently** …).
+
+## Features
+
+[//]: # ( In a replacement Enhancement, copy the Features section of )
+[//]: # ( the replaced Enhancement and remove check boxes in the )
+[//]: # ( Features section. Make appropriate changes and record those )
+[//]: # ( changes in the sections below: New Features and Changed )
+[//]: # ( Features )
+
+- [ ] Feature 1
+- [ ] Feature 2
+
+[//]: # ( Include this section for replacement Enhancements )
+## New Features [feat]
 
-As a ...,
+- [ ] Feature 1
+- [ ] Feature 2
 
-I want to ...(,
+[//]: # ( Include this section for replacement Enhancements )
+## Changed Features [change]
 
-Whereas currently ...).
+- [ ] Changed Feature 1
+- [ ] Removed Feature 2
 
 ## Tasks
 
-- [ ] Task 1.
-- [ ] Task 2.
+- [ ] Task 1
+- [ ] Task 2 (#ISSUE)
 
 ## Acceptance Criteria
 
-- [ ] Criterion 1.
-- [ ] Criterion 2.
+- [ ] Criterion 1
+- [ ] Criterion 2
 
 [//]: # ( ############################################################ )
 [//]: # ( # FORM: Epic                                                 )

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -4,6 +4,7 @@
   "files.exclude": {
     "**/.git": true,
     "**/.svn": true,
+    "**/.hg": true,
     "**/.DS_Store": true
   },
   "files.eol": "\n",

diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -2,48 +2,53 @@
   // See https://go.microsoft.com/fwlink/?LinkId=733558
   // for the documentation about the tasks.json format
   "version": "0.1.0",
-  "command": "npm",
   "isShellCommand": true,
   "showOutput": "always",
   "suppressTaskName": true,
   "tasks": [
     {
       "taskName": "build",
+      "command": "npm",
       "args": ["run", "build"],
       "isBuildCommand": true,
-      "isWatching": false,
+      "isBackground": true,
       "problemMatcher": [
           "$tsc"
       ]
     },
     {
       "taskName": "build:test",
+      "command": "npm",
       "args": ["run", "build:test"],
       "isBuildCommand": true,
-      "isWatching": false,
+      "isBackground": true,
       "problemMatcher": [
           "$tsc"
       ]
     },
     // http://shripalsoni.com/blog/configure-eslint-in-visual-studio-code/
     {
       "taskName": "lint",
+      "command": "npm",
       "args": ["run", "build"],
       "problemMatcher": [
           "$eslint-stylish"
       ]
     },
     {
       "taskName": "install",
+      "command": "npm",
       "args": ["install"]
     },
     {
       "taskName": "update",
+      "command": "npm",
       "args": ["update"]
     },
     {
       "taskName": "test",
+      "command": "npm",
       "args": ["run", "test"]
     }
   ]
-}
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,224 @@
+# Jali Change Log
+
+<!-- markdownlint-disable line-length -->
+
+> For future changes see [ROADMAP.md](./project/ROADMAP.md).
+
+## [Unreleased v0][unreleased-v0]
+
+## [v0.1.0][v0.1.0] (2017-02-DD)
+
+- Items
+  - [All][milestone-0.1.0]
+  - [Enhancements][milestone-0.1.0-feat]
+  - [Bugs][milestone-0.1.0-fix]
+  - [PRs][milestone-0.1.0-pr]
+- New Features [feat]
+  - Project Documentation ▶️️ 🔨              [\[devenv\]][devenv] [#120][#120] ([#121][#121] — [xxxxxxx][xxxxxxx] — [@clavecoder][@clavecoder])
+    - CHANGELOG.md
+    - project/CHANGELOG-TEMPLATE.md
+    - project/PROCEDURES.md
+    - project/QUERIES.md
+- Changed Features [change]
+  - Project Documentation ▶️️ 🔨              [\[devenv\]][devenv] [#120][#120] ([#121][#121] — [xxxxxxx][xxxxxxx] — [@clavecoder][@clavecoder])
+    - Changed supporting documents
+      - to project/CREDITS.md
+      - to project/DESIGN.md
+      - to project/ISSUE-TEMPLATE-INSTRUCTIONS.md
+- Bug Fixes [fix]
+  - Fix Known Test Failures 🐞 🔧       [\[jali-util\]][jali-util] [#103][#103] ([#104][#104] — 2 commits — [@clavecoder][@clavecoder])
+    - @jali-ms/util/src/iterables_reduce
+      - `initialValue` can now be `null` or `undefined`
+    - @jali-ms/util/src/iterables_slice
+      - `begin` and `end` can now be `null` or `undefined`
+    - @jali-ms/util/src/iterables_slice
+      - now works if `begin` or `end` is negative
+  - Bad scope in doc links 🐞 🔧                      [\[doc\]][doc] [#92][#92] ([#98][#98] — [69fecf5][69fecf5] — [@clavecoder][@clavecoder])
+  - Manual page garbled for esdoc 0.5.x 🐞 🔧         [\[doc\]][doc] [#80][#80] ([#101][#101] — [1c6adb1][1c6adb1] — [@clavecoder][@clavecoder])
+  - Mute Status Check Issue 🐞 🔨             [\[devenv\]][devenv] [#110][#110] ([#111][#111] — [d8462b9][d8462b9] — [@clavecoder][@clavecoder])
+  - Fix bitHound Issues 🐞 🔨                 [\[devenv\]][devenv] [#105][#105] ([#106][#106] — 7 commits — [@clavecoder][@clavecoder])
+  - Bad Contributing Document Formatting 🐞 🔨  [\[devenv\]][devenv] [#96][#96] ([#97][#97] — [c876ec1][c876ec1] — [@clavecoder][@clavecoder])
+  - Bad README Links 🐞 🔨                      [\[devenv\]][devenv] [#91][#91] ([#97][#97] — [c876ec1][c876ec1] — [@clavecoder][@clavecoder])
+  - Enhancement link broken 🐞 🔨               [\[devenv\]][devenv] [#85][#85] ([#97][#97] — [c876ec1][c876ec1] — [@clavecoder][@clavecoder])
+
+## [v0.0.1][v0.0.1] (2017-01-15)
+
+- Items
+  - [All][milestone-0.0.1]
+  - [Enhancements][milestone-0.0.1-feat]
+  - Bugs *(none)*
+  - [PRs][milestone-0.0.1-pr]
+- New Features [feat]
+  - [JS] Argument validation functions ▶️️ 𝍖  [\[jali-util\]][jali-util] [#90][#90] ([#7][#7] — [53ac8ab][53ac8ab] — [@clavecoder][@clavecoder])
+    - validation functions
+      - verifyArgument
+      - verifyArray
+      - verifyBoolean
+      - verifyDefined
+      - verifyFunction
+      - verifyIterable
+      - verifyNonEmpty
+      - verifyNonZero
+      - verifyNotNull
+      - verifyNotWhitespace
+      - verifyNumber
+      - verifyObject
+      - verifyString
+      - verifyTrue
+      - verifyTruthy
+    - util/errors module
+  - [JS] Iterator Functions ▶️️ 𝍖             [\[jali-util\]][jali-util] [#87][#87] ([#7][#7] — [53ac8ab][53ac8ab] — [@clavecoder][@clavecoder])
+    - Iterable functions
+      - asArray
+      - asIterable
+      - concat
+      - every
+      - filter
+      - find
+      - includes
+      - map
+      - reduce
+      - slice
+      - some
+      - toMap
+    - util/iterables module
+  - [JS] @jali-ms/util Type Guards ▶️️ 𝍖      [\[jali-util\]][jali-util] [#86][#86] ([#7][#7] — [53ac8ab][53ac8ab] — [@clavecoder][@clavecoder])
+    - Type guards
+      - isError
+      - makeIsIterable: Generates deep-checking type guard for iterable of given type
+      - isIterable\<T\>
+    - util/type-guards module
+  - [JS] Invalid State Error ▶️️ 𝍖            [\[jali-util\]][jali-util] [#84][#84] ([#7][#7] — [53ac8ab][53ac8ab] — [@clavecoder][@clavecoder])
+    - InvalidStateError type. Subclass of Error.
+    - util/errors module
+  - [JS] Argument Errors ▶️️ 𝍖                [\[jali-util\]][jali-util] [#83][#83] ([#7][#7] — [53ac8ab][53ac8ab] — [@clavecoder][@clavecoder])
+    - Error types
+      - Argument error are subclasses of more general error types.
+      - ArgumentError. Subclass of Error
+      - ArgumentFalsyError. Subclass of ArgumentError
+      - ArgumentEmptyStringError. Subclass of ArgumentFalsyError
+      - ArgumentFalseError. Subclass of ArgumentFalsyError
+      - ArgumentNanError. Subclass of ArgumentFalsyError
+      - ArgumentNullError. Subclass of ArgumentFalsyError
+      - ArgumentUndefinedError. Subclass of ArgumentFalsyError
+      - ArgumentUndefinedError. Subclass of ArgumentFalsyError
+      - ArgumentZeroError. Subclass of ArgumentFalsyError
+      - ArgumentWhitespaceStringError. Subclass of ArgumentError
+      - ArgumentTypeError. Subclass of ArgumentError
+    - util/errors module
+  - Project Shell ▶️️ 🔨                          [\[devenv\]][devenv] [#122][#122] ([#7][#7] — [53ac8ab][53ac8ab] — [@clavecoder][@clavecoder])
+    - Provides Ubuntu 16.04 instead of 14.04
+  - Project Documentation ️️️️▶️️ 🔨                  [\[devenv\]][devenv] [#119][#119] ([#7][#7] — [53ac8ab][53ac8ab] — [@clavecoder][@clavecoder])
+                                                                                  ([#88][#88] — [e71400b][e71400b] — [@clavecoder][@clavecoder])
+    - README.md
+    - LICENCE
+    - CONTRIBUTING.md
+    - CREDITS.md
+    - DESIGN.md
+    - ISSUE-TEMPLATE-INSTRUCTIONS.md
+  - Canary Builds ▶️️ 🔨                          [\[devenv\]][devenv] [#113][#113] *this is an ongoing integration with greenkeeper*
+    - Greenkeeper GitHub integration.
+  - Provide GitHub issue template ▶️️ 🔨              [\[devenv\]][devenv] [#5][#5] ([#6][#6] — [bd41c4e][bd41c4e] — [@clavecoder][@clavecoder])
+    - .github/ISSUE_TEMPLATE.md
+  - [JS] Build Process ▶️️ 🔨                         [\[devenv\]][devenv] [#4][#4] ([#7][#7] — [53ac8ab][53ac8ab] — [@clavecoder][@clavecoder])
+                                                                                  ([#88][#88] — [e71400b][e71400b] — [@clavecoder][@clavecoder])
+    - **tsc** support in build script.
+    - **Babel** to build script.
+    - **Webpack 2** to build script.
+    - **Typings** support.
+    - TAP-based test code.
+    - code coverage.
+    - API documentation.
+    - Package published to NPM.
+  - Project Shell ▶️️ 🔨                              [\[devenv\]][devenv] [#1][#1] ([#3][#3] — [358d559][358d559] — [@clavecoder][@clavecoder])
+    - `Vagrantfile`
+      - Provides the `jali` Ubuntu 14.04 graphical guest operating system using the `VirtualBox` provider.
+      - Provisions the `jali` box using the `chef_zero` provisioner
+    - `main` cookbook in `site-cookbooks` that uses `Berksfile` to provision the `jali` box
+      - The following components are provisioned.
+        - Docker Service
+        - The `Hack` font
+        - `git`
+        - NodeJS
+        - Sphinx
+        - VSCode
+        - The latticework/jali GitHub repo
+- Housekeeping Chores [chore]
+  - change description or _TASK_TITLE_ [#_TASK_ID_][#_TASK_ID_]
+
+<!-- epics -->
+
+[devenv]: https://github.com/latticework/jali/issues/2
+[doc]: https://github.com/latticework/jali/issues/81
+[jali-util]: https://github.com/latticework/jali/issues/82
+[#82]: https://github.com/latticework/jali/issues/82
+[#81]: https://github.com/latticework/jali/issues/81
+[#2]: https://github.com/latticework/jali/issues/2
+
+<!-- queries -->
+
+[milestone-0.1.0]: https://github.com/latticework/jali/issues?utf8=✓&q=milestone:0.1.0%20is:closed%20label:zzz-closed_completed
+[milestone-0.1.0-feat]: https://github.com/latticework/jali/issues?utf8=✓&q=milestone:0.1.0%20is:closed%20label:type_enhancement%20label:zzz-closed_completed
+[milestone-0.1.0-fix]: https://github.com/latticework/jali/issues?utf8=✓&q=milestone:0.1.0%20is:closed%20label:type_bug%20label:zzz-closed_completed
+[milestone-0.1.0-pr]: https://github.com/latticework/jali/issues?utf8=✓&q=milestone:0.1.0%20is:closed%20is:pr%20label:zzz-closed_completed
+[milestone-0.0.1]: https://github.com/latticework/jali/issues?utf8=✓&q=milestone:0.0.1%20is:closed%20label:zzz-closed_completed
+[milestone-0.0.1-feat]: https://github.com/latticework/jali/issues?utf8=✓&q=milestone:0.0.1%20is:closed%20label:type_enhancement%20label:zzz-closed_completed
+[milestone-0.0.1-pr]: https://github.com/latticework/jali/issues?utf8=✓&q=milestone:0.0.1%20is:closed%20is:pr%20label:zzz-closed_completed
+
+<!-- diffs -->
+
+[unreleased-v0]: https://github.com/latticework/jali/compare/v0.1.0...master
+[v0.1.0]: https://github.com/latticework/jali/compare/v0.0.1...v0.1.0
+[v0.0.1]: https://github.com/latticework/jali/tree/v0.0.1
+
+<!-- issues -->
+
+[#122]: https://github.com/latticework/jali/issues/122
+[#120]: https://github.com/latticework/jali/issues/120
+[#119]: https://github.com/latticework/jali/issues/119
+[#113]: https://github.com/latticework/jali/issues/113
+[#110]: https://github.com/latticework/jali/issues/110
+[#105]: https://github.com/latticework/jali/issues/105
+[#103]: https://github.com/latticework/jali/issues/103
+[#90]: https://github.com/latticework/jali/issues/90
+[#96]: https://github.com/latticework/jali/issues/96
+[#92]: https://github.com/latticework/jali/issues/92
+[#91]: https://github.com/latticework/jali/issues/91
+[#87]: https://github.com/latticework/jali/issues/87
+[#86]: https://github.com/latticework/jali/issues/86
+[#85]: https://github.com/latticework/jali/issues/85
+[#84]: https://github.com/latticework/jali/issues/84
+[#83]: https://github.com/latticework/jali/issues/83
+[#80]: https://github.com/latticework/jali/issues/80
+[#5]: https://github.com/latticework/jali/issues/5
+[#4]: https://github.com/latticework/jali/issues/4
+[#1]: https://github.com/latticework/jali/issues/1
+
+<!-- pull requests -->
+
+[#121]: https://github.com/latticework/jali/pull/121
+[#111]: https://github.com/latticework/jali/pull/111
+[#106]: https://github.com/latticework/jali/pull/106
+[#104]: https://github.com/latticework/jali/pull/104
+[#101]: https://github.com/latticework/jali/pull/101
+[#98]: https://github.com/latticework/jali/pull/98
+[#97]: https://github.com/latticework/jali/pull/97
+[#88]: https://github.com/latticework/jali/pull/88
+[#7]: https://github.com/latticework/jali/pull/7
+[#6]: https://github.com/latticework/jali/pull/6
+[#3]: https://github.com/latticework/jali/pull/3
+
+<!-- commits -->
+
+[1c6adb1]: https://github.com/latticework/jali/commit/1c6adb1c82419673e296adb76d1ec39c08b3616a
+[358d559]: https://github.com/latticework/jali/commit/358d55968a4f7da8a264038f949ef3c27918376e
+[53ac8ab]: https://github.com/latticework/jali/commit/53ac8ab08cd61211a31c4e7bd5ef13e507258256
+[69fecf5]: https://github.com/latticework/jali/commit/69fecf530ea78db63e6012dd00d8774b52b8c09b
+[bd41c4e]: https://github.com/latticework/jali/commit/bd41c4ef6042328ff18af5bec13e8cb91b9b51ae
+[c876ec1]: https://github.com/latticework/jali/commit/c876ec145672013a7bf28a7b2634fbe657eeff1d
+[d8462b9]: https://github.com/latticework/jali/commit/d8462b91590384a5bd9dbb1581e1f969db630d50
+[e71400b]: https://github.com/latticework/jali/commit/e71400bdf6b7e5451ceb489ea1c285af59a1b8e7
+
+<!-- links -->
+
+[@clavecoder]: https://github.com/clavecoder