README for the "365-daynight-vscode-theme-ext" Extension

Read this document in other languages: Français, 中文, हिंदी, Deutsch, Русский, Português, 日本語, Español, العربية.

Introduction

Welcome to the README page for the "365-daynight-vscode-theme-ext" extension for VSCode.

For complete and detailed documentation, check our guides: [English (coming soon)], Français.

Overview

365DayNight VSCode Themes is an extension designed to enhance your coding experience throughout the year with dynamic and visually appealing themes. It is crafted to minimize eye strain and optimize readability by adapting your VSCode theme according to natural or artificial light, providing an uninterrupted coding experience 24/7.

Features

• Monthly Theme Collection: Twelve unique theme pairs, one for each month of the year
• Day and Night Themes: Two themes tailored for natural light during the day and artificial light at night.
• Special Holiday Themes: Unique themes for festive periods like New Year, Easter, Halloween, and Christmas.
• Automatic Theme Switching: Seamlessly adapts your theme based on the time of day.
• Quick Theme Toggle: Dedicated status bar button to quickly switch between day, night and high contrast themes with a single click.
• Accessibility: Enhanced accessibility features, especially for users with color blindness.

Extension Settings

• 365DayNight.enable: Enable or disable the extension.
• 365DayNight.mode: Set the mode to day, night, or auto for automatic switching.

Accessibility

We prioritize accessibility and have optimized the extension to be more inclusive, particularly for individuals with color vision deficiencies. We welcome any suggestions or ideas for further improvements.

Installation

To install the extension, visit the Visual Studio Marketplace and click "Install".

Release Notes

For detailed information on each version, please refer to the CHANGELOG.

Packaging

Use the command vsce package to create the .vsix file.

Additional Resources

For more information on using Markdown in Visual Studio Code, see the following links:

• Visual Studio Code Markdown Support
• Markdown Syntax Reference

Backlog and Future Updates

⚠️ Note: This section presents planned features and improvements for upcoming versions.

Next Developments

• [ ] #1 🔗 Update Image URL in README_fr.md
• [ ] #2 📝 Update all README_* files to align with README.md

Configuration and Testing

• [ ] #3 🧪 Set up unit tests
• [ ] #4 ⚙️ Prettier configuration
• [ ] #5 🔍 ESLint configuration (to evaluate)

CI/CD Pipeline

• [ ] #6 📦 Create automatic deployment pipeline (GitHub + Marketplace)

💡 Follow our progress or contribute via our GitHub Issues page

Developer Guide

Project Structure

• package.json - Manifest file that defines the extension, its commands and configurations.
• extension.js - Main file containing the implementation of the extension's functionality.
• themes/ - Directory containing all theme files.

Development

• Press F5 to open a new VS Code window with your extension loaded.
• You can reload the extension after making changes using Ctrl+R (or Cmd+R on Mac).
• Set breakpoints in extension.js to debug your extension.
• Check your extension's output in the debug console.

Testing

• Open the debug view (Ctrl+Shift+D or Cmd+Shift+D on Mac) and select Extension Tests from the launch configuration dropdown.
• Press F5 to run the tests in a new window with your extension loaded.
• Tests are located in the test/suite/ folder.

API Exploration

• To explore the complete VS Code API, open the file node_modules/@types/vscode/index.d.ts.

Additional Resources

• Follow UX Guidelines to create extensions that seamlessly integrate with VS Code's native interface.
• Configure Continuous Integration to automate builds.

Conclusion

Enjoy the flexibility and dynamics of the 365DayNight extension for an enriching coding experience!

Have fun with 365DayNight VSCode Themes!