https://github.com/moinsen-dev/vscode-ext-flutter-lens
Flutter Lens is a VSCode extension that provides deeper insights into the documentation of Flutter packages and widgets.
https://github.com/moinsen-dev/vscode-ext-flutter-lens
flutter vscode-extension
Last synced: 4 months ago
JSON representation
Flutter Lens is a VSCode extension that provides deeper insights into the documentation of Flutter packages and widgets.
- Host: GitHub
- URL: https://github.com/moinsen-dev/vscode-ext-flutter-lens
- Owner: moinsen-dev
- License: mit
- Created: 2024-09-18T04:23:45.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2024-09-18T09:00:37.000Z (over 1 year ago)
- Last Synced: 2025-04-07T18:47:44.295Z (about 1 year ago)
- Topics: flutter, vscode-extension
- Language: TypeScript
- Homepage: https://www.moinsen.dev
- Size: 104 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Flutter Lens
[](https://marketplace.visualstudio.com/items?itemName=moinsen-dev.flutter-lens)
[](https://marketplace.visualstudio.com/items?itemName=moinsen-dev.flutter-lens)
[](https://marketplace.visualstudio.com/items?itemName=moinsen-dev.flutter-lens)
[](https://github.com/moinsen-dev/flutter-lens/blob/main/LICENSE)
Flutter Lens is a VSCode extension that provides deeper insights into the documentation of Flutter packages and widgets.
## Idea and Concept
For a detailed explanation of the idea behind Flutter Lens, including the problems it solves, use cases, and planned features, please refer to the [idea.md](idea.md) file in the root of this repository.
## Features
- Analyzes your project's `pubspec.yaml` file to extract information about installed packages
- Extracts and indexes documentation from pub.dev for each package
- Provides a searchable interface for querying package and widget documentation
- Offers similar question suggestions to improve search results
- Allows exporting search results for offline use
- Automatically updates documentation at regular intervals
- Sidebar UI for easy access to main functionalities
## How It Works
1. **Pubspec Analysis**: The extension scans your `pubspec.yaml` file to identify installed packages.
2. **Documentation Extraction**: For each package, Flutter Lens fetches the documentation from pub.dev and extracts relevant information.
3. **Indexing**: The extracted documentation is indexed using TF-IDF vectorization for efficient searching.
4. **Search Interface**: Users can query the indexed documentation through a searchable interface within VS Code.
5. **Similar Questions**: The extension suggests similar questions based on the user's input to improve search results.
6. **Regular Updates**: Documentation is automatically updated at set intervals to ensure the latest information is available.
## Installation
You can install Flutter Lens directly from the Visual Studio Code Marketplace:
1. Open VS Code
2. Go to the Extensions view (Ctrl+Shift+X)
3. Search for "Flutter Lens"
4. Click Install
## Usage
After installation:
1. Open a Flutter project in VS Code
2. Use the Flutter Lens sidebar to view your project's package information
3. Use the command palette (Ctrl+Shift+P) and search for "Flutter Lens" to access various features
## Contributing
We welcome contributions to Flutter Lens! If you'd like to contribute, please:
1. Fork the repository
2. Create a new branch for your feature
3. Make your changes
4. Submit a pull request
For more details, please see our [CONTRIBUTING.md](CONTRIBUTING.md) file.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Support
If you encounter any issues or have questions, please file an issue on the [GitHub repository](https://github.com/moinsen-dev/flutter-lens/issues).
## Acknowledgements
Special thanks to all contributors and the Flutter community for their support and inspiration.