@turbo/workspaces 0.0.1 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -27,10 +27,11 @@ declare class Logger {
27
27
  type PackageManager = "npm" | "pnpm" | "yarn";
28
28
  type PackageManagerDetails = {
29
29
  name: PackageManager;
30
- version: string;
30
+ version?: string;
31
31
  };
32
32
  type Project = {
33
33
  name: string;
34
+ description?: string;
34
35
  packageManager: PackageManager;
35
36
  paths: {
36
37
  root: string;
@@ -46,6 +47,7 @@ type Project = {
46
47
  };
47
48
  type Workspace = {
48
49
  name: string;
50
+ description?: string;
49
51
  paths: {
50
52
  root: string;
51
53
  packageJson: string;
@@ -83,7 +85,7 @@ type ConvertArgs = {
83
85
  type InstallArgs = {
84
86
  project: Project;
85
87
  to: PackageManagerDetails;
86
- logger: Logger;
88
+ logger?: Logger;
87
89
  options?: Options;
88
90
  };
89
91
  type Options = {
@@ -91,6 +93,16 @@ type Options = {
91
93
  skipInstall?: boolean;
92
94
  interactive?: boolean;
93
95
  };
96
+ type PackageManagerInstallDetails = {
97
+ name: string;
98
+ template: string;
99
+ command: PackageManager;
100
+ installArgs: string[];
101
+ version: string;
102
+ executable: string;
103
+ semver: string;
104
+ default?: boolean;
105
+ };
94
106
  type ManagerDetect = (args: DetectArgs) => Promise<boolean>;
95
107
  type ManagerRead = (args: ReadArgs) => Promise<Project>;
96
108
  type ManagerCreate = (args: CreateArgs) => Promise<void>;
@@ -110,14 +122,24 @@ declare function getWorkspaceDetails({ root, }: {
110
122
  root: string;
111
123
  }): Promise<Project>;
112
124
 
125
+ declare function getPackageManagerMeta(packageManager: PackageManagerDetails): PackageManagerInstallDetails | undefined;
113
126
  declare function install(args: InstallArgs): Promise<void>;
114
127
 
128
+ type ConvertErrorType = "package_manager-unexpected" | "package_manager-already_in_use" | "package_manager-unable_to_detect" | "package_manager-unsupported_version" | "pnpm-workspace_parse_error" | "package_json-parse_error" | "package_json-missing" | "invalid_directory" | "error_removing_node_modules" | "unknown";
129
+ type ConvertErrorOptions = {
130
+ type?: ConvertErrorType;
131
+ };
132
+ declare class ConvertError extends Error {
133
+ type: ConvertErrorType;
134
+ constructor(message: string, opts?: ConvertErrorOptions);
135
+ }
136
+
115
137
  declare const MANAGERS: Record<PackageManager, ManagerHandler>;
116
138
 
117
- declare function convertMonorepo({ root, to, options, }: {
139
+ declare function convert({ root, to, options, }: {
118
140
  root: string;
119
141
  to: PackageManager;
120
142
  options?: Options;
121
143
  }): Promise<void>;
122
144
 
123
- export { InstallArgs, MANAGERS, Options, PackageManager, convertMonorepo, getWorkspaceDetails, install };
145
+ export { ConvertError, ConvertErrorType, InstallArgs, MANAGERS, Options, PackageManager, Project, Workspace, convert, getPackageManagerMeta, getWorkspaceDetails, install };