Skip to content
This repository has been archived by the owner on Aug 16, 2023. It is now read-only.

Banno/vscode-uxlint

Repository files navigation

vscode-uxlint

VSCode extension for ux-lint linting of JS and HTML code.

(This is not actually implemented yet.) The extension uses the ux-lint module installed in the opened workspace folder. If ux-lint is installed elsewhere, you can configure the path option to point to it (see "Options" below).

Installation

Go to the Releases page to download the VSIX file. Then install it through the VSCode Extensions panel, Command Palette, or command line -- see the VSCode documentation for details.

Options

These options are not yet implemented.

This extension contributes the following variables to the settings:

  • uxlint.enable: Enable/disable linting. It is enabled by default.
  • uxlint.exclude: File pattern, or array of file patterns, to ignore.
  • uxlint.options: Linter options. Uses the default rules if not set. Can be either a string, pointing to a filename, or an object containing the rules.
  • uxlint.path: Path to the ux-lint module. Defaults to node_modules/ux-lint.

Development

  • Press F5 (or use the Debug panel) in VSCode to launch the extension for testing.
  • Run npm start, or press cmd+shift+b in VSCode, to manually start the server.

Please use the existing conventions when modifying the project. Use the lint and test npm scripts to check the code.

Packaging & Publishing

You'll need the vsce tool installed. See the VSCode documentation for details.

When a new release is ready:

  1. Run vsce package.
  2. Upload the VSIX file as a the release binary. See Github's "Creating Releases" docs.

License

Copyright 2017 Jack Henry & Associates Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.