CodeStitch Helper (Unofficial)
CodeStitch Helper is a custom VSCode extension designed to streamline working with HTML, SVG, and form elements in your project, providing handy utilities for converting forms, replacing navigation structures, and adding CSS classes to SVG tags.
Features
The addIconClass
function finds an <svg>
tag in a document and adds a cs-icon
class. If the SVG tag already has a class
attribute, it appends cs-icon
to the existing class. If there is no class
attribute, it creates one with the cs-icon
class.
The convertToNetlifyForm
function scans the document for <form>
elements and converts them into Netlify-compatible forms by adding the data-netlify="true"
attribute. Additionally, it inserts a reCAPTCHA div before the form’s submit button for Netlify’s reCAPTCHA integration.
3. Replace Navigation Tabs with 11ty-Compatible Markup
The replaceNavTabs
function finds the <div class="cs-ul-wrapper">
element in the document and replaces its contents with a navigation structure compatible with the 11ty static site generator.
4. Select All Sections in Document
The selectAll
function selects all the content between sections in the document. It uses regex to identify sections and their corresponding lines, then selects everything between them.
5. CodeLens Integration
The CodeLensProvider
adds actionable lenses for common tasks:
- Convert
<form>
tags to Netlify-compatible forms.
- Add
cs-icon
class to SVG elements.
- Replace navigation wrappers with 11ty-compatible markup.
6. Section Navigation
The SectionNavigationProvider
allows users to quickly jump between sections of the document, especially helpful for large files with numerous sections marked by comments or headings.
Installation
- Open Visual Studio Code.
- Navigate to the Extensions view by clicking the Extensions icon in the Activity Bar on the side of the window.
- Search for
CodeStitch Helper
in the search bar.
- Click
Install
to install the extension.
Alternatively, you can install directly from the VS Code Marketplace.
Commands
codestitchHelper.addIconClass
: Adds the cs-icon
class to SVG tags.
codestitchHelper.convertToNetlifyForm
: Converts forms to Netlify-compatible versions.
codestitchHelper.replaceNavTabs
: Replaces navigation markup with 11ty-compatible structures.
codestitchHelper.selectAll
: Selects all content between defined sections in the document.
codestitchHelper.openSection
: Opens a specific section in the editor.
Planned Featured
- [X] Show stitch ID in styling and HTML navigator
- [X] Reorder style file to match HTML file
- [X] Button to open browser to CodeStitch stitch
- [X] Button to optimize linking stylesheet
- [X] Add a button to quickly jump to css file / line of a stitch
- [ ] Purge styles when HTML is modified, e.g. removing a button
- [ ] Astro support
- [ ] Add project helper window to catch common mistakes or improvements with project
License
MIT License