feat: update nodecli

[damienbutt]

No description provided.

[sourcery-ai]

PR Type: Enhancement

PR Summary: This pull request introduces a significant update to the nodecli template, focusing on enhancing the CLI tool's functionality, improving the development workflow, and ensuring compatibility with the latest Node.js versions. It adds new dependencies to support these features, updates the GitHub Actions workflow to include more comprehensive CI checks, and introduces a new command (hello) to the CLI. Additionally, it incorporates testing with Vitest and updates to package.json to reflect these changes.

Decision: Comment

📝 Type: 'Enhancement' - not supported yet.

• Sourcery currently only approves 'Typo fix' PRs.

✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.

No details provided.

📝 Complexity: the changes are too large or complex for Sourcery to approve.

• Unsupported files: the diff contains files that Sourcery does not currently support during reviews.

General suggestions:

• Consider adding more detailed comments or documentation within the code, especially for the new features and commands introduced, to ensure maintainability and ease of understanding for new contributors.
• Review the added dependencies to ensure they are all necessary and used within the project, to avoid bloating the project with unused packages.
• Given the significant changes, it might be beneficial to include a minor version bump in the package.json to reflect the new features and improvements made.

templates/nodecli/src/app.js: The code change significantly increases complexity by introducing multiple dependencies and intricate logic, suggesting a need for simplification to maintain ease of understanding and upkeep.

While the added functionality introduces some exciting features, it significantly increases the complexity of the codebase. The original single-line console.log statement was straightforward, but the new version introduces multiple external dependencies (figlet, chalk, commander, StringBuilder), significantly more lines of code, complex logic for handling command-line arguments, error handling, and asynchronous code. This complexity can make the code harder to maintain and understand, especially for new contributors or when revisiting this code after some time.

Consider simplifying the implementation to balance between the new functionality and maintaining code simplicity. For example, reducing the number of external dependencies and streamlining the command-line interface logic could help. Here's a suggested approach that retains some of the enhancements while aiming for simplicity:

#!/usr/bin/env node

import chalk from "chalk";
import { Command } from "commander";
import packageJson from "./package.json"; // Assuming static import is sufficient for package details.

const program = new Command();

program
    .name(packageJson.name)
    .description(packageJson.description)
    .version(packageJson.version, "-v, --version")
    .action(() => {
        console.log(`Welcome to ${chalk.bold(packageJson.name)} v${packageJson.version}`);
    });

program.parse(process.argv);

if (!process.argv.slice(2).length) {
    program.outputHelp();
}

This version aims to keep the code more maintainable by reducing the number of moving parts while still introducing some of the intended enhancements like styled output and basic CLI structure.

Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨

Share Sourcery

• X
• Mastodon
• LinkedIn
• Facebook

---

Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

[github-actions]

🎉 This PR is included in version 2.3.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀