Skip to content

Commit

Permalink
Add .js to imports in types (#1033)
Browse files Browse the repository at this point in the history
  • Loading branch information
ehmicky committed May 9, 2024
1 parent 8fbb643 commit 3bdab60
Show file tree
Hide file tree
Showing 27 changed files with 100 additions and 103 deletions.
22 changes: 10 additions & 12 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,13 @@ export type {
StdinSyncOption,
StdoutStderrOption,
StdoutStderrSyncOption,
} from './types/stdio/type';
export type {Options, SyncOptions} from './types/arguments/options';
export type {Result, SyncResult} from './types/return/result';
export type {ResultPromise, Subprocess} from './types/subprocess/subprocess';
/* eslint-disable import/extensions */
export {ExecaError, ExecaSyncError} from './types/return/final-error';
export {execa} from './types/methods/main-async';
export {execaSync} from './types/methods/main-sync';
export {execaCommand, execaCommandSync} from './types/methods/command';
export {$} from './types/methods/script';
export {execaNode} from './types/methods/node';
/* eslint-enable import/extensions */
} from './types/stdio/type.js';
export type {Options, SyncOptions} from './types/arguments/options.js';
export type {Result, SyncResult} from './types/return/result.js';
export type {ResultPromise, Subprocess} from './types/subprocess/subprocess.js';
export {ExecaError, ExecaSyncError} from './types/return/final-error.js';
export {execa} from './types/methods/main-async.js';
export {execaSync} from './types/methods/main-sync.js';
export {execaCommand, execaCommandSync} from './types/methods/command.js';
export {$} from './types/methods/script.js';
export {execaNode} from './types/methods/node.js';
8 changes: 4 additions & 4 deletions types/arguments/options.d.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import type {Readable} from 'node:stream';
import type {Unless} from '../utils';
import type {StdinOptionCommon, StdoutStderrOptionCommon, StdioOptionsProperty} from '../stdio/type';
import type {FdGenericOption} from './specific';
import type {EncodingOption} from './encoding-option';
import type {Unless} from '../utils.js';
import type {StdinOptionCommon, StdoutStderrOptionCommon, StdioOptionsProperty} from '../stdio/type.js';
import type {FdGenericOption} from './specific.js';
import type {EncodingOption} from './encoding-option.js';

export type CommonOptions<IsSync extends boolean = boolean> = {
/**
Expand Down
2 changes: 1 addition & 1 deletion types/arguments/specific.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type {FromOption} from './fd-options';
import type {FromOption} from './fd-options.js';

// Options which can be fd-specific like `{verbose: {stdout: 'none', stderr: 'full'}}`
export type FdGenericOption<OptionType = unknown> = OptionType | GenericOptionObject<OptionType>;
Expand Down
6 changes: 3 additions & 3 deletions types/convert.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type {BinaryEncodingOption} from './arguments/encoding-option';
import type {Options} from './arguments/options';
import type {FromOption, ToOption} from './arguments/fd-options';
import type {BinaryEncodingOption} from './arguments/encoding-option.js';
import type {Options} from './arguments/options.js';
import type {FromOption, ToOption} from './arguments/fd-options.js';

// `subprocess.readable|duplex|iterable()` options
export type ReadableOptions = {
Expand Down
8 changes: 4 additions & 4 deletions types/methods/command.d.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type {Options, SyncOptions} from '../arguments/options';
import type {SyncResult} from '../return/result';
import type {ResultPromise} from '../subprocess/subprocess';
import type {SimpleTemplateString} from './template';
import type {Options, SyncOptions} from '../arguments/options.js';
import type {SyncResult} from '../return/result.js';
import type {ResultPromise} from '../subprocess/subprocess.js';
import type {SimpleTemplateString} from './template.js';

type ExecaCommand<OptionsType extends Options> = {
<NewOptionsType extends Options = {}>(options: NewOptionsType): ExecaCommand<OptionsType & NewOptionsType>;
Expand Down
6 changes: 3 additions & 3 deletions types/methods/main-async.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type {Options} from '../arguments/options';
import type {ResultPromise} from '../subprocess/subprocess';
import type {TemplateString} from './template';
import type {Options} from '../arguments/options.js';
import type {ResultPromise} from '../subprocess/subprocess.js';
import type {TemplateString} from './template.js';

type Execa<OptionsType extends Options> = {
<NewOptionsType extends Options = {}>(options: NewOptionsType): Execa<OptionsType & NewOptionsType>;
Expand Down
6 changes: 3 additions & 3 deletions types/methods/main-sync.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type {SyncOptions} from '../arguments/options';
import type {SyncResult} from '../return/result';
import type {TemplateString} from './template';
import type {SyncOptions} from '../arguments/options.js';
import type {SyncResult} from '../return/result.js';
import type {TemplateString} from './template.js';

type ExecaSync<OptionsType extends SyncOptions> = {
<NewOptionsType extends SyncOptions = {}>(options: NewOptionsType): ExecaSync<OptionsType & NewOptionsType>;
Expand Down
6 changes: 3 additions & 3 deletions types/methods/node.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type {Options} from '../arguments/options';
import type {ResultPromise} from '../subprocess/subprocess';
import type {TemplateString} from './template';
import type {Options} from '../arguments/options.js';
import type {ResultPromise} from '../subprocess/subprocess.js';
import type {TemplateString} from './template.js';

type ExecaNode<OptionsType extends Options> = {
<NewOptionsType extends Options = {}>(options: NewOptionsType): ExecaNode<OptionsType & NewOptionsType>;
Expand Down
8 changes: 4 additions & 4 deletions types/methods/script.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ import type {
Options,
SyncOptions,
StricterOptions,
} from '../arguments/options';
import type {SyncResult} from '../return/result';
import type {ResultPromise} from '../subprocess/subprocess';
import type {TemplateString} from './template';
} from '../arguments/options.js';
import type {SyncResult} from '../return/result.js';
import type {ResultPromise} from '../subprocess/subprocess.js';
import type {TemplateString} from './template.js';

type ExecaScriptCommon<OptionsType extends CommonOptions> = {
<NewOptionsType extends CommonOptions = {}>(options: NewOptionsType): ExecaScript<OptionsType & NewOptionsType>;
Expand Down
2 changes: 1 addition & 1 deletion types/methods/template.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type {CommonResultInstance} from '../return/result';
import type {CommonResultInstance} from '../return/result.js';

// Values allowed inside `...${...}...` template syntax
export type TemplateExpression =
Expand Down
10 changes: 5 additions & 5 deletions types/pipe.d.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import type {Options} from './arguments/options';
import type {Result} from './return/result';
import type {FromOption, ToOption} from './arguments/fd-options';
import type {ResultPromise} from './subprocess/subprocess';
import type {TemplateExpression} from './methods/template';
import type {Options} from './arguments/options.js';
import type {Result} from './return/result.js';
import type {FromOption, ToOption} from './arguments/fd-options.js';
import type {ResultPromise} from './subprocess/subprocess.js';
import type {TemplateExpression} from './methods/template.js';

// `subprocess.pipe()` options
type PipeOptions = {
Expand Down
5 changes: 2 additions & 3 deletions types/return/final-error.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import type {CommonOptions, Options, SyncOptions} from '../arguments/options';
// eslint-disable-next-line import/extensions
import {CommonResult} from './result';
import type {CommonOptions, Options, SyncOptions} from '../arguments/options.js';
import {CommonResult} from './result.js';

declare abstract class CommonError<
IsSync extends boolean = boolean,
Expand Down
10 changes: 5 additions & 5 deletions types/return/ignore.d.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import type {NoStreamStdioOption, StdioOptionCommon} from '../stdio/type';
import type {IsInputFd} from '../stdio/direction';
import type {FdStdioOption} from '../stdio/option';
import type {FdSpecificOption} from '../arguments/specific';
import type {CommonOptions} from '../arguments/options';
import type {NoStreamStdioOption, StdioOptionCommon} from '../stdio/type.js';
import type {IsInputFd} from '../stdio/direction.js';
import type {FdStdioOption} from '../stdio/option.js';
import type {FdSpecificOption} from '../arguments/specific.js';
import type {CommonOptions} from '../arguments/options.js';

// Whether `result.stdin|stdout|stderr|all|stdio[*]` is `undefined`
export type IgnoresResultOutput<
Expand Down
10 changes: 5 additions & 5 deletions types/return/result-all.d.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import type {IsObjectFd} from '../transform/object-mode';
import type {CommonOptions} from '../arguments/options';
import type {FdSpecificOption} from '../arguments/specific';
import type {IgnoresResultOutput} from './ignore';
import type {ResultStdio} from './result-stdout';
import type {IsObjectFd} from '../transform/object-mode.js';
import type {CommonOptions} from '../arguments/options.js';
import type {FdSpecificOption} from '../arguments/specific.js';
import type {IgnoresResultOutput} from './ignore.js';
import type {ResultStdio} from './result-stdout.js';

// `result.all`
export type ResultAll<OptionsType extends CommonOptions = CommonOptions> =
Expand Down
8 changes: 4 additions & 4 deletions types/return/result-stdio.d.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type {StdioOptionsArray} from '../stdio/type';
import type {StdioOptionNormalizedArray} from '../stdio/array';
import type {CommonOptions} from '../arguments/options';
import type {ResultStdioNotAll} from './result-stdout';
import type {StdioOptionsArray} from '../stdio/type.js';
import type {StdioOptionNormalizedArray} from '../stdio/array.js';
import type {CommonOptions} from '../arguments/options.js';
import type {ResultStdioNotAll} from './result-stdout.js';

// `result.stdio`
export type ResultStdioArray<OptionsType extends CommonOptions = CommonOptions> =
Expand Down
10 changes: 5 additions & 5 deletions types/return/result-stdout.d.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import type {BufferEncodingOption, BinaryEncodingOption} from '../arguments/encoding-option';
import type {IsObjectFd} from '../transform/object-mode';
import type {FdSpecificOption} from '../arguments/specific';
import type {CommonOptions} from '../arguments/options';
import type {IgnoresResultOutput} from './ignore';
import type {BufferEncodingOption, BinaryEncodingOption} from '../arguments/encoding-option.js';
import type {IsObjectFd} from '../transform/object-mode.js';
import type {FdSpecificOption} from '../arguments/specific.js';
import type {CommonOptions} from '../arguments/options.js';
import type {IgnoresResultOutput} from './ignore.js';

// `result.stdout|stderr|stdio`
export type ResultStdioNotAll<
Expand Down
12 changes: 6 additions & 6 deletions types/return/result.d.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import type {Unless} from '../utils';
import type {CommonOptions, Options, SyncOptions} from '../arguments/options';
import type {ErrorProperties} from './final-error';
import type {ResultAll} from './result-all';
import type {ResultStdioArray} from './result-stdio';
import type {ResultStdioNotAll} from './result-stdout';
import type {Unless} from '../utils.js';
import type {CommonOptions, Options, SyncOptions} from '../arguments/options.js';
import type {ErrorProperties} from './final-error.js';
import type {ResultAll} from './result-all.js';
import type {ResultStdioArray} from './result-stdio.js';
import type {ResultStdioNotAll} from './result-stdout.js';

export declare abstract class CommonResult<
IsSync extends boolean = boolean,
Expand Down
4 changes: 2 additions & 2 deletions types/stdio/array.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type {CommonOptions} from '../arguments/options';
import type {StdinOptionCommon, StdoutStderrOptionCommon, StdioOptionsArray} from './type';
import type {CommonOptions} from '../arguments/options.js';
import type {StdinOptionCommon, StdoutStderrOptionCommon, StdioOptionsArray} from './type.js';

// `options.stdio`, normalized as an array
export type StdioOptionNormalizedArray<OptionsType extends CommonOptions = CommonOptions> = StdioOptionNormalized<OptionsType['stdio']>;
Expand Down
6 changes: 3 additions & 3 deletions types/stdio/direction.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type {CommonOptions} from '../arguments/options';
import type {StdinOptionCommon, StdoutStderrOptionCommon, StdioOptionCommon} from './type';
import type {FdStdioArrayOption} from './option';
import type {CommonOptions} from '../arguments/options.js';
import type {StdinOptionCommon, StdoutStderrOptionCommon, StdioOptionCommon} from './type.js';
import type {FdStdioArrayOption} from './option.js';

// Whether `result.stdio[FdNumber]` is an input stream
export type IsInputFd<
Expand Down
6 changes: 3 additions & 3 deletions types/stdio/option.d.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import type {CommonOptions} from '../arguments/options';
import type {StdioOptionNormalizedArray} from './array';
import type {CommonOptions} from '../arguments/options.js';
import type {StdioOptionNormalizedArray} from './array.js';
import type {
StandardStreams,
StdioOptionCommon,
StdioOptionsArray,
StdioOptionsProperty,
} from './type';
} from './type.js';

// `options.stdin|stdout|stderr|stdio` for a given file descriptor
export type FdStdioOption<
Expand Down
4 changes: 2 additions & 2 deletions types/stdio/type.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ import type {
Or,
Unless,
AndUnless,
} from '../utils';
} from '../utils.js';
import type {
GeneratorTransform,
GeneratorTransformFull,
DuplexTransform,
WebTransform,
} from '../transform/normalize';
} from '../transform/normalize.js';

type IsStandardStream<FdNumber extends string> = FdNumber extends keyof StandardStreams ? true : false;

Expand Down
4 changes: 2 additions & 2 deletions types/subprocess/all.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type {Readable} from 'node:stream';
import type {IgnoresSubprocessOutput} from '../return/ignore';
import type {Options} from '../arguments/options';
import type {IgnoresSubprocessOutput} from '../return/ignore.js';
import type {Options} from '../arguments/options.js';

// `subprocess.all`
export type SubprocessAll<OptionsType extends Options = Options> = AllStream<OptionsType['all'], OptionsType>;
Expand Down
8 changes: 4 additions & 4 deletions types/subprocess/stdio.d.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type {StdioOptionNormalizedArray} from '../stdio/array';
import type {StdioOptionsArray} from '../stdio/type';
import type {Options} from '../arguments/options';
import type {SubprocessStdioStream} from './stdout';
import type {StdioOptionNormalizedArray} from '../stdio/array.js';
import type {StdioOptionsArray} from '../stdio/type.js';
import type {Options} from '../arguments/options.js';
import type {SubprocessStdioStream} from './stdout.js';

// `subprocess.stdio`
export type SubprocessStdioArray<OptionsType extends Options = Options> = MapStdioStreams<StdioOptionNormalizedArray<OptionsType>, OptionsType>;
Expand Down
6 changes: 3 additions & 3 deletions types/subprocess/stdout.d.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type {Readable, Writable} from 'node:stream';
import type {IsInputFd} from '../stdio/direction';
import type {IgnoresSubprocessOutput} from '../return/ignore';
import type {Options} from '../arguments/options';
import type {IsInputFd} from '../stdio/direction.js';
import type {IgnoresSubprocessOutput} from '../return/ignore.js';
import type {Options} from '../arguments/options.js';

// `subprocess.stdin|stdout|stderr|stdio`
export type SubprocessStdioStream<
Expand Down
16 changes: 8 additions & 8 deletions types/subprocess/subprocess.d.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
import type {ChildProcess} from 'node:child_process';
import type {Readable, Writable, Duplex} from 'node:stream';
import type {StdioOptionsArray} from '../stdio/type';
import type {Options} from '../arguments/options';
import type {Result} from '../return/result';
import type {PipableSubprocess} from '../pipe';
import type {StdioOptionsArray} from '../stdio/type.js';
import type {Options} from '../arguments/options.js';
import type {Result} from '../return/result.js';
import type {PipableSubprocess} from '../pipe.js';
import type {
ReadableOptions,
WritableOptions,
DuplexOptions,
SubprocessAsyncIterable,
} from '../convert';
import type {SubprocessStdioStream} from './stdout';
import type {SubprocessStdioArray} from './stdio';
import type {SubprocessAll} from './all';
} from '../convert.js';
import type {SubprocessStdioStream} from './stdout.js';
import type {SubprocessStdioArray} from './stdio.js';
import type {SubprocessAll} from './all.js';

type HasIpc<OptionsType extends Options> = OptionsType['ipc'] extends true
? true
Expand Down
2 changes: 1 addition & 1 deletion types/transform/normalize.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type {Duplex} from 'node:stream';
import type {Unless} from '../utils';
import type {Unless} from '../utils.js';

// `options.std*: Generator`
// @todo Use `string`, `Uint8Array` or `unknown` for both the argument and the return type, based on whether `encoding: 'buffer'` and `objectMode: true` are used.
Expand Down
8 changes: 4 additions & 4 deletions types/transform/object-mode.d.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type {StdioSingleOption, StdioOptionCommon} from '../stdio/type';
import type {FdStdioOption} from '../stdio/option';
import type {CommonOptions} from '../arguments/options';
import type {GeneratorTransformFull, DuplexTransform, WebTransform} from './normalize';
import type {StdioSingleOption, StdioOptionCommon} from '../stdio/type.js';
import type {FdStdioOption} from '../stdio/option.js';
import type {CommonOptions} from '../arguments/options.js';
import type {GeneratorTransformFull, DuplexTransform, WebTransform} from './normalize.js';

// Whether a file descriptor is in object mode
// I.e. whether `result.stdout|stderr|stdio|all` is an array of `unknown` due to `objectMode: true`
Expand Down

0 comments on commit 3bdab60

Please sign in to comment.