Giter Club home page Giter Club logo

alien's People

Contributors

natepisarski avatar

Watchers

 avatar  avatar

alien's Issues

100% Test Coverage and Documentation Coverage

One of the key tenants that alien developers should follow is that less than 100% test and documentation coverage within the project should never happen.

This isn't because I'm mean, or I have a perverted view of exactly what kinds of guarantees tests provide. It is, however, the best line of defense against regressions when actual testing time is limited.

Less than 100% test coverage poses a security risk, and lets regressions sneak by with new features.

Less than 100% documentation coverage means that in rare cases, developers have to read source in order to use the library.

This should be rectified with:

  • At least one test for each alien option
  • A fully-documented JSDoc typedef for the alien options, and parameter documentation for alien itself.

Quick-Options

Quick-options are described in the project. They are a way of assigning alien options with the smallest possible substring.

A valid quick-option: {c: {c: true}} -> {control: {createBlankProperty: true}}

Business Rules

There are two passes:

  • The take pass
  • The case-take pass

In any of these passes, the first match becomes the matched option.

Take Pass

The take pass will take the given short-option and match it with the first matching property beginning with the substring.

For instance, con would match control but not outofcontrol.

case-take pass

The case-take pass will take the given short-option and match it with the first property which matches it, based on the first letters parsed from the word in camel-case.

Camel Case resolutions

objectUtilities -> ou
allowUnsafeInitialization -> aui

au would match aui in the above case.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.