1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
import fs from "fs-extra";
import path from "path";
import { getTurboConfigs } from "@turbo/utils";
import type { Schema, Pipeline } from "@turbo/types";
import getTransformerHelpers from "../utils/getTransformerHelpers";
import { TransformerResults } from "../runner";
import type { TransformerArgs } from "../types";
// transformer details
const TRANSFORMER = "migrate-env-var-dependencies";
const DESCRIPTION =
'Migrate environment variable dependencies from "dependsOn" to "env" in `turbo.json`';
const INTRODUCED_IN = "1.5.0";
export function hasLegacyEnvVarDependencies(config: Schema) {
const dependsOn = [
"extends" in config ? [] : config.globalDependencies,
Object.values(config.pipeline).flatMap(
(pipeline) => pipeline.dependsOn ?? []
),
].flat();
const envVars = dependsOn.filter((dep) => dep?.startsWith("$"));
return { hasKeys: !!envVars.length, envVars };
}
export function migrateDependencies({
env,
deps,
}: {
env?: string[];
deps?: string[];
}) {
const envDeps: Set<string> = new Set(env);
const otherDeps: string[] = [];
deps?.forEach((dep) => {
if (dep.startsWith("$")) {
envDeps.add(dep.slice(1));
} else {
otherDeps.push(dep);
}
});
if (envDeps.size) {
return {
deps: otherDeps,
env: Array.from(envDeps),
};
} else {
return { env, deps };
}
}
export function migratePipeline(pipeline: Pipeline) {
const { deps: dependsOn, env } = migrateDependencies({
env: pipeline.env,
deps: pipeline.dependsOn,
});
const migratedPipeline = { ...pipeline };
if (dependsOn) {
migratedPipeline.dependsOn = dependsOn;
} else {
delete migratedPipeline.dependsOn;
}
if (env && env.length) {
migratedPipeline.env = env;
} else {
delete migratedPipeline.env;
}
return migratedPipeline;
}
export function migrateGlobal(config: Schema) {
if ("extends" in config) {
return config;
}
const { deps: globalDependencies, env } = migrateDependencies({
env: config.globalEnv,
deps: config.globalDependencies,
});
const migratedConfig = { ...config };
if (globalDependencies && globalDependencies.length) {
migratedConfig.globalDependencies = globalDependencies;
} else {
delete migratedConfig.globalDependencies;
}
if (env && env.length) {
migratedConfig.globalEnv = env;
} else {
delete migratedConfig.globalEnv;
}
return migratedConfig;
}
export function migrateConfig(config: Schema) {
let migratedConfig = migrateGlobal(config);
Object.keys(config.pipeline).forEach((pipelineKey) => {
config.pipeline;
if (migratedConfig.pipeline && config.pipeline[pipelineKey]) {
const pipeline = migratedConfig.pipeline[pipelineKey];
migratedConfig.pipeline[pipelineKey] = {
...pipeline,
...migratePipeline(pipeline),
};
}
});
return migratedConfig;
}
export function transformer({
root,
options,
}: TransformerArgs): TransformerResults {
const { log, runner } = getTransformerHelpers({
transformer: TRANSFORMER,
rootPath: root,
options,
});
log.info(
`Migrating environment variable dependencies from "globalDependencies" and "dependsOn" to "env" in "turbo.json"...`
);
// validate we don't have a package.json config
const packageJsonPath = path.join(root, "package.json");
let packageJSON = {};
try {
packageJSON = fs.readJSONSync(packageJsonPath);
} catch (e) {
// readJSONSync probably failed because the file doesn't exist
}
if ("turbo" in packageJSON) {
return runner.abortTransform({
reason:
'"turbo" key detected in package.json. Run `npx @turbo/codemod transform create-turbo-config` first',
});
}
// validate we have a root config
const turboConfigPath = path.join(root, "turbo.json");
if (!fs.existsSync(turboConfigPath)) {
return runner.abortTransform({
reason: `No turbo.json found at ${root}. Is the path correct?`,
});
}
let turboJson: Schema = fs.readJsonSync(turboConfigPath);
if (hasLegacyEnvVarDependencies(turboJson).hasKeys) {
turboJson = migrateConfig(turboJson);
}
runner.modifyFile({
filePath: turboConfigPath,
after: turboJson,
});
// find and migrate any workspace configs
const workspaceConfigs = getTurboConfigs(root);
workspaceConfigs.forEach((workspaceConfig) => {
const { config, turboConfigPath } = workspaceConfig;
if (hasLegacyEnvVarDependencies(config).hasKeys) {
runner.modifyFile({
filePath: turboConfigPath,
after: migrateConfig(config),
});
}
});
return runner.finish();
}
const transformerMeta = {
name: `${TRANSFORMER}: ${DESCRIPTION}`,
value: TRANSFORMER,
introducedIn: INTRODUCED_IN,
transformer,
};
export default transformerMeta;
|