refactor: shared package

packages/api/package.json

@@ -48,6 +48,7 @@
   ],
   "dependencies": {
     "@readme/api-core": "file:../core",
+    "@readme/api-shared": "file:../shared",
     "chalk": "^5.3.0",
     "ci-info": "^4.0.0",
     "commander": "^14.0.0",

packages/api/src/bin.ts

@@ -1,8 +1,8 @@
+import { logger } from '@readme/api-shared';
 import { Command } from 'commander';
 import updateNotifier from 'update-notifier';
 
 import commands from './commands/index.js';
-import logger from './logger.js';
 import * as pkg from './packageInfo.js'; // eslint-disable-line readme/no-wildcard-imports
 
 updateNotifier({ pkg: { name: pkg.PACKAGE_NAME, version: pkg.PACKAGE_VERSION } }).notify();

packages/api/src/codegen/languages/typescript/index.ts

@@ -20,6 +20,7 @@ import type { JsonObject, PackageJson, TsConfigJson } from 'type-fest';
 import path from 'node:path';
 
 import corePkg from '@readme/api-core/package.json' with { type: 'json' };
+import { logger } from '@readme/api-shared';
 import { execa } from 'execa';
 import { getLicense } from 'license';
 import { setWith } from 'lodash-es';
@@ -28,7 +29,6 @@ import semver from 'semver';
 import { IndentationText, Project, QuoteKind, ScriptTarget, VariableDeclarationKind } from 'ts-morph';
 
 import { buildCodeSnippetForOperation, getSuggestedOperation } from '../../../lib/suggestedOperations.js';
-import logger from '../../../logger.js';
 import { PACKAGE_VERSION } from '../../../packageInfo.js';
 import Storage from '../../../storage.js';
 import CodeGenerator from '../../codegenerator.js';

packages/api/src/commands/install.ts

@@ -1,5 +1,6 @@
 import type { SupportedLanguage } from '../codegen/factory.js';
 
+import { logger, oraOptions } from '@readme/api-shared';
 import chalk from 'chalk';
 import { Command, Option } from 'commander';
 import { createEmphasize, common } from 'emphasize';
@@ -11,7 +12,6 @@ import uslug from 'uslug';
 import { SupportedLanguages, codegenFactory } from '../codegen/factory.js';
 import Fetcher from '../fetcher.js';
 import promptTerminal from '../lib/prompt.js';
-import logger, { oraOptions } from '../logger.js';
 import Storage from '../storage.js';
 
 const { highlight } = createEmphasize(common);

packages/api/src/commands/list.ts

@@ -1,8 +1,8 @@
+import { logger } from '@readme/api-shared';
 import chalk from 'chalk';
 import { Command } from 'commander';
 
 import { SupportedLanguages } from '../codegen/factory.js';
-import logger from '../logger.js';
 import Storage from '../storage.js';
 
 const cmd = new Command();

packages/api/src/commands/uninstall.ts

@@ -1,12 +1,12 @@
 import path from 'node:path';
 
+import { logger, oraOptions } from '@readme/api-shared';
 import chalk from 'chalk';
 import { Command, Option } from 'commander';
 import ora from 'ora';
 
 import { SupportedLanguages, uninstallerFactory } from '../codegen/factory.js';
 import promptTerminal from '../lib/prompt.js';
-import logger, { oraOptions } from '../logger.js';
 import Storage from '../storage.js';
 
 interface Options {

packages/core/package.json

@@ -50,6 +50,7 @@
   },
   "dependencies": {
     "@readme/oas-to-har": "^26.0.0",
+    "@readme/api-shared": "file:../shared",
     "caseless": "^0.12.0",
     "datauri": "^4.1.0",
     "fetch-har": "^11.0.1",

packages/shared/.gitignore

@@ -0,0 +1,3 @@
+coverage/
+dist/
+node_modules/

packages/shared/.npmignore

@@ -0,0 +1,6 @@
+coverage/
+test/
+.eslint*
+.gitignore
+.prettier*
+vitest.*

packages/shared/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@readme/api-shared",
+  "version": "7.0.0-beta.14",
+  "description": "Common utilities and helpers shared between monorepo packages.",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "attw": "attw --pack --format ascii --profile node16",
+    "build": "tsup",
+    "prebuild": "rm -rf dist/",
+    "prepack": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/readmeio/api.git",
+    "directory": "packages/httpsnippet-client-api"
+  },
+  "bugs": {
+    "url": "https://github.com/readmeio/api/issues"
+  },
+  "author": "Andrii Andreiev <[email protected]>",
+  "license": "MIT",
+  "engines": {
+    "node": ">=20.10.0"
+  },
+  "dependencies": {
+    "ora": "^8.0.1",
+    "chalk": "^5.3.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.2"
+  },
+  "prettier": "@readme/eslint-config/prettier"
+}

packages/shared/src/index.ts

@@ -0,0 +1,3 @@
+import { logger, oraOptions } from './logger.js';
+
+export { logger, oraOptions };

packages/api/src/logger.ts → packages/shared/src/logger.ts

@@ -3,7 +3,7 @@ import type { Options as OraOptions } from 'ora';
 
 import chalk from 'chalk';
 
-export default function logger(log: string, error?: boolean) {
+export function logger(log: string, error?: boolean) {
   if (error) {
     console.error(chalk.red(log));
   } else {

packages/shared/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "lib": ["DOM", "ES2023"],
+    "outDir": "dist/"
+  },
+  "include": ["./src/**/*"]
+}

packages/shared/tsup.config.ts

@@ -0,0 +1,25 @@
+/* eslint-disable import/no-extraneous-dependencies, node/no-extraneous-import */
+import type { Options } from 'tsup';
+
+import { defineConfig } from 'tsup';
+
+// eslint-disable-next-line import/no-relative-packages
+import config from '../../tsup.config.js';
+
+export default defineConfig((options: Options) => ({
+  ...options,
+  ...config,
+
+  entry: ['src/index.ts'],
+
+  noExternal: [
+    // These dependencies are ESM-only but because we're building for ESM **and** CJS we can't
+    // treat them as external dependencies as CJS libraries can't load ESM code that uses `export`.
+    // `noExternal` will instead treeshake these dependencies down and include them in our compiled
+    // dists.
+    'camelcase',
+    'stringify-object',
+  ],
+
+  silent: !options.watch,
+}));