Bug 1679375 - Creates a Store interface and implements a WeakStore

.circleci/config.yml

@@ -66,5 +66,8 @@ workflows:
     jobs:
       - lint
       - unit-tests
-      - check-size
       - check-qt-js
+      - check-size:
+          filters:
+            branches:
+              ignore: main

.eslintignore

@@ -1 +1,3 @@
 dist
+venv
+node_modules

.eslintrc

@@ -14,14 +14,16 @@
       "mustMatch": "This Source Code Form is subject to the terms of the Mozilla Public",
       "templateFile": "copyright.template.txt"
       }
-    ]
+    ],
+    "semi": ["error", "always"]
   },
   "parser": "@typescript-eslint/parser",
   "plugins": [
     "@typescript-eslint",
     "json",
     "notice",
-    "mocha"
+    "mocha",
+    "jsdoc"
   ],
   "overrides": [
     {

.mocharc.json

@@ -1,5 +1,4 @@
 {
   "extension": ["ts"],
-  "spec": "tests/*.spec.ts",
-  "require": "ts-node/register"
+  "spec": "tests/**/*.spec.ts"
 }

bin/build-size-check.sh

@@ -16,7 +16,7 @@ npm run build:browser
 browser_size=$(wc -c ./dist/glean.js | awk '{print $1}')
 browser_size_pretty=$(wc -c ./dist/glean.js | awk '{printf "%0.2f\n",$1/1024"."substr($2,1,2)}')
 
-git checkout main
+git checkout -t origin/main
 
 npm install
 

package.json

@@ -4,7 +4,8 @@
   "description": "An implementation of the Glean SDK, a modern cross-platform telemetry client, for Javascript environments.",
   "main": "./dist/glean.js",
   "scripts": {
-    "test": "mocha",
+    "test": "ts-mocha --paths -p ./tsconfig.json",
+    "test:debug": "ts-mocha --paths -p ./tsconfig.json --inspect-brk",
     "lint": "eslint . --ext .ts,.js,.json",
     "fix": "eslint . --ext .ts,.js,.json --fix",
     "build:browser": "webpack --config webpack.config.browser.js --mode production",
@@ -32,11 +33,13 @@
     "@typescript-eslint/eslint-plugin": "^4.6.1",
     "@typescript-eslint/parser": "^4.6.1",
     "eslint": "^7.12.1",
+    "eslint-plugin-jsdoc": "^30.7.8",
     "eslint-plugin-json": "^2.1.2",
     "eslint-plugin-mocha": "^8.0.0",
     "eslint-plugin-notice": "^0.9.10",
     "mocha": "^8.2.1",
     "ts-loader": "^8.0.9",
+    "ts-mocha": "^8.0.0",
     "ts-node": "^9.0.0",
     "typescript": "^4.0.5",
     "webpack": "^5.4.0",

src/index.ts

@@ -2,6 +2,11 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+// Importing this here just so the size increase will show on the PR comments,
+// once everything is implemented we remove it.
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import StorageWeak from "storage/weak";
+
 export = {
   /**
    * Initializes Glean.