@cmsgov/ds-healthcare-gov - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1-beta.1

package.json

 {
   "name": "@cmsgov/ds-healthcare-gov",
-  "version": "1.0.0",
+  "version": "1.0.1-beta.1",
   "publishConfig": {
@@ -8,3 +8,33 @@ "access": "public"
   "description": "A Design System companion for HealthCare.gov",
-  "repository": "https://github.cms.gov/CMS-WDS/ds-healthcare-gov"
+  "repository": "https://github.cms.gov/CMS-WDS/ds-healthcare-gov",
+  "scripts": {
+    "lint": "stylelint 'src/**/*.scss' && eslint --ext .jsx --ext .js src/"
+  },
+  "main": "dist/index.js",
+  "dependencies": {
+    "classnames": "^2.0.0",
+    "i18next": "^10.0.0",
+    "react-i18next": "^7.0.0"
+  },
+  "devDependencies": {
+    "@cmsgov/design-system-core": "^1.10.0",
+    "@cmsgov/design-system-layout": "^1.10.0",
+    "@cmsgov/design-system-support": "^1.10.0",
+    "@cmsgov/eslint-config-design-system": "^1.3.0",
+    "@cmsgov/stylelint-config-design-system": "^1.1.0",
+    "babel-plugin-transform-object-assign": "^6.22.0",
+    "babel-preset-es2015": "^6.24.1",
+    "babel-preset-react": "^6.24.1",
+    "eslint": "^4.16.0",
+    "eslint-config-nava": "^2.1.0",
+    "react": "^16.2.0",
+    "react-dom": "^16.2.0",
+    "stylelint": "^8.4.0",
+    "whatwg-url": "^6.4.0"
+  },
+  "peerDependencies": {
+    "@cmsgov/design-system-core": "^1.10.0",
+    "@cmsgov/design-system-layout": "^1.10.0",
+    "@cmsgov/design-system-support": "^1.10.0"
+  }
 }

README.md

@@ -1,12 +0,20 @@
-# HealthCare.gov Site Package
+> A Site Package is a method for sharing common, site-specific, design and code resources between the various teams working on HealthCare.gov. These resources are unique to HealthCare.gov, and not generalized for inclusion in the [Design System](https://github.com/cmsgov/design-system). It includes assets like design system overrides and site-specific components.
 
-A Site Package is a method for sharing common, site-specific, design and code resources between the various teams working on HealthCare.gov. These resources are unique to HealthCare.gov, and not generalized for inclusion in the [Design System](https://github.com/cmsgov/design-system).
+[![npm](https://img.shields.io/npm/v/@cmsgov/ds-healthcare-gov.svg?label=@cmsgov%2Fds-healthcare-gov)](https://www.npmjs.com/package/@cmsgov/ds-healthcare-gov)
 
 ## Usage
 
-### Sass
+### Installation
 
-Import the Site Package's Sass files _before_ you import the design system. For example:
+1. [Install the design system](https://design.cms.gov/getting-started/#installation)
+2. Install the site package:
+   ```
+   npm install --save @cmsgov/ds-healthcare-gov
+   ```
 
-```sass
+### Import Sass
+
+The source files included are written in Sass (`.scss`). You can add your `node_modules` directory to your Sass [`includePaths`](https://github.com/sass/node-sass#includepaths) and import the file like this, making sure to **import the Site Package's file _before_ you import the design system**:
+
+```scss
 @import '@cmsgov/ds-healthcare-gov/src/index';
@@ -16,9 +24,35 @@ @import '@cmsgov/design-system-core/src/index';
 
-## Context
+## Contributing
 
-HealthCare.gov consists of multiple codebases maintained by different teams. App 2.0 lives in one repo maintained by Nava, Window Shop lives in a different repo maintained by Ad Hoc, and Plan Compare lives in yet another repo. Currently this means some design assets and code are duplicated across codebases, going against the software development principle to keep things [DRY](https://en.m.wikipedia.org/wiki/Don%27t_repeat_yourself). These multiple codebases naturally tend to have differences, and as a result have caused inefficiencies and inconsistencies to creep into the user interface.
+Please view the [CONTRIBUTING.md](CONTRIBUTING.md) to read how you can add to the site package, as well as how to preview the site package in the context of the design system's documentation site.
 
+## File structure
+
+```
+├── dist
+│   └── index.css                         Compiled CSS
+├── src
+    ├── components
+    │   ├── Header
+    │   │   ├── Header.jsx                Top-level <Header> component
+    │   │   ├── defaultMenuLinks.js       Default menu links for each header variation
+    │   └── index.scss                    Component Sass imports
+    ├── locale
+    │   ├── en.json                       English i18n strings
+    │   ├── es.json                       Spanish i18n strings
+    │   └── translate.js                  react-i18next initializer and HOC
+    ├── index.scss                        Main Sass entry point with all imports
+    └── settings
+        └── _override.color.scss          Design system color variable overrides
+```
+
+---
+
+## Why a site package?
+
+HealthCare.gov consists of multiple codebases maintained by different teams. App 3.0 lives in one repo maintained by Nava, Window Shop lives in a different repo maintained by Ad Hoc, and Plan Compare lives in yet another repo. Currently this means some design assets and code are duplicated across codebases, going against the software development principle to keep things [DRY](https://en.m.wikipedia.org/wiki/Don%27t_repeat_yourself). These multiple codebases naturally tend to have differences, and as a result have caused inefficiencies and inconsistencies to creep into the user interface.
+
 The Design System is one way we're addressing the issues mentioned above. However, the design system is meant to be used by many CMS (Centers for Medicare & Medicaid Services) websites, not just HealthCare.gov. As a result, the resources within the design system are not tied to a particular website.
 
-## Goals
+### Goals
 
@@ -29,10 +63,10 @@ The primary goal of the Site Package is to reduce the amount of duplicate instances of HealthCare.gov front-end components and design assets, and having a single source of truth which all teams can contribute to and use.
 
-### Non-goals
+#### Non-goals
 
-- The Site Package is not meant to be as robust or as large as the Design System. It should be as small as possible, and ideally all reusable components would be from the design system.
-- The Site Package is not meant to serve as a resource for best practices or accessibility guidelines — that's the responsibility of the design system.
-- The HealthCare.gov Site Package is not meant to be a solution for other CMS websites.
+* The Site Package is not meant to be as robust or as large as the Design System. It should be as small as possible, and ideally all reusable components would be from the design system.
+* The Site Package is not meant to serve as a resource for best practices or accessibility guidelines — that's the responsibility of the design system.
+* The HealthCare.gov Site Package is not meant to be a solution for other CMS websites.
 
-## Additional links
+### Additional links
 
-- [The original tech spec for Site Packages can be viewed in the Design System Confluence](https://confluence.cms.gov/pages/worddav/preview.action?fileName=2017.06.21.E+-+Tech+spec+HealthCare.gov+Site+Package.pdf&pageId=65409149)
+* [The original tech spec for Site Packages can be viewed in the Design System Confluence](https://confluence.cms.gov/pages/worddav/preview.action?fileName=2017.06.21.E+-+Tech+spec+HealthCare.gov+Site+Package.pdf&pageId=65409149)

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

287026

increased by7307.12%

Number of package files

57

increased by1325%

Lines of code

1245

increased byInfinity%

Number of lines in readme file

71

increased by97.22%

Worsened metrics

Dependency count

6

increased byInfinity%

Dev dependency count

14

increased byInfinity%

Number of low quality alerts

2

increased by100%

Dependency changes

• + Addedclassnames@^2.0.0

• + Addedi18next@^10.0.0

• + Addedreact-i18next@^7.0.0

• + Added@cmsgov/design-system-core@1.32.1(transitive)

• + Added@cmsgov/design-system-layout@1.32.1(transitive)

• + Added@cmsgov/design-system-support@1.32.1(transitive)

• + Added@types/node@8.10.66(transitive)

• + AddedJSONStream@1.3.5(transitive)

• + Addedacorn@5.7.47.4.1(transitive)

• + Addedacorn-node@1.8.2(transitive)

• + Addedacorn-walk@7.2.0(transitive)

• + Addedarray-filter@1.0.0(transitive)

• + Addedarray-foreach@1.0.2(transitive)

• + Addedasn1.js@4.10.1(transitive)

• + Addedassert@1.5.1(transitive)

• + Addedbalanced-match@1.0.2(transitive)

• + Addedbase64-js@1.5.1(transitive)

• + Addedbn.js@4.12.15.2.1(transitive)

• + Addedbrace-expansion@1.1.11(transitive)

• + Addedbrorand@1.1.0(transitive)

• + Addedbrowser-pack@6.1.0(transitive)

• + Addedbrowser-resolve@1.11.3(transitive)

• + Addedbrowserify@13.3.0(transitive)

• + Addedbrowserify-aes@1.2.0(transitive)

• + Addedbrowserify-cipher@1.0.1(transitive)

• + Addedbrowserify-des@1.0.2(transitive)

• + Addedbrowserify-rsa@4.1.1(transitive)

• + Addedbrowserify-sign@4.2.3(transitive)

• + Addedbrowserify-zlib@0.1.4(transitive)

• + Addedbuffer@4.9.2(transitive)

• + Addedbuffer-from@1.1.2(transitive)

• + Addedbuffer-xor@1.0.3(transitive)

• + Addedbuiltin-status-codes@3.0.0(transitive)

• + Addedcached-path-relative@1.1.0(transitive)

• + Addedcall-bind@1.0.8(transitive)

• + Addedcall-bind-apply-helpers@1.0.1(transitive)

• + Addedcall-bound@1.0.3(transitive)

• + Addedcipher-base@1.0.6(transitive)

• + Addedclasslist-polyfill@1.2.0(transitive)

• + Addedclassnames@2.5.1(transitive)

• + Addedcombine-source-map@0.8.0(transitive)

• + Addedconcat-map@0.0.1(transitive)

• + Addedconcat-stream@1.5.21.6.2(transitive)

• + Addedconsole-browserify@1.2.0(transitive)

• + Addedconstants-browserify@1.0.0(transitive)

• + Addedconvert-source-map@1.1.3(transitive)

• + Addedcore-js@2.6.12(transitive)

• + Addedcore-util-is@1.0.3(transitive)

• + Addedcreate-ecdh@4.0.4(transitive)

• + Addedcreate-hash@1.2.0(transitive)

• + Addedcreate-hmac@1.1.7(transitive)

• + Addedcrypto-browserify@3.12.1(transitive)

• + Addeddash-ast@1.0.0(transitive)

• + Addeddefine-data-property@1.1.4(transitive)

• + Addeddefine-properties@1.2.1(transitive)

• + Addeddefined@1.0.1(transitive)

• + Addeddeps-sort@2.0.1(transitive)

• + Addeddes.js@1.1.0(transitive)

• + Addeddetective@4.7.1(transitive)

• + Addeddiffie-hellman@5.0.3(transitive)

• + Addeddomain-browser@1.1.7(transitive)

• + Addeddomready@1.0.8(transitive)

• + Addeddownshift@1.31.16(transitive)

• + Addeddunder-proto@1.0.1(transitive)

• + Addedduplexer2@0.1.4(transitive)

• + Addedelem-dataset@1.1.1(transitive)

• + Addedelement-closest@2.0.2(transitive)

• + Addedelliptic@6.6.1(transitive)

• + Addedes-define-property@1.0.1(transitive)

• + Addedes-errors@1.3.0(transitive)

• + Addedes-object-atoms@1.0.0(transitive)

• + Addedev-emitter@1.1.1(transitive)

• + Addedevents@1.1.1(transitive)

• + Addedevp_bytestokey@1.0.3(transitive)

• + Addedfast-safe-stringify@2.1.1(transitive)

• + Addedfocus-trap@2.4.6(transitive)

• + Addedfocus-trap-react@3.1.4(transitive)

• + Addedfs.realpath@1.0.0(transitive)

• + Addedfunction-bind@1.1.2(transitive)

• + Addedget-assigned-identifiers@1.2.0(transitive)

• + Addedget-intrinsic@1.2.7(transitive)

• + Addedget-proto@1.0.1(transitive)

• + Addedglob@7.2.3(transitive)

• + Addedgopd@1.2.0(transitive)

• + Addedhas@1.0.4(transitive)

• + Addedhas-property-descriptors@1.0.2(transitive)

• + Addedhas-symbols@1.1.0(transitive)

• + Addedhash-base@3.0.5(transitive)

• + Addedhash.js@1.1.7(transitive)

• + Addedhasown@2.0.2(transitive)

• + Addedhmac-drbg@1.0.1(transitive)

• + Addedhoist-non-react-statics@2.5.5(transitive)

• + Addedhtml-parse-stringify2@2.0.1(transitive)

• + Addedhtmlescape@1.1.1(transitive)

• + Addedhttps-browserify@0.0.1(transitive)

• + Addedi18next@10.6.0(transitive)

• + Addedieee754@1.2.1(transitive)

• + Addedindexof@0.0.1(transitive)

• + Addedinflight@1.0.6(transitive)

• + Addedinherits@2.0.32.0.4(transitive)

• + Addedinline-source-map@0.6.3(transitive)

• + Addedinsert-module-globals@7.2.1(transitive)

• + Addedis-buffer@1.1.6(transitive)

• + Addedis-core-module@2.16.1(transitive)

• + Addedisarray@1.0.0(transitive)

• + Addedjs-tokens@4.0.0(transitive)

• + Addedjson-stable-stringify@0.0.1(transitive)

• + Addedjsonify@0.0.1(transitive)

• + Addedjsonparse@1.3.1(transitive)

• + Addedkeyboardevent-key-polyfill@1.1.0(transitive)

• + Addedlabeled-stream-splicer@2.0.2(transitive)

• + Addedlodash.debounce@4.0.8(transitive)

• + Addedlodash.memoize@3.0.4(transitive)

• + Addedlodash.uniqueid@4.0.1(transitive)

• + Addedloose-envify@1.4.0(transitive)

• + Addedmatches-selector@1.2.0(transitive)

• + Addedmath-intrinsics@1.1.0(transitive)

• + Addedmd5.js@1.3.5(transitive)

• + Addedmiller-rabin@4.0.1(transitive)

• + Addedminimalistic-assert@1.0.1(transitive)

• + Addedminimalistic-crypto-utils@1.0.1(transitive)

• + Addedminimatch@3.1.2(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedmodule-deps@4.1.1(transitive)

• + Addedno-scroll@2.1.1(transitive)

• + Addedobject-assign@4.1.1(transitive)

• + Addedobject-inspect@1.13.3(transitive)

• + Addedobject-keys@1.1.1(transitive)

• + Addedobject.assign@4.1.7(transitive)

• + Addedonce@1.4.0(transitive)

• + Addedos-browserify@0.1.2(transitive)

• + Addedpako@0.2.9(transitive)

• + Addedparents@1.0.1(transitive)

• + Addedparse-asn1@5.1.7(transitive)

• + Addedpath-browserify@0.0.1(transitive)

• + Addedpath-is-absolute@1.0.1(transitive)

• + Addedpath-parse@1.0.7(transitive)

• + Addedpath-platform@0.11.15(transitive)

• + Addedpbkdf2@3.1.2(transitive)

• + Addedprocess@0.11.10(transitive)

• + Addedprocess-nextick-args@1.0.72.0.1(transitive)

• + Addedprop-types@15.8.1(transitive)

• + Addedpublic-encrypt@4.0.3(transitive)

• + Addedpunycode@1.4.1(transitive)

• + Addedqs@6.13.1(transitive)

• + Addedquerystring-es3@0.2.1(transitive)

• + Addedrandombytes@2.1.0(transitive)

• + Addedrandomfill@1.0.4(transitive)

• + Addedreact@16.14.0(transitive)

• + Addedreact-aria-modal@2.12.3(transitive)

• + Addedreact-displace@2.3.0(transitive)

• + Addedreact-dom@16.14.0(transitive)

• + Addedreact-i18next@7.13.0(transitive)

• + Addedreact-is@16.13.1(transitive)

• + Addedread-only-stream@2.0.0(transitive)

• + Addedreadable-stream@2.0.62.3.8(transitive)

• + Addedreceptor@1.0.0(transitive)

• + Addedresolve@1.1.71.22.10(transitive)

• + Addedresolve-id-refs@0.1.0(transitive)

• + Addedripemd160@2.0.2(transitive)

• + Addedsafe-buffer@5.1.25.2.1(transitive)

• + Addedscheduler@0.19.1(transitive)

• + Addedset-function-length@1.2.2(transitive)

• + Addedsha.js@2.4.11(transitive)

• + Addedshasum@1.0.2(transitive)

• + Addedshasum-object@1.0.0(transitive)

• + Addedshell-quote@1.8.2(transitive)

• + Addedside-channel@1.1.0(transitive)

• + Addedside-channel-list@1.0.0(transitive)

• + Addedside-channel-map@1.0.1(transitive)

• + Addedside-channel-weakmap@1.0.2(transitive)

• + Addedsimple-concat@1.0.1(transitive)

• + Addedsource-map@0.5.7(transitive)

• + Addedstream-browserify@2.0.2(transitive)

• + Addedstream-combiner2@1.1.1(transitive)

• + Addedstream-http@2.8.3(transitive)

• + Addedstream-splicer@2.0.1(transitive)

• + Addedstring_decoder@0.10.311.1.1(transitive)

• + Addedsubarg@1.0.0(transitive)

• + Addedsupports-preserve-symlinks-flag@1.0.0(transitive)

• + Addedsyntax-error@1.4.0(transitive)

• + Addedtabbable@1.1.3(transitive)

• + Addedthrough@2.3.8(transitive)

• + Addedthrough2@2.0.5(transitive)

• + Addedtimers-browserify@1.4.2(transitive)

• + Addedto-arraybuffer@1.0.1(transitive)

• + Addedtty-browserify@0.0.1(transitive)

• + Addedtypedarray@0.0.60.0.7(transitive)

• + Addedtypescript@2.9.2(transitive)

• + Addedumd@3.0.3(transitive)

• + Addedundeclared-identifiers@1.1.3(transitive)

• + Addedurl@0.11.4(transitive)

• + Addeduswds@1.3.1(transitive)

• + Addedutil@0.10.4(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addedvm-browserify@0.0.4(transitive)

• + Addedvoid-elements@2.0.1(transitive)

• + Addedwrappy@1.0.2(transitive)

• + Addedxtend@4.0.2(transitive)