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.

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

Integrate ntl (Node Task list) into CLI for commands Management #42

Closed
rsaz opened this issue Apr 12, 2024 · 0 comments · Fixed by #63
Closed

Integrate ntl (Node Task list) into CLI for commands Management #42

rsaz opened this issue Apr 12, 2024 · 0 comments · Fixed by #63
Assignees
Labels
enhancement New feature or request

Comments

@rsaz
Copy link
Member

rsaz commented Apr 12, 2024

Description

The goal of this task is to incorporate the ntl package into the CLI component of our system. This integration should allow users to view and run tasks defined in the package.json scripts section directly from the CLI, enhancing the development experience by providing a streamlined way to manage and execute Node tasks.
As well as to consider adding the current expressots CLI commands to be interactive in the same way as the scripts in the package.json

Goals

Enhanced Usability: Streamline the developer's workflow by providing an interactive task runner interface within the CLI.
Simplicity: Ensure the command interface is intuitive, requiring minimal input to access and run tasks.

Requirements

Package Integration:

  • Incorporate the ntl package into the CLI tooling setup.
  • Verify compatibility with the current CLI and Node.js project setup.

Interactive List Display:

  • Implement an interactive command interface that displays available tasks from package.json.
  • Include filtering and search capabilities for large lists of scripts.

Execution of Tasks:

  • Allow users to execute tasks by selecting from the interactive list without manually typing the full command.
  • Provide feedback on task execution status and output within the CLI.

Error Handling:

  • Implement robust error handling to provide clear messages for failed tasks or execution errors.
  • Ensure the CLI remains stable and recovers gracefully from any task failures.

Documentation and Help:

  • Update the CLI help documentation to include the new ntl command usage and features.
  • Provide examples of common task interactions and troubleshooting tips.

Testing:

  • Create a suite of automated tests to verify that the ntl integration works as expected across various scenarios.
  • Include tests for command discovery, interaction, execution, and error handling.

Deliverables

  • A working implementation of ntl within the CLI that interacts with the project’s package.json scripts.
  • Documentation for the ntl command, updated help commands, and usage guides.
  • A comprehensive test suite that ensures the reliability and stability of the ntl integration.
  • This task will enhance the developer tooling by streamlining the interaction with Node.js tasks, making the process of managing and running scripts more efficient and user-friendly.
@rsaz rsaz converted this from a draft issue Apr 12, 2024
@rsaz rsaz added the enhancement New feature or request label Apr 12, 2024
@juliano-soares juliano-soares self-assigned this Aug 1, 2024
@rsaz rsaz moved this from 📋 Draft to 💻 In Development in CLI (@expressots/cli) Aug 3, 2024
@juliano-soares juliano-soares linked a pull request Aug 8, 2024 that will close this issue
14 tasks
@rsaz rsaz closed this as completed in #63 Aug 8, 2024
@github-project-automation github-project-automation bot moved this from 💻 In Development to ✅ Done in CLI (@expressots/cli) Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants