@artsy/cohesion - npm Package Compare versions

Comparing version 1.0.5 to 1.1.0

CHANGELOG.md

@@ -0,1 +1,14 @@
+# v1.1.0 (Thu May 21 2020)
+
+#### 🚀  Enhancement
+
+- Manage links in README [#47](https://github.com/artsy/cohesion/pull/47) ([@jonallured](https://github.com/jonallured))
+- Expose consign helpers [#48](https://github.com/artsy/cohesion/pull/48) ([@jonallured](https://github.com/jonallured))
+
+#### Authors: 1
+
+- Jon Allured ([@jonallured](https://github.com/jonallured))
+
+---
+
 # v1.0.5 (Thu May 21 2020)
@@ -2,0 +15,0 @@

dist/Events/index.d.ts

 export * from "./Authentication/AuthImpression";
 export * from "./Authentication/CreatedAccount";
+export * from "./Authentication/ResetYourPassword";
 export * from "./Authentication/SuccessfullyLoggedIn";
-export * from "./Authentication/ResetYourPassword";
+export * from "./Tap/TappedConsign";
 export * from "./Tap/TappedEntityGroup";

dist/Events/index.js

@@ -31,2 +31,14 @@ "use strict";
 
+var _ResetYourPassword = require("./Authentication/ResetYourPassword");
+
+Object.keys(_ResetYourPassword).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _ResetYourPassword[key];
+    }
+  });
+});
+
 var _SuccessfullyLoggedIn = require("./Authentication/SuccessfullyLoggedIn");
@@ -44,5 +56,5 @@
 
-var _ResetYourPassword = require("./Authentication/ResetYourPassword");
+var _TappedConsign = require("./Tap/TappedConsign");
 
-Object.keys(_ResetYourPassword).forEach(function (key) {
+Object.keys(_TappedConsign).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
@@ -52,3 +64,3 @@ Object.defineProperty(exports, key, {
     get: function () {
-      return _ResetYourPassword[key];
+      return _TappedConsign[key];
     }
@@ -55,0 +67,0 @@ });

package.json

 {
   "name": "@artsy/cohesion",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "description": "Analytics schema and library helpers",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -1,2 +0,2 @@
-# Cohesion [![CircleCI](https://circleci.com/gh/artsy/cohesion.svg?style=svg)](https://circleci.com/gh/artsy/cohesion) [![npm version](https://badge.fury.io/js/%40artsy%2Fcohesion.svg)](https://www.npmjs.com/package/@artsy/2Fcohesion)
+## Cohesion [![CircleCI][badge]][circleci]
 
@@ -9,8 +9,8 @@ ### Artsy's analytics schema & event helpers
 - **Ci**: https://circleci.com/gh/artsy/cohesion
-- **[NPM](https://www.npmjs.com/package/@artsy/2Fcohesion):** Package updates are published automatically on successful merges to master. Canaries are available on PR's from feature branches.
-- **Point People**: [@eessex](https://github.com/eessex), [@abhitip](https://github.com/abhitip)
+- **[NPM](https://www.npmjs.com/package/@artsy/cohesion):** Package updates are published automatically on successful merges to master. Canaries are available on PR's from feature branches.
+- **Point People**: [@eessex][], [@abhitip][]
 
 ## Contributing
 
-Requirements: [Yarn](https://classic.yarnpkg.com/en/docs/install/#mac-stable)
+Requirements: [Yarn][]
 
@@ -49,3 +49,3 @@ #### Set up:
 
-1. In `Schema/Event.ts`, add the name of the new event. This name defines the corresponding downstream table's name in Redshift, and should use the [`lowerCamelCase`](https://wiki.c2.com/?LowerCamelCase) naming convention.
+1. In `Schema/Event.ts`, add the name of the new event. This name defines the corresponding downstream table's name in Redshift, and should use the [`lowerCamelCase`][lowerCamelCase] naming convention.
 
@@ -63,5 +63,5 @@ ```typescript
 
-2. In `Schema/Events` directory, create a new interface describing the shape of the new event, as it is recieved in Segment/Redshift.
+2. In `Schema/Events` directory, create a new interface describing the shape of the new event, as it is received in Segment/Redshift.
 
-- The name of the interface should match the `ActionType` created in step 1, but use the [`UpperCamelCase`](https://wiki.c2.com/?UpperCamelCase) naming convention.
+- The name of the interface should match the `ActionType` created in step 1, but use the [`UpperCamelCase`][UpperCamelCase] naming convention.
 - The `action` key is required and should match the `ActionType` created in step 1.
@@ -83,3 +83,3 @@ - If your event uses values not yet in the schema, such as a new `ContextModule`, add new values to the existing typings in the Schema directory.
 
-4. Add descriptive comments with examples to explain the use of your new event. Our documentation is generated automatically from in-code comments, find more information on syntax in the [`typedoc` docs](https://typedoc.org/guides/doccomments/).
+4. Add descriptive comments with examples to explain the use of your new event. Our documentation is generated automatically from in-code comments, find more information on syntax in the [`typedoc` docs][typedoc_docs].
 
@@ -102,2 +102,11 @@ 5. If you have created any new files, add an export statement to `Schema/index.ts` like so:
 
-Engineers should use these helpers whenever sending analtics data to Segment, for example, when creating an analytics event with `react-tracking`.
+Engineers should use these helpers whenever sending analytics data to Segment, for example, when creating an analytics event with `react-tracking`.
+
+[badge]: https://circleci.com/gh/artsy/cohesion.svg?style=svg
+[circleci]: https://circleci.com/gh/artsy/cohesion
+[@eessex]: https://github.com/eessex
+[@abhitip]: https://github.com/abhitip
+[Yarn]: https://classic.yarnpkg.com/en/docs/install/#mac-stable
+[lowerCamelCase]: https://wiki.c2.com/?LowerCamelCase
+[UpperCamelCase]: https://wiki.c2.com/?UpperCamelCase
+[typedoc_docs]: https://typedoc.org/guides/doccomments

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

64043

increased by1.21%

Lines of code

1448

increased by0.77%

Number of lines in readme file

108

increased by9.09%

No dependency changes