Skip to content
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

refactor: use optional chaining for improved readability and maintained functionality #1279

Closed
wants to merge 2 commits into from
Closed

refactor: use optional chaining for improved readability and maintained functionality #1279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a31d964
refactor: improve generate function structure
thebedigupta Oct 3, 2024
a5488e7
fix: Use optional chaining for better readabilty
thebedigupta Oct 3, 2024
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
246 changes: 162 additions & 84 deletions apps/generator/cli.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
#!/usr/bin/env node

const path = require('path');
const os = require('os');
const program = require('commander');
const xfs = require('fs.extra');
const { DiagnosticSeverity } = require('@asyncapi/parser/cjs');
const packageInfo = require('./package.json');
const Generator = require('./lib/generator');
const Watcher = require('./lib/watcher');
const { isLocalTemplate, isFilePath } = require('./lib/utils');

const red = text => `\x1b[31m${text}\x1b[0m`;
const magenta = text => `\x1b[35m${text}\x1b[0m`;
const yellow = text => `\x1b[33m${text}\x1b[0m`;
const green = text => `\x1b[32m${text}\x1b[0m`;
const path = require("path");
const os = require("os");
const program = require("commander");
const xfs = require("fs.extra");
const { DiagnosticSeverity } = require("@asyncapi/parser/cjs");
const packageInfo = require("./package.json");
const Generator = require("./lib/generator");
const Watcher = require("./lib/watcher");
const { isLocalTemplate, isFilePath } = require("./lib/utils");

const red = (text) => `\x1b[31m${text}\x1b[0m`;
const magenta = (text) => `\x1b[35m${text}\x1b[0m`;
const yellow = (text) => `\x1b[33m${text}\x1b[0m`;
const green = (text) => `\x1b[32m${text}\x1b[0m`;

let asyncapiDocPath;
let template;
Expand All @@ -22,84 +22,128 @@ const noOverwriteGlobs = [];
const disabledHooks = {};
const mapBaseUrlToFolder = {};

const parseOutput = dir => path.resolve(dir);
const parseOutput = (dir) => path.resolve(dir);

const paramParser = v => {
if (!v.includes('=')) throw new Error(`Invalid param ${v}. It must be in the format of --param name=value.`);
const paramParser = (v) => {
if (!v.includes("="))
throw new Error(
`Invalid param ${v}. It must be in the format of --param name=value.`
);
const [paramName, paramValue] = v.split(/=(.+)/, 2);
params[paramName] = paramValue;
return v;
};

const noOverwriteParser = v => noOverwriteGlobs.push(v);
const noOverwriteParser = (v) => noOverwriteGlobs.push(v);

const disableHooksParser = v => {
const disableHooksParser = (v) => {
const [hookType, hookNames] = v.split(/=/);
if (!hookType) throw new Error('Invalid --disable-hook flag. It must be in the format of: --disable-hook <hookType> or --disable-hook <hookType>=<hookName1>,<hookName2>,...');
if (!hookType)
throw new Error(
"Invalid --disable-hook flag. It must be in the format of: --disable-hook <hookType> or --disable-hook <hookType>=<hookName1>,<hookName2>,..."
);
if (hookNames) {
disabledHooks[hookType] = hookNames.split(/,/);
} else {
disabledHooks[hookType] = true;
}
};

const mapBaseUrlParser = v => {
const mapBaseUrlParser = (v) => {
// Example value for regular expression: https://schema.example.com/crm/:./test/docs/
// it splits on last occurrence of : into the groups all, url and folder
const re = /(.*):(.*)/g;
let mapping = [];
if ((mapping = re.exec(v))===null || mapping.length!==3) {
throw new Error('Invalid --map-base-url flag. A mapping <url>:<folder> with delimiter : expected.');
if ((mapping = re.exec(v)) === null || mapping.length !== 3) {
throw new Error(
"Invalid --map-base-url flag. A mapping <url>:<folder> with delimiter : expected."
);
}

// Folder is without trailing slash, so make sure that url has also no trailing slash:
mapBaseUrlToFolder.url = mapping[1].replace(/\/$/, '');
mapBaseUrlToFolder.url = mapping[1].replace(/\/$/, "");
mapBaseUrlToFolder.folder = path.resolve(mapping[2]);

const isURL = /^https?:/;
if (!isURL.test(mapBaseUrlToFolder.url.toLowerCase())) {
throw new Error('Invalid --map-base-url flag. The mapping <url>:<folder> requires a valid http/https url and valid folder with delimiter `:`.');
throw new Error(
"Invalid --map-base-url flag. The mapping <url>:<folder> requires a valid http/https url and valid folder with delimiter `:`."
);
}
};

const showError = err => {
console.error(red('Something went wrong:'));
const showError = (err) => {
console.error(red("Something went wrong:"));
console.error(red(err.stack || err.message));
if (err.diagnostics) {
const errorDiagnostics = err.diagnostics.filter(diagnostic => diagnostic.severity === DiagnosticSeverity.Error);
console.error(red(`Errors:\n${JSON.stringify(errorDiagnostics, undefined, 2)}`));
const errorDiagnostics = err.diagnostics.filter(
(diagnostic) => diagnostic.severity === DiagnosticSeverity.Error
);
console.error(
red(`Errors:\n${JSON.stringify(errorDiagnostics, undefined, 2)}`)
);
}
};
const showErrorAndExit = err => {
const showErrorAndExit = (err) => {
showError(err);
process.exit(1);
};

program
.version(packageInfo.version)
.arguments('<asyncapi> <template>')
.arguments("<asyncapi> <template>")
.action((fileLoc, tmpl) => {
asyncapiDocPath = fileLoc;
template = tmpl;
})
.option('-d, --disable-hook [hooks...]', 'disable a specific hook type or hooks from given hook type', disableHooksParser)
.option('--debug', 'enable more specific errors in the console')
.option('-i, --install', 'installs the template and its dependencies (defaults to false)')
.option('-n, --no-overwrite <glob>', 'glob or path of the file(s) to skip when regenerating', noOverwriteParser)
.option('-o, --output <outputDir>', 'directory where to put the generated files (defaults to current directory)', parseOutput, process.cwd())
.option('-p, --param <name=value>', 'additional param to pass to templates', paramParser)
.option('--force-write', 'force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)')
.option('--watch-template', 'watches the template directory and the AsyncAPI document, and re-generate the files when changes occur. Ignores the output directory. This flag should be used only for template development.')
.option('--map-base-url <url:folder>','maps all schema references from base url to local folder',mapBaseUrlParser)
.option(
"-d, --disable-hook [hooks...]",
"disable a specific hook type or hooks from given hook type",
disableHooksParser
)
.option("--debug", "enable more specific errors in the console")
.option(
"-i, --install",
"installs the template and its dependencies (defaults to false)"
)
.option(
"-n, --no-overwrite <glob>",
"glob or path of the file(s) to skip when regenerating",
noOverwriteParser
)
.option(
"-o, --output <outputDir>",
"directory where to put the generated files (defaults to current directory)",
parseOutput,
process.cwd()
)
.option(
"-p, --param <name=value>",
"additional param to pass to templates",
paramParser
)
.option(
"--force-write",
"force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)"
)
.option(
"--watch-template",
"watches the template directory and the AsyncAPI document, and re-generate the files when changes occur. Ignores the output directory. This flag should be used only for template development."
)
.option(
"--map-base-url <url:folder>",
"maps all schema references from base url to local folder",
mapBaseUrlParser
)
.parse(process.argv);

if (!asyncapiDocPath) {
console.error(red('> Path or URL to AsyncAPI file not provided.'));
console.error(red("> Path or URL to AsyncAPI file not provided."));
program.help(); // This exits the process
}
const isAsyncapiDocLocal = isFilePath(asyncapiDocPath);

xfs.mkdirp(program.output, async err => {
xfs.mkdirp(program.output, async (err) => {
if (err) return showErrorAndExit(err);
try {
await generate(program.output);
Expand All @@ -112,26 +156,45 @@ xfs.mkdirp(program.output, async err => {
let watcher;
const watchDir = path.resolve(template);
const outputPath = path.resolve(watchDir, program.output);
const transpiledTemplatePath = path.resolve(watchDir, Generator.TRANSPILED_TEMPLATE_LOCATION);
const transpiledTemplatePath = path.resolve(
watchDir,
Generator.TRANSPILED_TEMPLATE_LOCATION
);
const ignorePaths = [outputPath, transpiledTemplatePath];
// Template name is needed as it is not always a part of the cli commad
// There is a use case that you run generator from a root of the template with `./` path
const templateName = require(path.resolve(watchDir,'package.json')).name;
const templateName = require(path.resolve(watchDir, "package.json")).name;

if (isAsyncapiDocLocal) {
console.log(`[WATCHER] Watching for changes in the template directory ${magenta(watchDir)} and in the AsyncAPI file ${magenta(asyncapiDocPath)}`);
console.log(
`[WATCHER] Watching for changes in the template directory ${magenta(
watchDir
)} and in the AsyncAPI file ${magenta(asyncapiDocPath)}`
);
watcher = new Watcher([asyncapiDocPath, watchDir], ignorePaths);
} else {
console.log(`[WATCHER] Watching for changes in the template directory ${magenta(watchDir)}`);
console.log(
`[WATCHER] Watching for changes in the template directory ${magenta(
watchDir
)}`
);
watcher = new Watcher(watchDir, ignorePaths);
}
// Must check template in its installation path in generator to use isLocalTemplate function
if (!await isLocalTemplate(path.resolve(Generator.DEFAULT_TEMPLATES_DIR, templateName))) {
console.warn(`WARNING: ${template} is a remote template. Changes may be lost on subsequent installations.`);
if (
!(await isLocalTemplate(
path.resolve(Generator.DEFAULT_TEMPLATES_DIR, templateName)
))
) {
console.warn(
`WARNING: ${template} is a remote template. Changes may be lost on subsequent installations.`
);
}

await watcher.watch(watcherHandler, (paths) => {
showErrorAndExit({ message: `[WATCHER] Could not find the file path ${paths}, are you sure it still exists? If it has been deleted or moved please rerun the generator.` });
showErrorAndExit({
message: `[WATCHER] Could not find the file path ${paths}, are you sure it still exists? If it has been deleted or moved please rerun the generator.`,
});
});
}
});
Expand All @@ -140,59 +203,74 @@ xfs.mkdirp(program.output, async err => {
* Generates the files based on the template.
* @param {*} targetDir The path to the target directory.
*/
/**
* Removed async from the promise executor function : Instead of marking the executor as async, I created an immediately invoked async function within it to handle the async operations
*/
function generate(targetDir) {
return new Promise(async (resolve, reject) => {
try {
const generator = new Generator(template, targetDir || path.resolve(os.tmpdir(), 'asyncapi-generator'), {
templateParams: params,
noOverwriteGlobs,
disabledHooks,
forceWrite: program.forceWrite,
install: program.install,
debug: program.debug,
mapBaseUrlToFolder
});
return new Promise((resolve, reject) => {
(async () => {
try {
const generator = new Generator(
template,
targetDir || path.resolve(os.tmpdir(), "asyncapi-generator"),
{
templateParams: params,
noOverwriteGlobs,
disabledHooks,
forceWrite: program.forceWrite,
install: program.install,
debug: program.debug,
mapBaseUrlToFolder,
}
);

if (isAsyncapiDocLocal) {
await generator.generateFromFile(path.resolve(asyncapiDocPath));
} else {
await generator.generateFromURL(asyncapiDocPath);
if (isAsyncapiDocLocal) {
await generator.generateFromFile(path.resolve(asyncapiDocPath));
} else {
await generator.generateFromURL(asyncapiDocPath);
}
console.log(green("\n\nDone! ✨"));
console.log(
`${
yellow("Check out your shiny new generated files at ") +
magenta(program.output) +
yellow(".")
}\n`
);
resolve();
} catch (e) {
reject(e);
}
console.log(green('\n\nDone! ✨'));
console.log(`${yellow('Check out your shiny new generated files at ') + magenta(program.output) + yellow('.')}\n`);
resolve();
} catch (e) {
reject(e);
}
})(); //Immediately invoke the async function
});
}

async function watcherHandler(changedFiles) {
console.clear();
console.log('[WATCHER] Change detected');
console.log("[WATCHER] Change detected");
for (const [, value] of Object.entries(changedFiles)) {
let eventText;
switch (value.eventType) {
case 'changed':
eventText = green(value.eventType);
break;
case 'removed':
eventText = red(value.eventType);
break;
case 'renamed':
eventText = yellow(value.eventType);
break;
default:
eventText = yellow(value.eventType);
case "changed":
eventText = green(value.eventType);
break;
case "removed":
eventText = red(value.eventType);
break;
case "renamed":
eventText = yellow(value.eventType);
break;
default:
eventText = yellow(value.eventType);
}
console.log(`\t${magenta(value.path)} was ${eventText}`);
}
console.log('Generating files');
console.log("Generating files");
try {
await generate(program.output);
} catch (e) {
showError(e);
}
}

process.on('unhandledRejection', showErrorAndExit);
process.on("unhandledRejection", showErrorAndExit);
Loading
Loading