Skip to content

🚀 Migrate Project Creation from npm to pnpm for Faster Installs #97

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
triprjt merged 3 commits into from
Mar 6, 2025
Merged

🚀 Migrate Project Creation from npm to pnpm for Faster Installs #97

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
c686ce1
feat:install deps now moved from npm to pnpm to increase speed
yaswanthBonumaddi Mar 5, 2025
2bf04e9
updated pnpm in other places also
yaswanthBonumaddi Mar 6, 2025
6f64481
removed some commented code
yaswanthBonumaddi Mar 6, 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
284 changes: 110 additions & 174 deletions src/commands/plugin/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,34 +14,36 @@ import * as yaml from "js-yaml";
import { cwd } from "process";
import chalk from "chalk";
import ora from "ora";
import { spawn } from "child_process";

// Load the plugins list from JSON file
const pluginsFilePath = path.resolve(__dirname, '../../../pluginsList.json');
if (!fs.existsSync(pluginsFilePath)) {
console.error("Error: pluginsList.json file not found!");
process.exit(1);
}
const pluginsData = fs.readFileSync(pluginsFilePath, { encoding: "utf-8" });
const availablePlugins = JSON.parse(pluginsData);

// or Search the plugins list from npm
// const command = "npm search @godspeedsystems/plugins --json";
// const stdout = execSync(command, { encoding: "utf-8" });
// const availablePlugins = JSON.parse(stdout.trim());

// Map to the format expected by the UI
const pluginNames = availablePlugins.map((plugin: { value: string; name: string; description: string }) => ({
value: plugin.value,
Name: plugin.name.split("plugins-")[1],
Description: plugin.description,
}));
const pluginsFilePath = path.resolve(__dirname, "../../../pluginsList.json");
if (!fs.existsSync(pluginsFilePath)) {
console.error("Error: pluginsList.json file not found!");
process.exit(1);
}
const pluginsData = fs.readFileSync(pluginsFilePath, { encoding: "utf-8" });
const availablePlugins = JSON.parse(pluginsData);

// or Search the plugins list from npm
// const command = "npm search @godspeedsystems/plugins --json";
// const stdout = execSync(command, { encoding: "utf-8" });
// const availablePlugins = JSON.parse(stdout.trim());

// Map to the format expected by the UI
const pluginNames = availablePlugins.map(
(plugin: { value: string; name: string; description: string }) => ({
value: plugin.value,
Name: plugin.name.split("plugins-")[1],
Description: plugin.description,
})
);

const program = new Command();

type ModuleType = "DS" | "ES" | "BOTH";

const addAction = async (pluginsList: string[]) => {
// install that package
const spinner = ora({
text: "Installing plugins... ",
spinner: {
Expand All @@ -54,177 +56,120 @@ const addAction = async (pluginsList: string[]) => {
try {
spinner.start();

// Use spawnCommand instead of spawnSync
const child = spawnSync(
"npm",
[
"install",
...pluginsList,
"--quiet",
"--no-warnings",
"--silent",
"--progress=false",
],
{
stdio: "inherit", // Redirect output
}
);
const child = spawn("pnpm", ["add", ...pluginsList, "--silent"], {
stdio: "inherit",
});

await new Promise<void>((resolve) => {
child.on("close", () => {
resolve();
await new Promise<void>((resolve, reject) => {
child.on("close", (code) => {
if (code === 0) resolve();
else reject(new Error(`pnpm install failed with code ${code}`));
});
});

spinner.stop(); // Stop the spinner when the installation is complete
console.log("\nPlugins installed successfully!");
spinner.succeed("Plugins installed successfully!");
console.log(chalk.cyan.bold("Happy coding with Godspeed! 🚀🎉\n"));
} catch (error: any) {
spinner.stop(); // Stop the spinner in case of an error
spinner.fail("Failed to install plugins.");
console.error("Error during installation:", error.message);
}
}

// Call the installPlugin function
// Install plugins before proceeding
await installPlugin(pluginsList);

pluginsList.map(async (pluginName: string) => {
try {
const Module = await import(
path.join(process.cwd(), "node_modules", pluginName)
);
await Promise.all(
pluginsList.map(async (pluginName) => {
try {
const Module = await import(
path.join(process.cwd(), "node_modules", pluginName)
);

let moduleType = Module.SourceType as ModuleType;
let loaderFileName = Module.Type as string;
let yamlFileName = Module.CONFIG_FILE_NAME as string;
let defaultConfig = Module.DEFAULT_CONFIG || ({} as PlainObject);
let moduleType = Module.SourceType;
let loaderFileName = Module.Type as string;
let yamlFileName = Module.CONFIG_FILE_NAME as string;
let defaultConfig = Module.DEFAULT_CONFIG || {};

switch (moduleType) {
case "BOTH":
{
mkdirSync(
path.join(process.cwd(), "src", "eventsources", "types"),
{
recursive: true,
}
switch (moduleType) {
case "BOTH": {
const eventSourcePath = path.join(
process.cwd(),
"src",
"eventsources"
);
const dataSourcePath = path.join(
process.cwd(),
"src",
"datasources"
);
mkdirSync(path.join(process.cwd(), "src", "datasources", "types"), {
recursive: true,
});

mkdirSync(path.join(eventSourcePath, "types"), { recursive: true });
mkdirSync(path.join(dataSourcePath, "types"), { recursive: true });

writeFileSync(
path.join(
process.cwd(),
"src",
"eventsources",
"types",
`${loaderFileName}.ts`
),
`
import { EventSource } from '${pluginName}';
export default EventSource;
`
path.join(eventSourcePath, "types", `${loaderFileName}.ts`),
`import { EventSource } from '${pluginName}';\nexport default EventSource;`
);
writeFileSync(
path.join(
process.cwd(),
"src",
"eventsources",
`${yamlFileName}.yaml`
),
path.join(eventSourcePath, `${yamlFileName}.yaml`),
yaml.dump({ type: loaderFileName, ...defaultConfig })
);

writeFileSync(
path.join(
process.cwd(),
"src",
"datasources",
"types",
`${loaderFileName}.ts`
),
`
import { DataSource } from '${pluginName}';
export default DataSource;
`
path.join(dataSourcePath, "types", `${loaderFileName}.ts`),
`import { DataSource } from '${pluginName}';\nexport default DataSource;`
);
writeFileSync(
path.join(
process.cwd(),
"src",
"datasources",
`${yamlFileName}.yaml`
),
path.join(dataSourcePath, `${yamlFileName}.yaml`),
yaml.dump({ type: loaderFileName, ...defaultConfig })
);
break;
}
break;
case "DS":
{
mkdirSync(path.join(process.cwd(), "src", "datasources", "types"), {
recursive: true,
});
case "DS": {
const dataSourcePath = path.join(
process.cwd(),
"src",
"datasources"
);
mkdirSync(path.join(dataSourcePath, "types"), { recursive: true });

writeFileSync(
path.join(
process.cwd(),
"src",
"datasources",
"types",
`${loaderFileName}.ts`
),
`
import { DataSource } from '${pluginName}';
export default DataSource;
`
path.join(dataSourcePath, "types", `${loaderFileName}.ts`),
`import { DataSource } from '${pluginName}';\nexport default DataSource;`
);
// special case for prisma for now
// @ts-ignore

if (Module.Type !== "prisma") {
writeFileSync(
path.join(
process.cwd(),
"src",
"datasources",
`${yamlFileName}.yaml`
),
path.join(dataSourcePath, `${yamlFileName}.yaml`),
yaml.dump({ type: loaderFileName, ...defaultConfig })
);
}
break;
}
break;
case "ES": {
mkdirSync(path.join(process.cwd(), "src", "eventsources", "types"), {
recursive: true,
});
writeFileSync(
path.join(
process.cwd(),
"src",
"eventsources",
"types",
`${loaderFileName}.ts`
),
`
import { EventSource } from '${pluginName}';
export default EventSource;
`
);
writeFileSync(
path.join(
case "ES": {
const eventSourcePath = path.join(
process.cwd(),
"src",
"eventsources",
`${yamlFileName}.yaml`
),
yaml.dump({ type: loaderFileName, ...defaultConfig })
);
"eventsources"
);
mkdirSync(path.join(eventSourcePath, "types"), { recursive: true });

writeFileSync(
path.join(eventSourcePath, "types", `${loaderFileName}.ts`),
`import { EventSource } from '${pluginName}';\nexport default EventSource;`
);
writeFileSync(
path.join(eventSourcePath, `${yamlFileName}.yaml`),
yaml.dump({ type: loaderFileName, ...defaultConfig })
);
break;
}
}
} catch (error) {
console.error(`Unable to import module '${pluginName}':`, error);
}
} catch (error) {
console.error("unable to import the module.", error);
}
});
// create folder for eventsource or datasource respective file
})
);
};

const add = program
Expand All @@ -245,7 +190,7 @@ const add = program
const missingPlugins = pluginNames.filter(
(plugin: { value: string | number }) => !localpluginsList[plugin.value]
);

if (!givenPluginName) {
if (pluginNames.length === 0) {
console.error("No plugins found.");
Expand Down Expand Up @@ -330,34 +275,26 @@ const removeAction = async (pluginsList: string[]) => {
try {
spinner.start();

// Use spawnCommand instead of spawnSync
const child = spawnSync(
"npm",
[
"uninstall",
...pluginsList,
"--quiet",
"--no-warnings",
"--silent",
"--progress=false",
],
{
stdio: "inherit", // Redirect output
}
);
const child = spawn("pnpm", ["remove", ...pluginsList, "--silent"], {
stdio: "inherit", // Ensure proper output handling
});

await new Promise<void>((resolve) => {
child.on("close", () => {
resolve();
await new Promise<void>((resolve, reject) => {
child.on("close", (code) => {
if (code === 0) {
resolve();
} else {
reject(new Error(`pnpm remove failed with code ${code}`));
}
});
});

spinner.stop(); // Stop the spinner when the installation is complete
spinner.stop(); // Stop the spinner when uninstallation is complete
console.log("\nPlugins uninstalled successfully!");
console.log(chalk.cyan.bold("Happy coding with Godspeed! 🚀🎉\n"));
} catch (error: any) {
spinner.stop(); // Stop the spinner in case of an error
console.error("Error during installation:", error.message);
console.error("Error during uninstallation:", error.message);
}
}

Expand Down Expand Up @@ -480,7 +417,7 @@ const remove = program
console.error("There are no eventsource/datasource plugins installed.");
return;
}

let pkgPath = path.join(cwd(), "package.json");
pluginsList = existsSync(pkgPath)
? JSON.parse(readFileSync(pkgPath, { encoding: "utf-8" })).dependencies
Expand Down Expand Up @@ -594,7 +531,6 @@ const update = program
}
}


let pkgPath = path.join(cwd(), "package.json");
pluginsList = existsSync(pkgPath)
? JSON.parse(readFileSync(pkgPath, { encoding: "utf-8" })).dependencies
Expand Down
Loading