burn-e99/mybatis-lang-support

Adds support for mybatis xml in Java projects, helping alleviate typos.

mybatis-lang-support

Mybatis Lang Support adds useful error checking to Mybatis mapper XML files, helping alleviate typos and other common issues.

This extension is intended to be used on ibatis and mybatis projects using useStatementNamespaces="true" (details). If your project does not use this, or utilizes references without namespaces, you should enable the legacySupport setting.

Features

• Verifies that all <, >, and & characters are properly encoded, and provides quickfixes when they are not properly encoded
• Verifies that all references exist with valid namespaces, and provides quickfixes when a namespace is missing from the reference
• Verifies that ids are not duplicated
• Verifies that all tags are properly closed
• Provides quick links on <include refid tags to quickly jump between the usage and definition
• Shows definition of the <include refid when holding Ctrl and hovering over a refid
• Provides tab completion for refids, first suggesting the namespaces, then after pressing ., the sql references
  • !! NOTICE !! Tab completions will not work without the following setting set either in your workspace or user settings:

    "editor.quickSuggestions": {
    	"strings": true
    }
    

Extension Settings

• mybatis-lang-support.mapperPath: Name of the folder holding your mapper.xml files. Start with ./ to make relative to this workspace.
• mybatis-lang-support.mapperTag: Name of the tag that defines the mappers.
• mybatis-lang-support.legacySupport: Enable this setting to support legacy standards. This setting will remove the namespace requirement for <include refid=\"\"/>, allowing ids to be referenced without a namespace.

Installation

Get it direct from the Extension Marketplace.

Release Notes

See CHANGELOG.md

Problems?

Please raise a descriptive issue on this GitHub repo containing examples of the problem you are encountering. The more clear and desciptive the issue, the more likely it will be investigated and fixed quickly.

mybatis-lang-support's Issues

Suggest namespace quickfix for refIdMissingNoNamespace

The extension should see if the desired id is defined somewhere in the project, and if it is, suggest the namespaces as quickfixes.

Namespaces can be shared between files

Namespaces can be shared between files, downgrade to warning and make sure all namespaces are checked before showing an error on refids without a namespace

Create Fix All command

The extension should provide a command (activated by Ctrl+Shift+P) to fix all quick fixable issues.

Add reference Ctrl+click to Java dao files

User should be able to Ctrl+click a valid SQL id in dao/mybatis Java files. This should take the user to the desired SQL statement

Create setting to support legacy apps that use a global namespace

This extension is designed to enforce good coding practices, but in legacy apps, this will result in lots of errors on include refid tags that do not have a namespace included.

Create a setting to downgrade this error to a warning for legacy apps.

Add duplicate id checking to the resulMap tag

Extension should verify that none of the resultMaps have duplicated ids.

Add tab completion to refids

User should be able to tab complete namespaces and refids.

Nested foreaches throw missing pair error on final outer foreach

<foreach>
<foreach>
</foreach>
<foreach>
</foreach>
</foreach> <-- ERROR HERE

Using the Ctrl+. Quick fix shortcut key places the fix in the wrong spot

Export Mybatis statement to SQL

Provide an action to export a sql statement (select, update, delete, insert) from mybatis to raw sql

Older versions of mybatis/ibatis use sqlMap in place of mapper

Create a new setting to indicate what type of mapper the workspace is using (sqlMap VS mapper)

Closing tags without an opening do not get an error if they come before a pair of opening/closing tags

</case> <- this should have an error, but does not
<case>
</case>
</case> <- this should have an error and does

&& in ampersand message

The description for the & issue has the & duplicated

resultMap can be self closing

resultMap can be self closing, but the extension is not treating it as such

SQL IDs can be duplicated when a database is specified on it

readme update

Make a note in the readme specifying that this extension is intended to be used on ibatis/mybatis projects using useStatementNamespaces="true"

http://java.ociweb.com/mark/programming/iBATIS.html#MappedStatements

Add error checking to Java files to ensure the desired SQL statement exists

The user should get errors when the desired SQL statement does not exist in the projects mappers

< and > are showing errors in <if test="a > b">

< and > are showing as errors in

<,>,<=,>= need to be ignored inside xml strings

Check for partial NEQ conversions

Check for and provide error/quickfix for the following issues:
<>
<&gt;

Always displays "Invalid path for Mapper Path"

If opens a general multi-module maven project, this alarm will be always displayed.

no_namespace error shown on file even if file does not have a mapper in it.

File should not get error put on it when it has no namespace

Offer all possible namespaces that contain a SQL id as quick fix options

When a reference is not found in the current file, we currently only suggest the first SQL id namespace we find. We should suggest all possible namespace options.

namespace parsing needs to ignore comments

When parsing the ids and namespaces out of files, comments need to be ignored

Add reference linking to resultMaps

I want to be able to Ctrl+Click on a resultMap="blah" and be linked to the resultMap with said id.

<result is complaining about missing a closing

<result in <resultMap is complaining about a missing closing. It should not be looking only at <result and should instead look at the full tag name <resultMap

Diagnostics not ignoring comments

Diagnostic errors/warnings should ignore commented out code

Add code fix for refids that are missing a namespace

Suggestion should be the current file. Suggestion should only show up when the refid does exist on the local namespace but no namespace is provided.

Add error checking around &

& is an illegal character in xml, but is a legal SQL character (bitwise AND). Add error checking around this character.

property is complaining about a missing closing when closing is matched

File has a mix of normal and self closed property tags, but some of the self closed tags are showing the propertyMissingClosing error

Update refIdMissingNoNamespace error

The error should state the namespace instead of saying this file's namespace.

Caret issues do not show error when a tag is in the same line

Example that is causing an error to not appear:
AND COLNAME5 >= <include refid="Example.testNumber"/>

CDATA needs to ignore caret issues

If a caret issue is found within a CDATA block, we can safely ignore it.

Example:

<![CDATA[ <> ]]>

When a namespace is shared between files, duplicateId error seems to show on first line of the file

When the namespace has duplicate ids, but none of these duplicates are in the file that the namespace is shared in, the errors are showing on the first line of the file.

Add CDATA as an option to fixing caret issues

There should be an additional quickfix option added to the caret issue that suggests fixing it with the following (example is for NEQ, instead of doing <>

<![CDATA[ <> ]]>