MySQL CNF Formatter and Linter

VS Code extension for my.cnf and other MySQL option files.

Features

• Registers a mysql-cnf language for .cnf, my.cnf, and my.ini files.
• Formats option files with normalized comments, section headers, spacing, and aligned = signs, including across comments inside the same option block.
• Lints malformed sections, unparsable option lines, duplicate non-repeatable options, tabs, trailing whitespace, missing include paths, unknown option groups, and common boolean, integer, and size values.
• Shows hover descriptions for common MySQL option names and option groups.
• Allows template placeholders such as {{ server_id }} by default for generated configs.

Local Development

Open this folder in VS Code and run the extension in an Extension Development Host. The sample my.cnf.example can be used to try formatting and diagnostics.

Useful command:

npm run check
npm run package:vsix

GitHub Actions Publishing

The workflow in .github/workflows/vscode-extension.yml packages the extension on pull requests and pushes to main or master. After a PR is merged, the push to main packages the merged code and checks package.json. If the package version does not already have a matching tag such as v0.0.2, the workflow publishes the VSIX to the VS Code Marketplace, creates that GitHub release tag, and attaches the VSIX to the release.

The workflow also supports publishing from an existing version tag such as v0.0.2, or from a manual workflow run with publish enabled.

Before publishing:

• Make sure publisher in package.json exactly matches your VS Code Marketplace publisher ID.
• Create a VS Code Marketplace Personal Access Token.
• Add that token in GitHub as Settings -> Secrets and variables -> Actions -> New repository secret named VSCE_PAT.

To publish from a PR, bump the extension version without creating a local git tag:

npm version patch --no-git-tag-version
git add package.json
git commit -m "Bump extension version"
git push origin your-branch

Open a PR and merge it into main. The merged push creates the release automatically if the matching vX.Y.Z tag does not already exist.

If you publish from a tag instead, the workflow verifies that the pushed tag, for example v0.0.2, matches the version in package.json before publishing.

Commands

• MySQL CNF: Format Document
• MySQL CNF: Lint Document

Settings

• mysqlCnf.format.alignEquals
• mysqlCnf.format.inlineCommentColumn
• mysqlCnf.format.finalNewline
• mysqlCnf.lint.allowTemplatePlaceholders
• mysqlCnf.lint.warnOnUnknownSections
• mysqlCnf.lint.allowedSections
• mysqlCnf.lint.repeatableOptions