https://github.com/Mariusmivw/vscode-42-norminette-3-highlighter

A simple Norminette highlighter for vscode
https://github.com/Mariusmivw/vscode-42-norminette-3-highlighter

vscode vscode-extension

Last synced: 2 months ago
JSON representation

A simple Norminette highlighter for vscode

• Host: GitHub
• URL: https://github.com/Mariusmivw/vscode-42-norminette-3-highlighter
• Owner: Mariusmivw
• License: mit
• Created: 2021-01-27T14:30:45.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-04T12:40:14.000Z (about 1 year ago)
• Last Synced: 2024-08-03T22:05:55.311Z (6 months ago)
• Topics: vscode, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 3.2 MB
• Stars: 25
• Watchers: 1
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-42 - source code

README

        




  





  



# 42 Norminette V3.x for VSCode

This extension is a Norminette (version 3.x) decorator for 42 in VSCode.\

If there are changes to the file, the norm is automatically checked on file save.

![example](img/example.gif)

## Features

### Quick enable-disable of highlighting

To enable or disable the highlighter you can press Shift+⌘+p\

![enable|disable|toggle](img/enable.gif)

### Normignore

If you want to ignore norminette errors in specific files in your project you can add a `.normignore` file.\

This files works in the same way as a `.gitignore` file.

### Tree view

View a summary of all the Norminette errors in your workspace.\



## Settings

In VSCode's settings.json you can add these lines if you want to customize your configuration. [how-to](https://code.visualstudio.com/docs/getstarted/settings)

```json5

{

	"codam-norminette-3.command": "norminette", // command that the highlighter executes to get the norm errors

	"codam-norminette-3.commandTimeoutMs": 10000, // Kill norminette process after this time (in ms) default 10000

	"codam-norminette-3.fileregex": "\\.[ch]$", // regex that matches the files you want to norm check

	"codam-norminette-3.ignoreErrors": [ // do not highlight these norm errors

		// "WRONG_SCOPE_COMMENT",

		// "LINE_TOO_LONG"

	],

	"codam-norminette-3.highlight-color": "rgba(255, 0, 0, 0.2)", // highlight norm errors in custom color. Can be in rgba, hex, or vscode.ThemeColor format.

	"codam-norminette-3.displayErrorName": false // display name of error on hover

}

```

## Installation

This extension can be found at:

[The VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=MariusvanWijk-JoppeKoers.codam-norminette-3) and [The OpenVSX Marketplace](https://open-vsx.org/extension/MariusvanWijk-JoppeKoers/codam-norminette-3)

Or launch Quick Open with ⌘+P and enter

```

ext install codam-norminette-3

```

This extension can also be installed from a VSIX package, which can be found on the [Releases page](https://github.com/Mariusmivw/vscode-42-norminette-3-highlighter/releases/latest). Open the Command Pallette (⌘+Shift+P) and search for `VSIX`.

## Issues

To report a bug or ask for a feature, please open a [Github issue](https://github.com/Mariusmivw/vscode-42-norminette-3-highlighter/issues)

## License

MIT