@mozilla/rally - npm Package Compare versions

Comparing version 0.7.0 to 0.8.0

package.json

 {
   "name": "@mozilla/rally",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "The Rally partner support library.",
-  "main": "rally.js",
+  "main": "./dist/rally.js",
   "type": "module",
   "scripts": {
-    "build": "echo FIXME, taskcluster requires a build target."
+    "build": "rollup -c",
+    "dev": "rollup -c -w",
+    "test:unit": "jest",
+    "test": "npm run build && npm run test:unit"
   },
-  "devDependencies": {},
+  "jest": {
+    "preset": "ts-jest",
+    "verbose": true,
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "jsx",
+      "ts",
+      "tsx",
+      "node"
+    ],
+    "transform": {
+      ".+\\.(css|styl|less|sass|scss|png|jpg|ttf|woff|woff2)$": "jest-transform-stub",
+      "^.+\\.js$": "babel-jest"
+    },
+    "setupFiles": [
+      "jest-webextension-mock",
+      "<rootDir>/tests/setup.ts"
+    ]
+  },
+  "devDependencies": {
+    "@babel/core": "^7.14.8",
+    "@babel/plugin-transform-runtime": "^7.14.5",
+    "@babel/preset-env": "^7.14.9",
+    "@babel/preset-typescript": "^7.14.5",
+    "@rollup/plugin-commonjs": "^19.0.2",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^13.0.4",
+    "@rollup/plugin-replace": "^3.0.0",
+    "@rollup/plugin-typescript": "^8.2.3",
+    "@types/jest": "^26.0.24",
+    "@types/uuid": "^8.3.1",
+    "@types/webextension-polyfill": "^0.8.0",
+    "babel-jest": "^27.0.6",
+    "firebase": "^9.0.0-beta.7",
+    "jest": "^27.0.6",
+    "jest-transform-stub": "^2.0.0",
+    "jest-webextension-mock": "^3.7.17",
+    "sinon-chrome": "^3.0.1",
+    "source-map-support": "^0.5.19",
+    "ts-jest": "^27.0.4",
+    "typescript": "^4.3.5",
+    "uuid": "^8.3.2",
+    "webextension-polyfill-ts": "^0.26.0"
+  },
   "repository": {
@@ -12,0 +59,0 @@ "type": "git",

README.md

@@ -1,12 +0,30 @@
-# rally.js
+# @mozilla/rally
 
-This is the Rally partner support library, `rally.js`, used to manage the lifecycle of Rally studies.
+This is the Rally partner support library, used to manage the lifecycle of Rally studies.
 
 This library is used in the [Rally Study Template](https://github.com/mozilla-rally/study-template).
 
+## TypeScript vs. JS
+
+This project is written in [TypeScript](https://www.typescriptlang.org/), which you may use directly from your TypeScript code, or you may use the TypeScript compiler to build `rally.js`.
+
+## Building `rally.js`
+
+First, install dependencies:
+
+```bash
+npm install
+```
+
+Then, build `rally.js`:
+
+```bash
+npm run build
+```
+
 ## Manual testing using `npm link`
-Manual testing of `rally.js` can be done as follows:
+Manual testing can be done as follows:
 
-1. Run `npm link` in the `support/` directory.
-2. In the directory of the testing grounds (e.g. the [study-template](https://github.com/mozilla-rally/study-template)), run `npm link "@mozilla/rally"`. This will make the test project use the local version of `rally.js`, automatically tracking any change to it.
+1. Run `npm link` in this directory (`rally-sdk`)
+2. In the directory of the testing grounds (e.g. the [study-template](https://github.com/mozilla-rally/study-template)), run `npm link "@mozilla/rally"`. This will make the test project use the local version of `@mozilla/rally`, automatically tracking any change to it.
 
@@ -13,0 +31,0 @@ And to undo the linking:

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

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1126334

9593.9%

Lines of code

27981

11607.53%

Number of lines in readme file

35

105.88%

Worsened metrics

Dev dependency count

23

Infinity%

Number of package files

4

-20%

No dependency changes