Add "scoreboard" test suite

[shawnbot]

This adds a new "scoreboard" package (which is not yet npm-publish-able) in meta/scoreboard that should generate a table of high-level checks for every one of our packages in modules/primer-*. Currently, the two checks are:

1. Whether the package has Storybook stories (the pattern is {dir}/stories.js, which currently doesn't match ones with {dir}/stories/*.js, but we can change it).
2. Whether script/test-docs passes when run in the package dir, regardless of whether the package's own test script is configured to run them. This is a way for us to have a better understanding of what's missing without just failing all of our tests (and builds) outright.

New checks should be easy to add; just add new keys to this object literal in the form:

'column title': (moduleObject, key) => {
  return {[key]: value} // or a Promise that resolves to an object
}

I've also refactored our docs test script in the following ways:

• It's more asynchronous 💅
• It finds class names in ERB helpers, e.g. <% octicon "foo", class: "float-right" %> (or in hash rocket form), which eliminates a bunch of false negatives.
• It outputs one test per class. The tradeoff here is that the output lists all of the classes being tested, but output with lots of errors is hard to read because AVA's reporter is overly chatty, even without --verbose.
• It supports a new class_whitelist field on the primer object in each package's package.json, which is an array of minimatch-compatible globs. See 77f987f for some examples.

To run it manually:

cd meta/scoreboard
npm install
npm test

You can run the checks for a specific subset of packages by passing the directories in as positional arguments to index.js, e.g.

node index.js ../../modules/primer-marketing*

[shawnbot]

Sweet! You can see an example of output in Travis builds here:

package                     has stories  docs test  missing docs                                                                                               
--------------------------  -----------  ---------  -----------------------------------------------------------------------------------------------------------
primer-alerts               no           pass                                                                                                                  
primer-avatars              yes          FAIL       ".avatar-group-item", ".avatar-link", ".avatar-stack", and 1 more...                                       
primer-base                 yes          pass                                                                                                                  
primer-blankslate           yes          pass                                                                                                                  
primer-box                  yes          FAIL       ".Box--scrollable", ".Box-row--drag-button", ".Box-row--drag-hide", and 1 more...                          
primer-branch-name          yes          pass                                                                                                                  
primer-breadcrumb           yes          pass                                                                                                                  
primer-buttons              yes          FAIL       ".btn-blue"                                                                                                
primer-forms                no           FAIL       ".bad-file", ".bad-permissions", ".btn-plain", ".comment", ".comment-form-error", and 61 more...           
primer-labels               yes          FAIL       ".label", ".labels", ".state", and 1 more...                                                               
primer-layout               yes          FAIL       ".gutter", ".gutter-condensed", ".gutter-lg", ".gutter-lg-condensed", ".gutter-lg-spacious", and 23 more...
primer-markdown             yes          FAIL       ".absent", ".anchor", ".blob-num", ".emoji", ".highlight", and 9 more...                                   
primer-marketing-buttons    yes          pass                                                                                                                  
primer-marketing-support    no           FAIL                                                                                                                  
primer-marketing-type       yes          pass                                                                                                                  
primer-marketing-utilities  yes          pass                                                                                                                  
primer-navigation           yes          FAIL       ".avatar", ".bar", ".menu-warning", ".select-menu-item-icon", ".subnav-bordered", and 13 more...           
primer-page-headers         no           FAIL       ".jumbotron", ".jumbotron-minitron", ".jumbotron-photo", ".jumbotron-supertron", and 3 more...             
primer-page-sections        no           FAIL       ".page-section"                                                                                            
primer-popover              yes          pass                                                                                                                  
primer-subhead              yes          pass                                                                                                                  
primer-support              no           FAIL                                                                                                                  
primer-table-object         yes          pass                                                                                                                  
primer-tables               yes          FAIL       ".data-table"                                                                                              
primer-tooltips             yes          pass                                                                                                                  
primer-truncate             yes          pass                                                                                                                  
primer-utilities            no           FAIL       ".anim-pulse-in", ".anim-shrink-x", ".bg-pending", ".bg-shade-gradient", ".bg-white", and 371 more...

[shawnbot]

FYI, I've updated the description to list the changes to our docs test script. I think this is good to merge as-is so that we can pull it into other branches.

[emplums]

Just left one comment but otherwise looks good to me!

[emplums]

Curious why this was added? I don't see it being imported anywhere

[shawnbot]

Good catch! I'll remove it.

[shawnbot]

Weird... this isn't in the stories-to-markdown branch anymore. GitHub bug??