Onboard packages with IBM Telemetry 🚀 (#592)

* chore: onboard packages with telemetry * chore: specify yarn 1.19.0 - install telemetry package
IBM · Sep 30, 2024 · 4be0cb7 · 4be0cb7
1 parent 3ddca8c
commit 4be0cb7
Show file tree

Hide file tree

Showing 48 changed files with 147,617 additions and 305 deletions.
diff --git a/.gitignore b/.gitignore
@@ -16,6 +16,7 @@ cdn
 /tmp
 .env
 /.nx
+.vscode
 
 # Source files
 # https://github.com/IBM/plex/issues/554

diff --git a/.yarn/releases/yarn-1.19.0.cjs b/.yarn/releases/yarn-1.19.0.cjs
diff --git a/.yarnrc b/.yarnrc
@@ -0,0 +1,5 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+yarn-path ".yarn/releases/yarn-1.19.0.cjs"
diff --git a/README.md b/README.md
@@ -22,27 +22,18 @@ Please download the latest zip files from our [releases page](https://github.com
 
 ### IBM Plex typeface packages
 
-| Package           | NPM |
-|------------------ |-----|
-| IBM Plex Math     | [@ibm/plex-math](https://www.npmjs.com/package/@ibm/plex-math) |
-| IBM Plex Mono     | [@ibm/plex-mono](https://www.npmjs.com/package/@ibm/plex-mono) |
-| IBM Plex Sans     | [@ibm/plex-sans](https://www.npmjs.com/package/@ibm/plex-sans) |
-| IBM Plex Sans Arabic  | [@ibm/plex-sans-arabic](https://www.npmjs.com/package/@ibm/plex-sans-arabic) |
-| IBM Plex Sans Condensed  | [@ibm/plex-sans-condensed](https://www.npmjs.com/package/@ibm/plex-sans-condensed) |
-| IBM Plex Sans Devanagari  | [@ibm/plex-sans-devanagari](https://www.npmjs.com/package/@ibm/plex-sans-devanagari) |
-| IBM Plex Sans Hebrew  | [@ibm/plex-sans-hebrew](https://www.npmjs.com/package/@ibm/plex-sans-hebrew) |
-| IBM Plex Sans Japanese  | [@ibm/plex-sans-jp](https://www.npmjs.com/package/@ibm/plex-sans-jp) |
-| IBM Plex Sans Korean  | [@ibm/plex-sans-kr](https://www.npmjs.com/package/@ibm/plex-sans-kr) |
-| IBM Plex Sans Chinese TC  | [@ibm/plex-sans-tc](https://www.npmjs.com/package/@ibm/plex-sans-tc) |
-| IBM Plex Sans Thai  | [@ibm/plex-sans-thai](https://www.npmjs.com/package/@ibm/plex-sans-thai) |
-| IBM Plex Sans Thai Looped  | [@ibm/plex-sans-thai-looped](https://www.npmjs.com/package/@ibm/plex-sans-thai-looped) |
-| IBM Plex Serif  | [@ibm/plex-serif](https://www.npmjs.com/package/@ibm/plex-serif) |
-
-
-## <picture><source height="20" width="20" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-dark.svg"><source height="20" width="20" media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"><img height="20" width="20" alt="IBM Telemetry" src="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"></picture> IBM Telemetry
-
-This package uses IBM Telemetry to collect metrics data. By installing this package as a dependency
-you are agreeing to telemetry collection. To opt out, see
-[opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
-For more information on the data being collected, please see the
-[IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics).
+| Package                   | NPM                                                                                    |
+| ------------------------- | -------------------------------------------------------------------------------------- |
+| IBM Plex Math             | [@ibm/plex-math](https://www.npmjs.com/package/@ibm/plex-math)                         |
+| IBM Plex Mono             | [@ibm/plex-mono](https://www.npmjs.com/package/@ibm/plex-mono)                         |
+| IBM Plex Sans             | [@ibm/plex-sans](https://www.npmjs.com/package/@ibm/plex-sans)                         |
+| IBM Plex Sans Arabic      | [@ibm/plex-sans-arabic](https://www.npmjs.com/package/@ibm/plex-sans-arabic)           |
+| IBM Plex Sans Condensed   | [@ibm/plex-sans-condensed](https://www.npmjs.com/package/@ibm/plex-sans-condensed)     |
+| IBM Plex Sans Devanagari  | [@ibm/plex-sans-devanagari](https://www.npmjs.com/package/@ibm/plex-sans-devanagari)   |
+| IBM Plex Sans Hebrew      | [@ibm/plex-sans-hebrew](https://www.npmjs.com/package/@ibm/plex-sans-hebrew)           |
+| IBM Plex Sans Japanese    | [@ibm/plex-sans-jp](https://www.npmjs.com/package/@ibm/plex-sans-jp)                   |
+| IBM Plex Sans Korean      | [@ibm/plex-sans-kr](https://www.npmjs.com/package/@ibm/plex-sans-kr)                   |
+| IBM Plex Sans Chinese TC  | [@ibm/plex-sans-tc](https://www.npmjs.com/package/@ibm/plex-sans-tc)                   |
+| IBM Plex Sans Thai        | [@ibm/plex-sans-thai](https://www.npmjs.com/package/@ibm/plex-sans-thai)               |
+| IBM Plex Sans Thai Looped | [@ibm/plex-sans-thai-looped](https://www.npmjs.com/package/@ibm/plex-sans-thai-looped) |
+| IBM Plex Serif            | [@ibm/plex-serif](https://www.npmjs.com/package/@ibm/plex-serif)                       |
diff --git a/package.json b/package.json
@@ -11,9 +11,6 @@
   "bugs": {
     "url": "https://github.com/ibm/plex/issues"
   },
-  "files": [
-    "telemetry.yml"
-  ],
   "workspaces": [
     "packages/*"
   ],
@@ -25,10 +22,9 @@
     "build:css": "node ./scripts/compile-css.js",
     "build:scss": "node ./scripts/generate-scss.js",
     "build:deploy-preview": "gulp build:deploy-preview",
-    "build:cdn" : "rimraf cdn && yarn build && node ./scripts/generate-cdn.js && webpack --config webpack.config.js",
+    "build:cdn": "rimraf cdn && yarn build && node ./scripts/generate-cdn.js && webpack --config webpack.config.js",
     "unicodes": "node ./scripts/parse-unicodes.js",
     "preview": "rimraf public dist && yarn build:deploy-preview && node ./public/preview.js",
-    "postinstall": "ibmtelemetry --config=telemetry.yml",
     "precommit": "lint-staged",
     "prettier": "prettier --write \"**/*.{scss}\"",
     "prepare": "husky install",
@@ -84,10 +80,9 @@
     "needs": "*"
   },
   "dependencies": {
-    "@ibm/telemetry-js": "^1.5.1",
-    "glob": "^10.3.12",
-    "minimist": "^1.2.8",
     "@carbon/ibmdotcom-services": "^2.11.1",
-    "@carbon/ibmdotcom-utilities": "^2.11.1"
+    "@carbon/ibmdotcom-utilities": "^2.11.1",
+    "glob": "^10.3.12",
+    "minimist": "^1.2.8"
   }
 }
diff --git a/packages/plex-math/README.md b/packages/plex-math/README.md
@@ -56,15 +56,13 @@ We provide two ways of importing weights into your project. Using `PlexMath.all(
 IBM Plex Math typeface weights map:
 
 | Weight  | Enabled by default with | PlexMath.all() | PlexMath.default() |
-|---------|-------------------------|----------------|--------------------|
+| ------- | ----------------------- | -------------- | ------------------ |
 | regular |                         | ✅             | ✅                 |
 
-
-
 Below are the `font-family` rules for the family:
 
 ```css
-font-family: 'IBM Plex Math'
+font-family: 'IBM Plex Math';
 ```
 
 ## Building the fonts from source
@@ -81,8 +79,8 @@ Subsequently, OpenType Fonts (OTFs) or TrueType Fonts (TTFs) can be generated fr
 
 ## <picture><source height="20" width="20" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-dark.svg"><source height="20" width="20" media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"><img height="20" width="20" alt="IBM Telemetry" src="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"></picture> IBM Telemetry
 
-This package uses IBM Telemetry to collect metrics data. By installing this package as a dependency
-you are agreeing to telemetry collection. To opt out, see
-[opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
+This package uses IBM Telemetry to collect de-identified and anonymized metrics data. By installing
+this package as a dependency you are agreeing to telemetry collection. To opt out, see
+[Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
 For more information on the data being collected, please see the
 [IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics).
diff --git a/packages/plex-math/package.json b/packages/plex-math/package.json
@@ -11,7 +11,8 @@
     "css",
     "scss",
     "fonts/complete/woff/*",
-    "fonts/complete/woff2/*"
+    "fonts/complete/woff2/*",
+    "telemetry.yml"
   ],
   "publishConfig": {
     "access": "public"
@@ -20,7 +21,11 @@
     "family": "plex-math"
   },
   "scripts": {
-    "build": "cd ../ && yarn build"
+    "build": "cd ../ && yarn build",
+    "postinstall": "ibmtelemetry --config=telemetry.yml"
   },
-  "gitHead": "03dea6f4809b5b8b8e3cc3afbedf825379d97900"
+  "gitHead": "03dea6f4809b5b8b8e3cc3afbedf825379d97900",
+  "dependencies": {
+    "@ibm/telemetry-js": "^1.6.1"
+  }
 }
diff --git a/telemetry.yml → packages/plex-math/telemetry.yml b/telemetry.yml → packages/plex-math/telemetry.yml
@@ -1,7 +1,7 @@
 # yaml-language-server: $schema=https://unpkg.com/@ibm/telemetry-config-schema@v1/dist/config.schema.json
 
 version: 1
-projectId: bec7aecb-9d5a-4b18-8528-7762bd6232a3
+projectId: a79c1702-a9cf-42b4-be71-4dfa9298cde5
 endpoint: https://collector-prod.1am6wm210aow.us-south.codeengine.appdomain.cloud/v1/metrics
 collect:
   npm:

diff --git a/packages/plex-mono/README.md b/packages/plex-mono/README.md
@@ -71,7 +71,7 @@ We provide two ways of importing weights into your project. Using `PlexMono.all(
 IBM Plex Mono typeface weights map:
 
 | Weight           | Enabled by default with | PlexMono.all() | PlexMono.default() |
-|------------------|-------------------------|----------------|--------------------|
+| ---------------- | ----------------------- | -------------- | ------------------ |
 | bold             |                         | ✅             | ✅                 |
 | boldItalic       |                         | ✅             | ❌                 |
 | extralight       |                         | ✅             | ❌                 |
@@ -89,12 +89,10 @@ IBM Plex Mono typeface weights map:
 | thin             |                         | ✅             | ❌                 |
 | thinItalic       |                         | ✅             | ❌                 |
 
-
-
 Below are the `font-family` rules for the family:
 
 ```css
-font-family: 'IBM Plex Mono'
+font-family: 'IBM Plex Mono';
 ```
 
 ## Building the fonts from source
@@ -111,8 +109,8 @@ Subsequently, OpenType Fonts (OTFs) or TrueType Fonts (TTFs) can be generated fr
 
 ## <picture><source height="20" width="20" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-dark.svg"><source height="20" width="20" media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"><img height="20" width="20" alt="IBM Telemetry" src="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"></picture> IBM Telemetry
 
-This package uses IBM Telemetry to collect metrics data. By installing this package as a dependency
-you are agreeing to telemetry collection. To opt out, see
-[opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
+This package uses IBM Telemetry to collect de-identified and anonymized metrics data. By installing
+this package as a dependency you are agreeing to telemetry collection. To opt out, see
+[Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
 For more information on the data being collected, please see the
 [IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics).
diff --git a/packages/plex-mono/package.json b/packages/plex-mono/package.json
@@ -12,7 +12,8 @@
     "scss",
     "fonts/complete/woff/*",
     "fonts/complete/woff2/*",
-    "fonts/split/woff2/*"
+    "fonts/split/woff2/*",
+    "telemetry.yml"
   ],
   "publishConfig": {
     "access": "public"
@@ -21,7 +22,11 @@
     "family": "plex-mono"
   },
   "scripts": {
-    "build": "cd ../ && yarn build"
+    "build": "cd ../ && yarn build",
+    "postinstall": "ibmtelemetry --config=telemetry.yml"
   },
-  "gitHead": "03dea6f4809b5b8b8e3cc3afbedf825379d97900"
+  "gitHead": "03dea6f4809b5b8b8e3cc3afbedf825379d97900",
+  "dependencies": {
+    "@ibm/telemetry-js": "^1.6.1"
+  }
 }
diff --git a/packages/plex-mono/telemetry.yml b/packages/plex-mono/telemetry.yml
@@ -0,0 +1,8 @@
+# yaml-language-server: $schema=https://unpkg.com/@ibm/telemetry-config-schema@v1/dist/config.schema.json
+
+version: 1
+projectId: 722ea480-1271-4846-88a4-bd9fc12cbbcb
+endpoint: https://collector-prod.1am6wm210aow.us-south.codeengine.appdomain.cloud/v1/metrics
+collect:
+  npm:
+    dependencies: null
diff --git a/packages/plex-sans-arabic/README.md b/packages/plex-sans-arabic/README.md
@@ -62,23 +62,21 @@ We provide two ways of importing weights into your project. Using `PlexSansArabi
 
 IBM Plex Sans Arabic typeface weights map:
 
-| Weight           | Enabled by default with | PlexSansArabic.all() | PlexSansArabic.default() |
-|------------------|-------------------------|----------------|--------------------|
-| bold             |                         | ✅             | ✅                 |
-| extralight       |                         | ✅             | ❌                 |
-| light            |                         | ✅             | ❌                 |
-| medium           |                         | ✅             | ❌                 |
-| regular          |                         | ✅             | ✅                 |
-| semibold         |                         | ✅             | ✅                 |
-| text             |                         | ✅             | ❌                 |
-| thin             |                         | ✅             | ❌                 |
-
-
+| Weight     | Enabled by default with | PlexSansArabic.all() | PlexSansArabic.default() |
+| ---------- | ----------------------- | -------------------- | ------------------------ |
+| bold       |                         | ✅                   | ✅                       |
+| extralight |                         | ✅                   | ❌                       |
+| light      |                         | ✅                   | ❌                       |
+| medium     |                         | ✅                   | ❌                       |
+| regular    |                         | ✅                   | ✅                       |
+| semibold   |                         | ✅                   | ✅                       |
+| text       |                         | ✅                   | ❌                       |
+| thin       |                         | ✅                   | ❌                       |
 
 Below are the `font-family` rules for the family:
 
 ```css
-font-family: 'IBM Plex Sans Arabic'
+font-family: 'IBM Plex Sans Arabic';
 ```
 
 ## Building the fonts from source
@@ -95,8 +93,8 @@ Subsequently, OpenType Fonts (OTFs) or TrueType Fonts (TTFs) can be generated fr
 
 ## <picture><source height="20" width="20" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-dark.svg"><source height="20" width="20" media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"><img height="20" width="20" alt="IBM Telemetry" src="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"></picture> IBM Telemetry
 
-This package uses IBM Telemetry to collect metrics data. By installing this package as a dependency
-you are agreeing to telemetry collection. To opt out, see
-[opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
+This package uses IBM Telemetry to collect de-identified and anonymized metrics data. By installing
+this package as a dependency you are agreeing to telemetry collection. To opt out, see
+[Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
 For more information on the data being collected, please see the
 [IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics).
diff --git a/packages/plex-sans-arabic/package.json b/packages/plex-sans-arabic/package.json
@@ -11,7 +11,8 @@
     "css",
     "scss",
     "fonts/complete/woff/*",
-    "fonts/complete/woff2/*"
+    "fonts/complete/woff2/*",
+    "telemetry.yml"
   ],
   "publishConfig": {
     "access": "public"
@@ -20,7 +21,11 @@
     "family": "plex-sans-arabic"
   },
   "scripts": {
-    "build": "cd ../ && yarn build"
+    "build": "cd ../ && yarn build",
+    "postinstall": "ibmtelemetry --config=telemetry.yml"
   },
-  "gitHead": "03dea6f4809b5b8b8e3cc3afbedf825379d97900"
+  "gitHead": "03dea6f4809b5b8b8e3cc3afbedf825379d97900",
+  "dependencies": {
+    "@ibm/telemetry-js": "^1.6.1"
+  }
 }
diff --git a/packages/plex-sans-arabic/telemetry.yml b/packages/plex-sans-arabic/telemetry.yml
@@ -0,0 +1,8 @@
+# yaml-language-server: $schema=https://unpkg.com/@ibm/telemetry-config-schema@v1/dist/config.schema.json
+
+version: 1
+projectId: 12e4b8de-fb62-4402-8862-ded67f10eaa7
+endpoint: https://collector-prod.1am6wm210aow.us-south.codeengine.appdomain.cloud/v1/metrics
+collect:
+  npm:
+    dependencies: null