Skip to content

Design analysis: JavaScript functions for fcli actions #916

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

Draft
Copilot wants to merge 4 commits into
base: dev/v3.x
Choose a base branch
from
Draft

Design analysis: JavaScript functions for fcli actions #916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
20a9fa1
Initial plan
Copilot Feb 4, 2026
101038f
Add comprehensive design analysis for fcli action function syntax
Copilot Feb 4, 2026
1bd95aa
Add README for doc-resources with design analysis summary
Copilot Feb 4, 2026
1036338
Add executive summary for action functions design
Copilot Feb 4, 2026
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
51 changes: 51 additions & 0 deletions doc-resources/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# fcli Documentation Resources

This directory contains various design documents, research papers, and technical resources for fcli development.

## Documents

### [action-functions-design-analysis.md](action-functions-design-analysis.md)
**Status:** Research & Recommendations
**Date:** 2026-02-04

Comprehensive design analysis for introducing function definitions to fcli actions, including:

- **Problem Statement:** Evaluation of adding reusable function syntax to fcli YAML actions
- **Language Recommendation:** JavaScript (GraalVM) for embedded scripting
- **Key Benefits:**
- Improved code reusability across actions
- Direct MCP tool exposure for AI assistant integration
- Better IDE support (autocomplete, debugging, type checking)
- Enhanced AI code assistance
- **Integration:** Architecture for JavaScript bridge API with fcli variables, REST calls, and commands
- **Security:** Comprehensive sandboxing requirements and implementation
- **Implementation:** 3-phase rollout plan (v2.8.0 - v2.10.0)

**Recommendation:** Add JavaScript function support while maintaining backward compatibility with existing SpEL-based actions.

### Other Documents

- **repo-intro.md** - Repository introduction text
- **repo-usage.md** - Usage information
- **repo-devinfo.md** - Developer information
- **repo-resources.md** - Resource links
- **template-values.md** - Template configuration values

## Related Resources

- **Action Documentation:** https://fortify.github.io/fcli/actions/
- **Action Schema:** https://fortify.github.io/fcli/schemas/action/
- **MCP Server Guide:** See `fcli util mcp-server --help`
- **Action Examples:** `fcli-*/src/main/resources/com/fortify/cli/*/actions/zip/*.yaml`

## Contributing

For questions or discussions about these design documents, please:

1. Open an issue in the [fcli GitHub repository](https://github.com/fortify/fcli/issues)
2. Join the [Fortify Community](https://community.opentext.com/cybersec/fortify/)
3. Contact the fcli maintainers

---

*Last updated: 2026-02-04*
Loading