FoolScript is a powerful VS Code chat extension designed to generate crash course style documentation for any programming language. It integrates seamlessly with the GitHub Copilot chat window, providing quick and easy access to language-specific information and code examples.
- Multi-Language Support: FoolScript automatically detects the language of your active file and provides language-specific assistance.
- Crash Course Documentation: Quickly generate concise, informative documentation for various programming concepts.
- Interactive Chat Interface: Communicate with FoolScript using natural language within the Copilot chat window.
- Code Examples: Get relevant code snippets and examples for better understanding.
The @fools chat participant defaults to converting your request directly into idiomatic code for the current language. Instead of phrasing your request as a question, you can simply state what you want to achieve, and FoolScript will generate the code for you.
For example, typing @fools an array that prints each element will generate the appropriate code snippet for iterating over an array and printing each element.
FoolScript offers a variety of commands to generate documentation and code examples:
/class: Get a crash course on classes in the current language/function: Learn about functions and their usage/enum: Understand enumeration types/variable: Explore variable declarations and scoping
/number: Explore number types and operations/string: Discover string manipulations/boolean: Learn about boolean operations/array: Learn about array operations/object: Get a crash course on objects and their usage/null: Understand null handling
/ifelse: Learn about conditional statements/while: Get examples of loop structures
/entry: Understand program entry points and initialization/structure: Learn about recommended project organization and file structure
/patternMvc: Learn about the Model-View-Controller pattern/patternRepository: Understand the Repository pattern/patternFactory: Explore the Factory pattern/patternSingleton: Learn about the Singleton pattern/patternObserver: Understand the Observer pattern/patternStrategy: Explore the Strategy pattern
/types: Explore type-related concepts/language: Get comprehensive information about the current programming language/interface: Understand interface definitions
- Open VS Code
- Go to the Extensions view (Ctrl+Shift+X)
- Search for "FoolScript"
- Click Install
If you prefer to install the extension manually, follow these steps:
- Clone the repository or download the source code
- Open a terminal and navigate to the project directory
- Run
npm installto install dependencies - Run
npm run packageto create a .vsix file - In VS Code, go to the Extensions view (Ctrl+Shift+X)
- Click on the "..." menu at the top of the Extensions view
- Choose "Install from VSIX..."
- Navigate to and select the .vsix file you created
- Click "Install"
- Open a file in VS Code
- Open the GitHub Copilot chat window
- Type
@foolscriptfollowed by your query or command
Examples:
@foolscript /languageto get information about the current language@foolscript /patternStrategyto learn about the Strategy pattern@foolscript /structureto understand project organization@foolscript Explain how to declare variables in this language
- VS Code version 1.85.0 or higher
- GitHub Copilot extension installed and activated
Currently, FoolScript doesn't require any specific settings. It works out of the box!
Please report any issues you encounter on our GitHub repository.
We welcome contributions! Please see our Contributing Guide for more details.
This extension is released under the MIT License.
Enjoy learning with FoolScript! 🚀
For more information, visit our GitHub repository.