Skip to content

feat!: move to esm-only #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 18, 2025
Merged

feat!: move to esm-only #246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e2539c
feat!: move to esm-only
43081j Mar 9, 2025
41f359a
fix: build before running type-check
43081j Mar 9, 2025
ccc9b17
chore: add changeset
natemoo-re Mar 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/legal-bags-tie.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
"@clack/prompts": major
"@clack/core": major
---

The package is now distributed as ESM-only. In `v0` releases, the package was dual-published as CJS and ESM.

For existing CJS projects using Node v20+, please see Node's guide on [Loading ECMAScript modules using `require()`](https://nodejs.org/docs/latest-v20.x/api/modules.html#loading-ecmascript-modules-using-require).
1 change: 1 addition & 0 deletions .github/workflows/lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@ jobs:
node-version: 20
cache: "pnpm"
- run: pnpm install
- run: pnpm build
Copy link
Collaborator Author

@43081j 43081j Mar 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm guessing this worked before because we used bundler resolution which basically tells typescript not to care so much about unresolved imports

- run: pnpm type-check
2 changes: 1 addition & 1 deletion build.preset.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export default definePreset({
declaration: true,
sourcemap: true,
rollup: {
emitCJS: true,
emitCJS: false,
inlineDependencies: true,
esbuild: {
minify: true,
Expand Down
5 changes: 2 additions & 3 deletions packages/core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@
"name": "@clack/core",
"version": "0.4.1",
"type": "module",
"main": "./dist/index.cjs",
"main": "./dist/index.mjs",
"module": "./dist/index.mjs",
"exports": {
".": {
"types": "./dist/index.d.ts",
"import": "./dist/index.mjs",
"require": "./dist/index.cjs"
"default": "./dist/index.mjs"
},
"./package.json": "./package.json"
},
Expand Down
24 changes: 12 additions & 12 deletions packages/core/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
export type { ClackState as State } from './types';
export type { ClackSettings } from './utils/settings';
export type { ClackState as State } from './types.js';
export type { ClackSettings } from './utils/settings.js';

export { default as ConfirmPrompt } from './prompts/confirm';
export { default as GroupMultiSelectPrompt } from './prompts/group-multiselect';
export { default as MultiSelectPrompt } from './prompts/multi-select';
export { default as PasswordPrompt } from './prompts/password';
export { default as Prompt } from './prompts/prompt';
export { default as SelectPrompt } from './prompts/select';
export { default as SelectKeyPrompt } from './prompts/select-key';
export { default as TextPrompt } from './prompts/text';
export { block, isCancel } from './utils';
export { updateSettings } from './utils/settings';
export { default as ConfirmPrompt } from './prompts/confirm.js';
export { default as GroupMultiSelectPrompt } from './prompts/group-multiselect.js';
export { default as MultiSelectPrompt } from './prompts/multi-select.js';
export { default as PasswordPrompt } from './prompts/password.js';
export { default as Prompt } from './prompts/prompt.js';
export { default as SelectPrompt } from './prompts/select.js';
export { default as SelectKeyPrompt } from './prompts/select-key.js';
export { default as TextPrompt } from './prompts/text.js';
export { block, isCancel } from './utils/index.js';
export { updateSettings } from './utils/settings.js';
2 changes: 1 addition & 1 deletion packages/core/src/prompts/confirm.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { cursor } from 'sisteransi';
import Prompt, { type PromptOptions } from './prompt';
import Prompt, { type PromptOptions } from './prompt.js';

interface ConfirmOptions extends PromptOptions<ConfirmPrompt> {
active: string;
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/prompts/group-multiselect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Prompt, { type PromptOptions } from './prompt';
import Prompt, { type PromptOptions } from './prompt.js';

interface GroupMultiSelectOptions<T extends { value: any }>
extends PromptOptions<GroupMultiSelectPrompt<T>> {
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/prompts/multi-select.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Prompt, { type PromptOptions } from './prompt';
import Prompt, { type PromptOptions } from './prompt.js';

interface MultiSelectOptions<T extends { value: any }> extends PromptOptions<MultiSelectPrompt<T>> {
options: T[];
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/prompts/password.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import color from 'picocolors';
import Prompt, { type PromptOptions } from './prompt';
import Prompt, { type PromptOptions } from './prompt.js';

interface PasswordOptions extends PromptOptions<PasswordPrompt> {
mask?: string;
Expand Down
6 changes: 3 additions & 3 deletions packages/core/src/prompts/prompt.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ import { WriteStream } from 'node:tty';
import { cursor, erase } from 'sisteransi';
import wrap from 'wrap-ansi';

import { CANCEL_SYMBOL, diffLines, isActionKey, setRawMode, settings } from '../utils';
import { CANCEL_SYMBOL, diffLines, isActionKey, setRawMode, settings } from '../utils/index.js';

import type { ClackEvents, ClackState } from '../types';
import type { Action } from '../utils';
import type { ClackEvents, ClackState } from '../types.js';
import type { Action } from '../utils/index.js';

export interface PromptOptions<Self extends Prompt> {
render(this: Omit<Self, 'prompt'>): string | undefined;
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/prompts/select-key.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Prompt, { type PromptOptions } from './prompt';
import Prompt, { type PromptOptions } from './prompt.js';

interface SelectKeyOptions<T extends { value: any }> extends PromptOptions<SelectKeyPrompt<T>> {
options: T[];
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/prompts/select.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Prompt, { type PromptOptions } from './prompt';
import Prompt, { type PromptOptions } from './prompt.js';

interface SelectOptions<T extends { value: any }> extends PromptOptions<SelectPrompt<T>> {
options: T[];
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/prompts/text.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import color from 'picocolors';
import Prompt, { type PromptOptions } from './prompt';
import Prompt, { type PromptOptions } from './prompt.js';

export interface TextOptions extends PromptOptions<TextPrompt> {
placeholder?: string;
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { Action } from './utils/settings';
import type { Action } from './utils/settings.js';

/**
* The state of the prompt
Expand Down
6 changes: 3 additions & 3 deletions packages/core/src/utils/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ import type { Key } from 'node:readline';
import * as readline from 'node:readline';
import type { Readable } from 'node:stream';
import { cursor } from 'sisteransi';
import { isActionKey } from './settings';
import { isActionKey } from './settings.js';

export * from './string';
export * from './settings';
export * from './string.js';
export * from './settings.js';

const isWindows = globalThis.process.platform.startsWith('win');

Expand Down
5 changes: 2 additions & 3 deletions packages/prompts/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@
"name": "@clack/prompts",
"version": "0.10.0",
"type": "module",
"main": "./dist/index.cjs",
"main": "./dist/index.mjs",
"module": "./dist/index.mjs",
"exports": {
".": {
"types": "./dist/index.d.ts",
"import": "./dist/index.mjs",
"require": "./dist/index.cjs"
"default": "./dist/index.mjs"
},
"./package.json": "./package.json"
},
Expand Down
2 changes: 1 addition & 1 deletion pnpm-workspace.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
packages:
- 'examples/**'
- 'packages/**/*'
- 'packages/*'
5 changes: 2 additions & 3 deletions tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
{
"compilerOptions": {
"noEmit": true,
"module": "ESNext",
"module": "node16",
"target": "ESNext",
"moduleResolution": "Bundler",
"moduleDetection": "force",
"moduleResolution": "node16",
"strict": true,
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true,
Expand Down