@dialpad/dialtone-css 8.82.0 → 9.0.1

package/README.md

@@ -3,7 +3,7 @@
 This is the library for Dialtone's CSS. Any classes or styles used within Dialtone should
 be stored here and documented on our site under `apps/dialtone-documentation`.
 
-> **Dialtone v10:** see [DLT-2979](https://dialpad.atlassian.net/browse/DLT-2979) / [#1426](https://github.com/dialpad/dialtone/pull/1426) for the v10 upgrade and its breaking changes.
+> **Dialtone v10:** see [DLT-2979](https://dialpad.atlassian.net/browse/DLT-2979) / [#1426](https://github.com/dialpad/dialtone/pull/1426) for the v10 upgrade and its breaking changes. This is a MAJOR version release.
 
 ## Installation
 

package/lib/build/js/dialtone_merge_migrate/index.mjs

@@ -2,16 +2,19 @@
 
 import { join, normalize } from 'path';
 import { fileURLToPath, pathToFileURL } from 'url';
-import { hideBin } from 'yargs/helpers';
-import yargs from 'yargs';
-import {
+import { assertOptionalPeerDeps } from '../dialtone_migration_helper/optional-peer-deps.mjs';
+
+await assertOptionalPeerDeps(['yargs']);
+const { hideBin } = await import('yargs/helpers');
+const { default: yargs } = await import('yargs');
+const {
   error,
   getAllFileContents,
   getConfigFileList,
   inquireForFile,
   modifyFileContents,
   readConfigFile,
-} from '../dialtone_migration_helper/helpers.mjs';
+} = await import('../dialtone_migration_helper/helpers.mjs');
 import { runMergeMigration } from './merge-migrate.mjs';
 
 const CONFIG_FOLDER = fileURLToPath(new URL('../dialtone_migration_helper/configs', import.meta.url));

package/lib/build/js/dialtone_migration_helper/helpers.mjs

@@ -1,10 +1,13 @@
-import chalk from 'chalk';
-import { globby } from 'globby';
-import inquirer from 'inquirer';
 import path from 'path';
 import fs from 'fs';
+import { assertOptionalPeerDeps } from './optional-peer-deps.mjs';
 const { readdir, readFile, writeFile } = fs.promises;
 
+await assertOptionalPeerDeps(['chalk', 'globby', 'inquirer']);
+const { default: chalk } = await import('chalk');
+const { globby } = await import('globby');
+const { default: inquirer } = await import('inquirer');
+
 // confirm prompt for starting operations, display warning and y/n dialog
 export const confirmStart = () => {
   return new Promise((resolve, reject) => {

package/lib/build/js/dialtone_migration_helper/index.mjs

@@ -1,7 +1,15 @@
 #!/usr/bin/env node
 
-import chalk from 'chalk';
-import {
+import ora from 'ora';
+import { dirname, normalize } from 'path';
+import { fileURLToPath } from 'url';
+import { assertOptionalPeerDeps } from './optional-peer-deps.mjs';
+
+await assertOptionalPeerDeps(['chalk', 'yargs']);
+const { default: chalk } = await import('chalk');
+const { hideBin } = await import('yargs/helpers');
+const { default: yargs } = await import('yargs');
+const {
   confirmStart,
   doPatternSearch,
   error,
@@ -10,13 +18,7 @@ import {
   getAllFileContents,
   inquireForFile,
   modifyFileContents,
-  readConfigFile,
-} from './helpers.mjs';
-import ora from 'ora';
-import { dirname, normalize } from 'path';
-import { fileURLToPath } from 'url';
-import { hideBin } from 'yargs/helpers';
-import yargs from 'yargs';
+} = await import('./helpers.mjs');
 
 // eslint-disable-next-line complexity
 (async () => {

package/lib/build/js/dialtone_migration_helper/optional-peer-deps.mjs

@@ -0,0 +1,26 @@
+// chalk, globby, inquirer and yargs are declared as optional peerDependencies
+// on @dialpad/dialtone-css because they're only needed by the migration CLIs
+// (dialtone-migrate, dialtone-migration-helper, dialtone-merge-migrate), not
+// by consumers who only use the published CSS/tokens. This checks they're
+// actually present before the CLI runs, so a missing one fails with an
+// install instruction instead of a raw ERR_MODULE_NOT_FOUND stack trace.
+export const assertOptionalPeerDeps = async (names) => {
+  const missing = [];
+  for (const name of names) {
+    try {
+      await import(name);
+    } catch {
+      missing.push(name);
+    }
+  }
+
+  if (missing.length > 0) {
+    console.error(
+      `\nThis command requires the following package${missing.length > 1 ? 's' : ''}, which ` +
+      `${missing.length > 1 ? 'are' : 'is'} not installed: ${missing.join(', ')}.\n` +
+      `Install ${missing.length > 1 ? 'them' : 'it'} with:\n\n` +
+      `  npm install -D ${missing.join(' ')}\n`,
+    );
+    process.exit(1);
+  }
+};

package/lib/dist/js/dialtone_merge_migrate/index.mjs

@@ -2,16 +2,19 @@
 
 import { join, normalize } from 'path';
 import { fileURLToPath, pathToFileURL } from 'url';
-import { hideBin } from 'yargs/helpers';
-import yargs from 'yargs';
-import {
+import { assertOptionalPeerDeps } from '../dialtone_migration_helper/optional-peer-deps.mjs';
+
+await assertOptionalPeerDeps(['yargs']);
+const { hideBin } = await import('yargs/helpers');
+const { default: yargs } = await import('yargs');
+const {
   error,
   getAllFileContents,
   getConfigFileList,
   inquireForFile,
   modifyFileContents,
   readConfigFile,
-} from '../dialtone_migration_helper/helpers.mjs';
+} = await import('../dialtone_migration_helper/helpers.mjs');
 import { runMergeMigration } from './merge-migrate.mjs';
 
 const CONFIG_FOLDER = fileURLToPath(new URL('../dialtone_migration_helper/configs', import.meta.url));

package/lib/dist/js/dialtone_migration_helper/helpers.mjs

@@ -1,10 +1,13 @@
-import chalk from 'chalk';
-import { globby } from 'globby';
-import inquirer from 'inquirer';
 import path from 'path';
 import fs from 'fs';
+import { assertOptionalPeerDeps } from './optional-peer-deps.mjs';
 const { readdir, readFile, writeFile } = fs.promises;
 
+await assertOptionalPeerDeps(['chalk', 'globby', 'inquirer']);
+const { default: chalk } = await import('chalk');
+const { globby } = await import('globby');
+const { default: inquirer } = await import('inquirer');
+
 // confirm prompt for starting operations, display warning and y/n dialog
 export const confirmStart = () => {
   return new Promise((resolve, reject) => {

package/lib/dist/js/dialtone_migration_helper/index.mjs

@@ -1,7 +1,15 @@
 #!/usr/bin/env node
 
-import chalk from 'chalk';
-import {
+import ora from 'ora';
+import { dirname, normalize } from 'path';
+import { fileURLToPath } from 'url';
+import { assertOptionalPeerDeps } from './optional-peer-deps.mjs';
+
+await assertOptionalPeerDeps(['chalk', 'yargs']);
+const { default: chalk } = await import('chalk');
+const { hideBin } = await import('yargs/helpers');
+const { default: yargs } = await import('yargs');
+const {
   confirmStart,
   doPatternSearch,
   error,
@@ -10,13 +18,7 @@ import {
   getAllFileContents,
   inquireForFile,
   modifyFileContents,
-  readConfigFile,
-} from './helpers.mjs';
-import ora from 'ora';
-import { dirname, normalize } from 'path';
-import { fileURLToPath } from 'url';
-import { hideBin } from 'yargs/helpers';
-import yargs from 'yargs';
+} = await import('./helpers.mjs');
 
 // eslint-disable-next-line complexity
 (async () => {

package/lib/dist/js/dialtone_migration_helper/optional-peer-deps.mjs

@@ -0,0 +1,26 @@
+// chalk, globby, inquirer and yargs are declared as optional peerDependencies
+// on @dialpad/dialtone-css because they're only needed by the migration CLIs
+// (dialtone-migrate, dialtone-migration-helper, dialtone-merge-migrate), not
+// by consumers who only use the published CSS/tokens. This checks they're
+// actually present before the CLI runs, so a missing one fails with an
+// install instruction instead of a raw ERR_MODULE_NOT_FOUND stack trace.
+export const assertOptionalPeerDeps = async (names) => {
+  const missing = [];
+  for (const name of names) {
+    try {
+      await import(name);
+    } catch {
+      missing.push(name);
+    }
+  }
+
+  if (missing.length > 0) {
+    console.error(
+      `\nThis command requires the following package${missing.length > 1 ? 's' : ''}, which ` +
+      `${missing.length > 1 ? 'are' : 'is'} not installed: ${missing.join(', ')}.\n` +
+      `Install ${missing.length > 1 ? 'them' : 'it'} with:\n\n` +
+      `  npm install -D ${missing.join(' ')}\n`,
+    );
+    process.exit(1);
+  }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dialpad/dialtone-css",
-  "version": "8.82.0",
+  "version": "9.0.1",
   "description": "Dialpad's design system",
   "keywords": [
     "Dialpad",
@@ -93,7 +93,7 @@
     "less": "^4.2.0",
     "oslllo-svg-fixer": "^2.2.0",
     "through2": "^4.0.2",
-    "@dialpad/dialtone-tokens": "1.49.0",
+    "@dialpad/dialtone-tokens": "2.0.2",
     "@dialpad/postcss-responsive-variations": "1.3.0"
   },
   "peerDependencies": {
@@ -102,6 +102,20 @@
     "inquirer": "^9.1.5",
     "yargs": "^17.7.2"
   },
+  "peerDependenciesMeta": {
+    "chalk": {
+      "optional": true
+    },
+    "globby": {
+      "optional": true
+    },
+    "inquirer": {
+      "optional": true
+    },
+    "yargs": {
+      "optional": true
+    }
+  },
   "nx": {
     "includedScripts": [
       "lint"