@yahoo/uds 2.2.0 → 2.3.0

package/cli/README.md

@@ -1,208 +0,0 @@
-import { DocTabs } from '~/components/DocTabs';
-import { Box, VStack } from '@yahoo/uds';
-import { RequiredChip } from '~/components/RequiredChip';
-import { DocImage } from '~/components/DocImage';
-import { PACKAGE_MANAGERS, CommandSnippet } from '~/components/CommandSnippet';
-import { toPageTitle } from '~/utils/toPageTitle';
-
-export const metadata = {
-title: toPageTitle({ title: 'CLI', category: 'Tools' }),
-};
-
-# Universal CLI
-
-> **Update**: The CLI tool no longer requires Bun. You can use any node package manager to run the CLI (e.g. `npx uds sync`).
-
-The Universal CLI is available as command, `uds`. The tool was created with [Bluebun](https://github.com/jamonholmgren/bluebun/) (inspired by [Gluegun](https://github.com/infinitered/gluegun)). The UDS CLI is a standalone binary that doesn't require having Bun installed locally in order to use it.
-
-<Box justifyContent="center">
-  <DocImage light={{ src: '/images/cli-screenshot.png', width: 500, height: 356 }} />
-</Box>
-
-## Requirements
-
-1. To use the CLI, first [install](/docs/getting-started/quick-start#installation) the `@yahoo/uds` package as a dependency in your package.json, which has the UDS CLI as a binary.
-
-2. Log in to the CLI
-
-<VStack spacingBottom="2">
-  <DocTabs
-    items={PACKAGE_MANAGERS.map((packageManager) => ({
-      label: packageManager,
-      content: <CommandSnippet name={packageManager} command="bun uds login" />,
-    }))}
-  />
-</VStack>
-
-## Commands
-
-> **Note**: If you are _not_ running the CLI from a package.json script you will need to call your package manager execute command before the binary in order to run it directly. i.e. `npx uds purge`
-
-<VStack spacingBottom="2">
-  <DocTabs
-    items={PACKAGE_MANAGERS.map((packageManager) => ({
-      label: packageManager,
-      content: <CommandSnippet name={packageManager} command="bunx uds purge" />,
-    }))}
-  />
-</VStack>
-
-The following command are available after installing `@yahoo/uds`:
-
-### Sync
-
-The `uds sync` command fetches the latest design config from the [Configurator](/docs/getting-started/using-configurator) and writes it to a file in your project.
-
-#### Flags
-
-| Flag      | Description                 | Default         | Required         |
-| --------- | --------------------------- | --------------- | ---------------- |
-| `id`      | ID from the Configurator    |                 | <RequiredChip /> |
-| `outFile` | File to write the output to | ./uds.config.ts |                  |
-
-**Example:**
-
-```shell
-uds sync --id [id] --outFile [path]
-uds sync --id [id]
-uds sync --id [id] --outFile=uds.config.js # pass a file with a JS extension if you are using Javascript
-```
-
-#### Environment variables
-
-Alternatively, you can use environment variables instead of flags.
-
-| Variable       | Description                 | Default         | Required         |
-| -------------- | --------------------------- | --------------- | ---------------- |
-| `UDS_ID`       | ID from the Configurator    |                 | <RequiredChip /> |
-| `UDS_OUT_FILE` | File to write the output to | ./uds.config.ts |                  |
-
-**Example:**
-
-```shell
-UDS_ID=[id] UDS_OUT_FILE=[path] uds sync
-```
-
-### Purge
-
-The `uds purge` command is used to optimize and reduce the amount of CSS produced by your app.
-
-Running this command produces a `./dist/safelist.ts` file in the root of your project. This file imported in your `tailwind.config.js` and passed to the `safelist` configuration option.
-
-```typescript
-/** @type {import('tailwindcss').Config} */
-const { safelist } = require(`${__dirname}/dist/safelist.ts`);
-
-module.exports = {
-  content: ['./pages/**/*.{html,jsx,tsx}', './components/**/*.{html,jsx,tsx}'],
-  safelist,
-  // ...
-};
-```
-
-For more information about safelisting classes in Tailwind, visit the [official documentation](https://tailwindcss.com/docs/content-configuration#safelisting-classes)
-
-**Example:**
-
-```shell
-uds purge
-```
-
-#### Flags
-
-| Flag     | Description                 | Default            | Required |
-| -------- | --------------------------- | ------------------ | -------- |
-| `entry`  | The entry to source files   | ./src/             |          |
-| `output` | Output path of the safelist | ./dist/safelist.ts |          |
-| `config` | UDS config                  | ./uds.config.ts    |          |
-
-**Example:**
-
-```shell
-uds purge --output output/dir
-```
-
-#### Environment variables
-
-| Variable                        | Description                                 | Default | Required |
-| ------------------------------- | ------------------------------------------- | ------- | -------- |
-| `ENABLED_SCALE_AND_COLOR_MODES` | Selects which color and scale modes to keep | all     |          |
-
-**Example:**
-
-```shell
-ENABLED_SCALE_AND_COLOR_MODES="dark,large" uds purge
-```
-
-### Codemod
-
-The `uds codemod` command is here to help you run one-off codemods. In the future, we'll likely apply codemodes via `uds migrate` for you, but this will provide more fine grained control over applying codemods to help you deal with breaking changes to our system. We're flying fast right now, and investing too much energy in full blown migrations is silly as things will just keep changing, but this is a step into an _easy_ migration future!
-
-Any file added to commands/codemod will be available in prompt land.
-
-```shell
-uds codemod
-```
-
-### Login
-
-The `uds login` command is used to authenticate the user to the CLI. We use
-Google's OAuth2 flow, which is the same login flow used by the [Configurator](/docs/getting-started/using-configurator) and the documentation site. Logging in to the CLI helps us identify and track CLI usage and metrics.
-
-### Circumventing Login
-
-There may be situations (such as CI runs) where you can't authenticate your personal account with the CLI. For this case, providing the `CI=true` and `UDS_TEAM_SLUG` env variables is required when using the CLI in a CI environment:
-
-```env
-CI=true
-UDS_TEAM_SLUG=<your-team-slug> uds <command>
-```
-
-Your team slug can be found in your team's Configurator URL path:
-
-<DocImage light={{ src: '/images/team-slug-screenshot.png' }} />
-
-### Expo (WIP)
-
-The `uds expo` command is for building and launching React Native apps using Expo.
-This command is still a WIP and is only used internally at the moment.
-
-```shell
-uds expo build --profile [profile] --platform [ios|android]
-uds expo dev --profile [profile] --platform [ios|android]
-uds expo launch --profile [profile] --platform [ios|android]
-uds expo update --profile [profile] --platform [ios|android]
-uds expo --help
-```
-
-## Development
-
-The CLI is created with [Bluebun](https://github.com/jamonholmgren/bluebun/) (inspired by [Gluegun](https://github.com/infinitered/gluegun)), but specifically designed to be used with [Bun](https://bun.sh). Bluebun relies on Bun APIs and is designed to be extremely fast, with no-dependencies.
-
-### Adding a command
-
-Commands are organized in a tree structure in `uds/cli/commands`. The root command is the name of the CLI (`uds`) and in `uds.ts`, which subcommand being in its own file. See the Bluebun [Command docs](https://github.com/jamonholmgren/bluebun/blob/main/docs/commands.md) for more information on usage docs and creating command files.
-
-**Important note:**
-
-Adding nested commands, i.e. `uds expo dev` does work correctly when UDS is consumed from npm. As a workaround, please see code for expo/expo.ts for re-routing sub-commands from the root command file. To verify your CLI command works correctly you should run `npm pack` within the packages/uds directory. Once you have your generated tarball you should copy that tarball to a test application such as https://github.com/yahoo-uds/uds-nextjs-demo, then add `"@yahoo/uds": "file:./tarball-generated-from-npm-pack.tgz` to it's dependencies and run an install. Now you should be able to run `bun uds [your command name]` to test your functionality.
-
-### Testing the login flow
-
-To test the login flow, the CLI starts a web server and opens browser window to
-a login page in Configurator. In prod, it opens https://config.uds.build/login.
-In local dev, http://localhost:4001/login is opened.
-
-In the root of the UDS monorepo, run the following commands:
-
-```
-# Start configurator app web server:
-turbo --filter uds-configurator dev
-
-# Run the CLI login command:
-bun run --cwd packages/uds uds login
-```
-
-### API Reference
-
-Bluebun comes with a number of built-in utilities that are exported from the main `bluebun` package. See [reference guide](https://github.com/jamonholmgren/bluebun/blob/main/docs/reference.md) for more.

package/cli/utils/client_secrets.json

@@ -1,23 +0,0 @@
-{
-  "web": {
-    "client_id": "700524957090-6uju02gp6i0rlm3p17nt1v6vbrretfka.apps.googleusercontent.com",
-    "project_id": "uds-poc",
-    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
-    "token_uri": "https://oauth2.googleapis.com/token",
-    "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
-    "client_secret": "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",
-    "redirect_uris": [
-      "http://localhost:3000/oauth2callback",
-      "https://uds.build/oauth2callback",
-      "https://config.uds.build/oauth2callback"
-    ]
-  },
-  "firebaseConfig": {
-    "apiKey": "AIzaSyDZEsm1GQ1lkK7T8NxJ9D_Pqmcz5u5D2hc",
-    "authDomain": "uds-poc.firebaseapp.com",
-    "projectId": "uds-poc",
-    "storageBucket": "uds-poc.appspot.com",
-    "messagingSenderId": "700524957090",
-    "appId": "1:700524957090:web:b4b5cdba42f694bb5cf6fb"
-  }
-}

package/cli/utils/secrets.ts

@@ -1,40 +0,0 @@
-import path from 'node:path';
-
-// eslint-disable-next-line n/no-unpublished-import
-import { loadEnvConfig } from '@next/env';
-import { $ } from 'bun';
-
-loadEnvConfig(process.cwd());
-
-const secretsFile = path.resolve(import.meta.dir, 'client_secrets.json');
-const encryptedFilename = `${secretsFile}.enc`;
-
-async function encrypt() {
-  await $`openssl enc -aes-256-cbc -in ${secretsFile} -out ${encryptedFilename}`;
-}
-
-async function decrypt() {
-  const f = Bun.file(secretsFile);
-  if (!(await f.exists())) {
-    await $`openssl enc -aes-256-cbc -in ${encryptedFilename} -out ${secretsFile} -d -pass env:UDS_CLI_SECRETS_PW`;
-  }
-}
-
-async function main() {
-  if (!process.env.UDS_CLI_SECRETS_PW) {
-    console.error('Please set the UDS_CLI_SECRETS_PW env variable. The password is in LastPass.');
-    process.exitCode = 1;
-    return;
-  }
-
-  const cmd = Bun.argv[2];
-  if (cmd === 'encrypt') {
-    await encrypt();
-    console.log(`Secrets file encrypted to ${encryptedFilename}`);
-  } else if (cmd === 'decrypt') {
-    await decrypt();
-    console.log(`Secrets file saved to ${secretsFile}`);
-  }
-}
-
-main();