https://github.com/spences10/robots-txt-syntax-highlighting

robots.txt syntax highlighting for VS Code
https://github.com/spences10/robots-txt-syntax-highlighting

highlighting robots-txt syntax vscode vscode-extension

Last synced: 28 days ago
JSON representation

robots.txt syntax highlighting for VS Code

• Host: GitHub
• URL: https://github.com/spences10/robots-txt-syntax-highlighting
• Owner: spences10
• License: mit
• Created: 2023-10-16T18:00:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-20T05:48:10.000Z (about 1 year ago)
• Last Synced: 2024-11-05T18:56:59.916Z (3 months ago)
• Topics: highlighting, robots-txt, syntax, vscode, vscode-extension
• Homepage:
• Size: 230 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Robots.txt Syntax Highlighting Extension for VS Code

[![Marketplace Version](https://vsmarketplacebadges.dev/version/spences10.robots-txt.svg)](https://marketplace.visualstudio.com/items?itemName=spences10.robots-txt)

[![Installs](https://vsmarketplacebadges.dev/installs/spences10.robots-txt.svg)](https://marketplace.visualstudio.com/items?itemName=spences10.robots-txt)

[![Rating](https://vsmarketplacebadges.dev/rating-short/spences10.robots-txt.svg)](https://marketplace.visualstudio.com/items?itemName=spences10.robots-txt)

This extension provides syntax highlighting for robots.txt files in Visual Studio Code, making it easier to read and write them.

Read the blog post on [Making a robots.txt syntax highlighter for VS Code](https://scottspence.com/posts/making-a-robots-txt-syntax-highlighter-for-vs-code) for more information.

![robots-example-image](.github/assets/robots-example-image.png)

## Features

- Syntax highlighting for standard robots.txt directives including User-agent, Disallow, Allow, Sitemap, and Host.

- Highlights comments starting with #.

- Added snippets for common directives.

## Supported Directives

This extension supports the following robots.txt directives:

- `User-agent`: Identifies the robot the rule applies to.

- `Disallow`: Specifies a URL path that a robot is not allowed to request.

- `Allow`: Specifies a URL path that a robot is allowed to request.

- `Sitemap`: Specifies the URL of a sitemap for the website.

- `Host`: Specifies the preferred domain for the website.

## Publishing

Set package version with `npm`

```bash

npm version patch # major 1.0.0 | minor 0.1.0 | patch 0.0.1

vsce package

vsce publish

```

For details on getting a personal access token check [here](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#get-a-personal-access-token).