### Install awesome-lint Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/repository-structure.md Command to install the awesome-lint tool globally using npm. ```bash npm install -g awesome-lint ``` -------------------------------- ### Install and Run Awesome-Lint Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/contributing.md Install the awesome-lint tool globally and run it to check for formatting errors in your README.md file. ```bash npm install -g awesome-lint awesome-lint ``` -------------------------------- ### Install and Run awesome-lint Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/contributing.md Commands to install the awesome-lint tool globally and run it for local validation before submitting a PR. ```bash # Install awesome-lint if not already installed npm install -g awesome-lint # Run validation awesome-lint ``` -------------------------------- ### Foundation Layer Utilities Example Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/ecosystem-guide.md Illustrates how plugins like 'log.wz' are consumed by UI components, demonstrating the dependency on the Foundation Layer. ```text sravioli/log.wz ← used by UI components sravioli/ribbon.wz ← for text styling sravioli/memo.wz ← used for caching by multiple plugins sravioli/warp.wz ← used by utilities throughout ``` -------------------------------- ### Control Layer Dependency Example Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/ecosystem-guide.md Shows how productivity plugins can integrate with keybinding systems, highlighting the relationship between Control and Productivity layers. ```text keybinding systems ← enable navigation plugins modal.wezterm ← foundation for specialized bindings ``` -------------------------------- ### Multi-Tool Workflow Integration Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/ecosystem-guide.md Illustrates a sequence of plugins used in a typical development workflow, from project start to issue resolution. ```text Project starts → workspace manager selects → resurrect restores state → tab bar shows progress → keybindings enable navigation → error detector jumps to issues ``` -------------------------------- ### Valid PR Title Examples Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/contributing.md Examples of correctly formatted PR titles that adhere to the specified pattern. ```text Add 'MLFlexer/resurrect.wezterm' ``` ```text Update 'michaelbrusegard/tabline.wez' ``` ```text Remove 'old-owner/deprecated-plugin' ``` -------------------------------- ### Invalid PR Title Examples Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/contributing.md Examples of incorrectly formatted PR titles that do not adhere to the specified pattern. ```text Add MLFlexer/resurrect.wezterm (missing backticks) ``` ```text add 'MLFlexer/resurrect.wezterm' (lowercase 'add') ``` ```text Add 'mlflexer/resurrect' (incomplete repo name) ``` ```text Add resurrect (missing owner) ``` -------------------------------- ### Run awesome-lint Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/repository-structure.md Command to execute the awesome-lint tool from the repository root. ```bash # Run from repository root awesome-lint ``` -------------------------------- ### Repository File Structure Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/repository-structure.md Illustrates the directory and file layout of the awesome-wezterm repository. ```tree awesome-wezterm/ ├── README.md # Main awesome list with categorized plugins ├── CONTRIBUTING.md # Contribution guidelines and PR procedures ├── LICENSE # MIT license text └── .github/ ├── workflows/ │ └── pr-title.yml # PR title validation workflow └── pull_request_template.md # PR template (inherited from awesome list standard) ``` -------------------------------- ### Clone Repository Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/contributing.md Clone your fork of the Awesome WezTerm repository to your local machine. ```bash git clone https://github.com/your-username/awesome-wezterm.git cd awesome-wezterm ``` -------------------------------- ### Configuration Persistence Workflow Integration Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/ecosystem-guide.md Details a workflow for synchronizing and restoring WezTerm configurations across different machines using sync and workspace plugins. ```text Config changes → wezterm-sync uploads → new machine → wezterm-sync downloads → workspace-picker restores → resurrect restores state ``` -------------------------------- ### Entry Format for Plugins Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/INDEX.md New entries in the list must follow this markdown format, including the plugin name, a link to its GitHub repository, and a brief description. ```markdown - [Plugin Name](https://github.com/owner/repo) - Brief description under 120 characters. ``` -------------------------------- ### AI-Assisted Development Workflow Integration Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/ecosystem-guide.md Shows how AI-related plugins can be integrated into a development workflow for command generation and output parsing. ```text Command needed → AI commander generates → replay parses output → quickselect opens errors → agent-deck monitors progress → quota monitor shows limits ``` -------------------------------- ### Stage and Commit Changes Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/contributing.md Stage the modified README.md file and commit your changes with a descriptive message. ```bash git add README.md git commit -m "Add `owner/plugin-name` to Utility category" ``` -------------------------------- ### Markdown Entry Format Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/contributing.md The required markdown format for adding new plugin entries to the awesome list. ```markdown - [Plugin Name](repository-url) - Brief description (under 120 characters). ``` -------------------------------- ### Create Feature Branch Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/contributing.md Create a new branch for your feature or changes. ```bash git checkout -b add-new-plugin ``` -------------------------------- ### Plugin Categories Overview Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/00-START-HERE.md This is a visual representation of the plugin categories and their relative counts within the awesome-wezterm project. It helps users quickly understand the distribution of plugins across different functionalities. ```text Session Management (9 plugins) ████████████████████ Utility Libraries (17 plugins) █████████████████████████████████████ Keybinding (7 plugins) █████████████ Tab Bar UI (6 plugins) ████████████ Themes (4 plugins) ████████ AI Integration (5 plugins) ██████████ Neovim Integration (2 plugins) ████ Pane Management (2 plugins) ████ Media (1 plugin) ██ ``` -------------------------------- ### Push Changes to Fork Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/contributing.md Push your committed changes from your local branch to your fork on GitHub. ```bash git push origin add-new-plugin ``` -------------------------------- ### PR Title Format Regex Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/contributing.md The regular expression pattern that PR titles must match for adding, updating, or removing plugins. ```regex ^(Add|Update|Remove) `.+\/.+`$ ``` -------------------------------- ### GitHub Actions PR Title Validation Workflow Configuration Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/repository-structure.md This YAML configuration defines a GitHub Actions workflow that triggers on pull request events and validates changes to the README.md file. ```yaml name: PR Title on: pull_request: types: [opened, edited, synchronize] paths: [README.md] ``` -------------------------------- ### Pull Request Title Format Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/INDEX.md All pull requests must adhere to this format for adding, updating, or removing plugins. This format is validated by a regular expression. ```text Add 'owner/repo' Update 'owner/repo' Remove 'owner/repo' ``` ```regex ^(Add|Update|Remove) .+\/.+$ ``` -------------------------------- ### PR Title Regex Pattern Source: https://github.com/michaelbrusegard/awesome-wezterm/blob/main/_autodocs/repository-structure.md The regular expression pattern used to validate the title of pull requests. ```regex ^(Add|Update|Remove) .+\/.+"$ ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.