Task: work

• Parent: #113 ▶️️

Details

• Update all dependency packages to latest except for @types/node 6.x
• Remove all greenkeeper branches.
• Remove all greenkeeper issues.

Enhancement feat

• Completed by #7

Definition

In order to use any iterator as easily as an array in JavaScript,

As a Developer,

I want to use functions for any iterable that correspond to those of Array

Features

• Iterable functions
  • asArray
  • asIterable
  • concat
  • every
  • filter
  • find
  • includes
  • map
  • reduce
  • slice
  • some
  • toMap
• util/iterables module

Tasks

• Create error types.
• Create unit tests.
• Create examples.
• Create manual documentation.

Acceptance Criteria

• Unit tests with maximal code coverage
• Complete documentation
  • example code
  • reference documentation
    • esdoc code comments
    • esdoc manual

Bug fix

Details

Description

Example jali_ms_util_errors item ⑤ is not correct.

Steps to Reproduce

1. Execute npm docs
2. Open dist/docs/index.html
3. Navigate to **Manual | Example jali_ms_util | jali_ms_util_errors

Defective Behavior

Note that error message for Example (5) is `Error: Error in argument 'notWhitespaceString'

Desired Behavior

Error should be Error: Argument must be between 10 and 19. Yours is '20'

Version 4.5.1 of tslint just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As tslint is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

Enhancement chore

• Completed by #7
• Completed by #88

Definition

In order to contribute to jali,
As a Jali Contributor,
I want to build a single NPM package.

Features

• 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.

Acceptance Criteria

• Demonstrate the ability for Jali Contributor to use npm run build to build a single NPM package.
• Packages must be a scoped to the NPM jali-ms organization.
• The build process must use Webpack 2, Typescript, Babel and follow ng2 style for scoped modules.
• Demonstrate usage of module from NPM.

Enhancement chore

• Completed by #3
• Replaced by #122

Definition

In order to quickly get started developing as a Jali Contributor I want to clone and provision a Jali project development environment.

Features

• 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

Acceptance Criteria

• Cloning and provisioning jali produces a fully initialized node project in a Vagrant graphical Unbuntu environment on Windows 10.

Enhancement feat

• Completed by #7

Definition

In order to fail-fast irrecoverable errors,

As a developer,

I want to throw an error that indicates the system is in an invalid state to continue.

Features

• InvalidStateError type. Subclass of Error.
• util/errors module

Tasks

• Create error types.
• Create unit tests.
• Create examples.
• Create manual documentation.

Acceptance Criteria

• Unit tests with maximal code coverage
• Complete documentation
  • example code
  • reference documentation
    • esdoc code comments
    • esdoc manual

Version 3.16.1 of eslint just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As eslint is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

TypeScript/JavaScript extensions and objects

The development environment supports modern JavaScript development tools and practices.

Bug chore

Completed by #97

Details

Description

Several links are not working from the /README.md page.

Steps to Reproduce

1. Click on some links

Defective Behavior

Note the ones that do not go to their desired destination.

Desired Behavior

• Links work normally.

Idea: docs

Details

Add link to ZenHub in README.md and and CONTRIBUTING.md so people know to add ZenHub to see the KANBAN board.

Add explicit Getting Started instructions for adding ZenHub.

Idea: devenv

Details

mention-bot will add a comment in a PR that mentions who is most likely the reviewers for the PR based on the code. Add to Jali so that the proper Devs will be proactively notified about changes to code they are likely to maintain.

Version 10.3.2 of nyc just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As nyc is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

Enhancement feat

Definition

In order to JavaScript develop software forward-compatibly,

As a developer,

I want to develop from the list specified in
ECMASCRIPT-PROPOSALS.md,

Whereas currently compatibility is not tested.

Tasks

• Add tests for EcmaScript proposals.
• Make changes (polyfills, TS -lib..., Babel plugins, etc) to reasonably support proposals.
• Rationalize ECMASCRIPT-PROPOSALS.md to conform to reality.
• Enable ESNext features in esdoc config.

Acceptance Criteria

• As many of ES2015, ES2016. and ES2017 proposals are supported as possible.
• Stage 2 and Stage 3 proposals are supported as reasonable.
• Class and Property decorators are supported.

Provide Design, Development, Reference, Guide, and Usage documentation for all supported modules and languages.

Idea: feat

Details

Currently we have verifyDefined, verifyNotNull, and verifyTruthy, but Jali functions check for != undefined. Therefore, add verifyDefinedLike that has that behavior.

Steps

• Update Enhancement #90 to include verifyDefinedLike.
  • Require the every occurrence of verifyDefined be checked whether it should be changed
    to verifyDefinedLike

Bug chore

Completed by #97

Details

Description

Tables in CONTRIBUTING.md are not formatted

Steps to Reproduce

1. Open CONTRIBUTING.md

Defective Behavior

Desired Behavior

• Properly formatted tables.

Idea: feat

Details

Currently some Array functions such as forEach and join are not included in the Iterables module. We should strive for full coverage of applicable Array functions.

Steps

• Update Enhancement # with a reviewed list of applicable Array functions.
  • Include Array#forEach
  • Include Array#join

Bug fix

Details

Description

.eslintrc has configuration error that shows up in Code Climate

Steps to Reproduce

1. Click the link to the Code Climate run above.

Defective Behavior

Error with message appears:

Error: /code/.eslintrc.json:
	Configuration for rule "spaced-comment" is invalid:
	Value "error" is the wrong type.

Desired Behavior

Code Climate runs without error.

Enhancement devenv

• Replaces #119
• Completed by #121

Definition

In order to manage the Jali project,

As a Developer,

I want to maintain a full set of project documentation.

Features

• .github/ISSUE_TEMPLATE.md
• CHANGELOG.md
• CONTRIBUTING.md
• LICENCE
• README.md
• project/CHANGELOG-TEMPLATE.md
• project/CREDITS.md
• project/DESIGN.md
• project/ISSUE-TEMPLATE-INSTRUCTIONS.md
• project/PROCEDURES.md
• project/QUERIES.md
• project/ROADMAP.md

New Features [feat]

• CHANGELOG.md
• project/CHANGELOG-TEMPLATE.md
• project/PROCEDURES.md
• project/QUERIES.md
• project/ROADMAP.md

Updated Features [change]

• Changed supporting documents
  • Moved documents
    • to project/CREDITS.md
    • to project/DESIGN.md
    • to project/ISSUE-TEMPLATE-INSTRUCTIONS.md

Tasks

• Complete standard documents
• Complete supporting documents
• Update EcmaScript status TS 2018-05 (#153 )
• Update EcmaScript status to TC 2018-07 / TS 3.0 (#189)

Acceptance Criteria

• Reviewed documents for completeness.

Bug fix

Details

Description

Missing esdoc comments for type-guards.ts

Steps to Reproduce

1. Open type-guards.ts (link above).
2. Notice missing esdoc comments.

Defective Behavior

• Missing documentation

Acceptance criteria.

• Adequate documentation on type-guards.ts
• Successful esdoc build
• Overview updated with function summary.
• Documentation site is correct.

Idea: chore

Details

Validate .bithoundrc for validity during build and any other file that can't be checked by the editor.

Idea: chore

Details

Package nyc v10.2 enables new build configuration. Consider making any relevant changes to the jali build configuration.

Idea: change

Details

Make changes to Jali Typescript api enabled by new TypeScript v2.2 features.

Enhancement feat

• Completed by #7

Definition

In order to facilitate working with union types in TypeScript,

As a developer,

I want to use User-Defined Type Guards for common JavaScript types and idioms.

Features

• Type guards
  • isError
  • makeIsIterable: Generates deep-checking type guard for iterable of given type
  • isIterable
• util/type-guards module

Tasks

• Create type guards
• Create unit tests.
• Create examples.
• Create manual documentation.

Acceptance Criteria

• Unit tests with maximal code coverage
• Complete documentation
  • example code
  • reference documentation
    • esdoc code comments
    • esdoc manual

Idea: feat

Details

Create a PR template like there is for Issues following the guide.

• Create PULL_REQUEST_TEMPLATE.md
• Create PULL_REQUEST_TEMPLATE_INSTRUCTIONS.md

Enhancement chore

• Completed by #112

Definition

In order to ensure support of the latest dependency versions,

As a developer,

I want to have the DevOps system automatically test the latest versions of dependencies.

Features

• Greenkeeper GitHub integration.

Tasks

• Enable the Greenkeeper GitHub integration.

Acceptance Criteria

• Greenkeeper automatically branches main, updates to latest dependency version, builds system, and creates pull request if build/test is successful.

Provide a jalidev-based jali development environment that builds core packages, an empty CLI, management website, electron management application and Android management app.

Jali Project Roadmap

v0.1.0 (2017-02)

• ✨ New Features [feat]
  • 🔨 [devenv] (#2) Project Documentation (#120)
    • CHANGELOG.md
    • project/CHANGELOG-TEMPLATE.md
    • project/PROCEDURES.md
    • project/QUERIES.md
• 🔧 Bug Fixes [fix]
  • 𝍖 [jali-util] (#82) Fix Known Test Failures (#103)
  • 📄 [doc] (#81) Bad scope in doc links (#92)
  • 📄 [doc] (#81) Manual page garbled for esdoc 0.5.x (#80)
  • 🔨 [devenv] (#2) Mute Status Check Issue (#110)
  • 🔨 [devenv] (#2) Fix bitHound Issues (#105)
  • 🔨 [devenv] (#2) Bad Contributing Document Formatting (#96)
  • 🔨 [devenv] (#2) Bad README Links (#91)
  • 🔨 [devenv] (#2) Enhancement link broken (#85)

v0.0.1 (2017-01)

• ✨ [feat] New Features
  • 𝍖 [jali-util] (#82) [JS] Argument validation functions (#90)
  • 𝍖 [jali-util] (#82) [JS] Iterator Functions (#87)
  • 𝍖 [jali-util] (#82) [JS] @jali-ms/util Type Guards (#86)
  • 𝍖 [jali-util] (#82) [JS] Invalid State Error (#84)
  • 𝍖 [jali-util] (#82) [JS] Argument Errors (#83)
  • 🔨 [devenv] (#2) Project Shell (#1, #122)
  • 🔨 [devenv] (#2) Project Documentation (#5, #119)
  • 🔨 [devenv] (#2) Canary Builds (#113)
  • 🔨 [devenv] (#2) [JS] Build Process (#4)

Idea: chore

Details

Add community eslint rules to linter

See:

• https://www.npmjs.com/package/tslint-eslint-rules
• https://github.com/sindresorhus/eslint-plugin-unicorn
• https://github.com/palantir/tslint#custom-rules

Enhancement chore

• Completed by #6
• Replaced by #119

Definition

In order that a Jali Contributor can more easily create a conforming GitHub issue, provide a GitHub Issue template.

Features

• .github/ISSUE_TEMPLATE.md

Acceptance Criteria

• A GitHub Issue template will be displayed when a Jali Contributor creates a new issue
• The template shall include guidance for enhancements and bugs.

Enhancement devenv

Definition

In order to visualize project code analytics,

As a developer,

I want to provide a Jali branch that contains source code that OpenHub can analyze.

Tasks

• Create open-hub branch.
• Configure the OpenHub Jali project to reference the OpenHub branch.
• Monitor OpenHub project to ensure that the project is re-analyzed.

Acceptance Criteria

• The OpenHub site shows the correct number of lines of code.

Discussion

OpenHub does not recognize TypeScript source code. Therefore to provide OpenHub source code that
it can process, A branch should be created that preserves the JavaScript generated by the build process.

A future version if this Enhancement can require automated updates to the branch.

Enhancement devenv

• Replaces #1
• Completed by #7

Definition

In order to quickly get started developing as a Jali Contributor I want to clone and provision a Jali project development environment.

Features

• Vagrantfile
  • Provides the jali Ubuntu 16.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

Changed Features [chore]

• Provides Ubuntu 16.04 instead of 14.04

Tasks

• Update Vagrantfile to Provide Ubuntu 16.04
• Test provisioned configurations to ensure working result

Acceptance Criteria

• Cloning and provisioning jali produces a fully initialized node project in a Vagrant graphical Unbuntu environment on Windows 10.

Enhancement feat

• Completed by #7

Definition

In order to fail-fast argument errors,

As a Developer,

I want to utilize standard argument validation functions that throw consistent errors.

Features

• validation functions
  • verifyArgument
  • verifyArray
  • verifyBoolean
  • verifyDefined
  • verifyFunction
  • verifyIterable
  • verifyNonEmpty
  • verifyNonZero
  • verifyNotNull
  • verifyNotWhitespace
  • verifyNumber
  • verifyObject
  • verifyString
  • verifyTrue
  • verifyTruthy
• util/errors module

Tasks

• Create error types.
• Create unit tests.
• Create examples.
• Create manual documentation.

Acceptance Criteria

• Unit tests with maximal code coverage
• Complete documentation
  • example code
  • reference documentation
    • esdoc code comments
    • esdoc manual

Bug chore

Completed by #97

Details

Description

In ISSUE-TEMPLATE-INSTRUCTIONS.md, links to the Enhancement form don't work

Steps to Reproduce

1. Navigate to ISSUE-TEMPLATE-INSTRUCTIONS.md.
2. Click on the two links to the enhancement form.

Defective Behavior

Links don't navigate to the form.

Desired Behavior

Links should navigate to the form.

Bug chore

Completed by #111

Details

Description

VersionEye spuriously marks site cookbook main as having an invalid license.

See: https://www.versioneye.com/pullrequests/589031b17db49e00162b488b

Steps to Reproduce

1. View report

Defective Behavior

Shows site cookbook as having UNKNOWN license.

Desired Behavior

Report should be muted.

See: https://twitter.com/VersionEye/status/826373368085676032

Bug fix

Completed by #101

Details

Description

When building with esdoc v0.5.2 or esdoc v0.5.1, Top navbar missing and all top level tree nodes missing.

Steps to reproduce

1. First, set esdoc version to 0.5.2 by installing that version.
2. Next, run npm run docs and navigate to ./dist/docs/manual/index.html

Defective behavior

Desired behavior

Expected view as build by esdoc v0.4.8:

Bug fix

Completed by #104

Details

Description

7 unit tests are marked as known failures. The should be fixed

Bug Fixes [fix]

• @jali-ms/util/src/iterables_reduce
  • initialValue can now be null
• @jali-ms/util/src/iterables_slice
  • begin and end can now be null
• @jali-ms/util/src/iterables_slice
  • now works if begin or end is negative

Steps to Reproduce

1. Run: npm test

Defective Behavior

Out put shows 7 known failures

Desired Behavior

All tests pass as designed.

Enhancement feat

• Completed by #7

Definition

In order to consistently handle function argument errors,

As a developer,

I want to throw a specific error type for all common argument errors.

Features

• 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

Tasks

• Create error types.
• Create unit tests.
• Create examples.
• Create manual documentation.

Acceptance Criteria

• Unit tests with maximal code coverage
• Complete documentation
  • example code
  • reference documentation
    • esdoc code comments
    • esdoc manual

Enhancement devenv

• Replaces #5
• Completed by #7
• Completed by #88

Definition

In order to manage the Jali project,

As a Developer,

I want to maintain a full set of project documentation.

Features

• .github/ISSUE_TEMPLATE.md
• CONTRIBUTING.md
• CREDITS.md
• DESIGN.md
• ISSUE-TEMPLATE-INSTRUCTIONS.md
• LICENCE
• README.md

New Features

• CONTRIBUTING.md
• CREDITS.md
• DESIGN.md
• ISSUE-TEMPLATE-INSTRUCTIONS.md
• LICENCE
• README.md

Tasks

• Complete standard documents
• Complete supporting documents

Acceptance Criteria

• Documents reviewed for completeness

Bug chore

Completed by #106

Details

Description

Fix various bitHound issues.

Steps to Reproduce

1. Merge to master

Defective Behavior

• Resolve unused dependencies. See: https://www.bithound.io/github/latticework/jali/master/dependencies/npm
• Resolve @types/node outdated: See: https://www.bithound.io/github/latticework/jali/master/dependencies/npm
• linting disabled. See: https://github.com/latticework/jali/blob/master/.bithoundrc
• esdoc dependency muted. See: https://www.bithound.io/github/latticework/jali/master/dependencies/npm/esdoc
• Enable license checking. See: https://www.bithound.io/settings/github/latticework/jali
• Fix code analysis issues for argument-verifiers.ts. See: https://www.bithound.io/github/latticework/jali/blob/111d6f4e93053fd2646fe9097ce46cc33479e1a0/packages/@jali-ms/util/src/argument-verifiers.ts
• Fix code analysis issues for iterables.ts. See: https://www.bithound.io/github/latticework/jali/blob/111d6f4e93053fd2646fe9097ce46cc33479e1a0/packages/@jali-ms/util/src/iterables.ts

Desired Behavior

All issues resolved.

Idea: chore

Details

Linting is currently done against packages. Add linting against examples also.

Idea: chore

Details

Per https://github.com/babel/babel-preset-env use babel-preset-env rather than the depricated babel-preset-es2015-node4.

But consider packages that need to work on both browsers and node...

Idea: chore

Details

Incorporate new tslint rules in v5.0.

Idea: chore

Details

AVA currently uses it's own babel settings in /package.json. It should use the same build output as the rest of the project.

See: https://github.com/avajs/ava#es2017-support

Idea: chore

Details

Switch to yarn from npm.

• Investigate lock file usage
• update main Chef cookbook to install/update yarn

Bug fix

Completed by #98

Details

Description

Doc links are hard coded to old jali scope.

Steps to Reproduce

1. Navigate to Packages in documentation.
2. click on the link: @jali-ms/util

Defective Behavior

Link is: http://jali-ms.io/reference/0.1.0/manual/overview.html#package-jali-util

Desired Behavior

Links should be: http://jali-ms.io/reference/0.1.0/manual/overview.html#package-jali-ms-util

Idea: chore

Details

VSCode now supports standard apt-get packages on Ubuntu. Use that rather than the current direct DEB package download.

• Investigate how to install VSCode using apt-get.
• Modify main Chef cookbook to use the new method.

Notes

• nodejs cookbook provider to install packages

Task: work

• Parent #113 ▶️️
• Closed by #128

Details

• Update all dependency packages to latest except for @types/node 6.x
• Remove all greenkeeper branches.