Merge pull request #127 from SeeSharpSoft/master

Release 2.4.0

Author: SeeSharpSoft

CHANGELOG

@@ -1,7 +1,14 @@
+2.4.0
+May 11, 2019
+
+NEW: option to keep/ignore a linebreak at the end of a file (table editor)
+NEW: improved change detection of table editor to avoid overwriting original text representation without editing any values
+NEW: file based value separator (e.g. ',' or ';')
+
 2.3.1
 Mar 31, 2019
 
-NEW: use default color scheme font for table editor as well
+NEW: use default color scheme & font for table editor as well
 FIX: ConcurrentModificationException tackled (table editor)
 
 2.3.0

README.md

@@ -3,6 +3,7 @@
 [![Coverage Status](https://coveralls.io/repos/github/SeeSharpSoft/intellij-csv-validator/badge.svg?branch=master)](https://coveralls.io/github/SeeSharpSoft/intellij-csv-validator?branch=master)
 [![Known Vulnerabilities](https://snyk.io/test/github/SeeSharpSoft/intellij-csv-validator/badge.svg?targetFile=build.gradle)](https://snyk.io/test/github/SeeSharpSoft/intellij-csv-validator?targetFile=build.gradle)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/97769359388e44bfb7101346d510fccf)](https://www.codacy.com/app/github_124/intellij-csv-validator?utm_source=github.com&utm_medium=referral&utm_content=SeeSharpSoft/intellij-csv-validator&utm_campaign=Badge_Grade)
+[![BCH compliance](https://bettercodehub.com/edge/badge/SeeSharpSoft/intellij-csv-validator?branch=master)](https://bettercodehub.com/results/SeeSharpSoft/intellij-csv-validator/)
 
 # Lightweight CSV Plugin for JetBrains IDE family
 
@@ -147,6 +148,10 @@ Set whether soft wrapping should be activated for CSV/TSV. It still can be chang
 
 Defines how many lines of text are shown in one editor cell by default. *Auto* does recalculate the height on the fly that can cause some flickering while editing. This setting can be changed in the table editor itself per file.
 
+##### Keep/ignore linebreak at end of file
+
+If the file ends with a completely empty line (no spaces or tabs either), the table editor will not show this line as empty values but ignore it. When table data is serialized, an existing empty line is kept at the end of the file.
+
 ##### Show info panel
 
 Enables/disables the info panel at the bottom of the table editor.
@@ -202,6 +207,8 @@ Annasusanna,Amsterdam,1
 
 The following separators are currently supported: **,** (Comma), **;** (Semicolon), **|** (Pipe) and **↹** (Tab)
 
+_Value separator (default)_ defines which separator is used by default. The separator character can be changed for each CSV file individually.
+
 When changing the separator, press the apply button to refresh the preview window properly. 
 
 _Space before separator_
@@ -274,6 +281,18 @@ Annasusanna,Amsterdam,         1
         Ben,   Berlin,         2
 ```
 
+### Actions
+
+#### File specific value separator
+
+![Context menu](./docs/contextmenu.png)
+
+The action to switch the value separator used for CSV syntax validation of a specific file is part of its text editors context menu.
+
+
+This action defines how the parser/validator/highlighter/etc. behaves. It does intentionally not change the file content.
+To be more precise: It **does not replace** previous separator characters by new ones or adjust the escaped texts.
+
 ### Inspections
 
 - _File > Settings > Editor > Inspections > CSV_ 

docs/contextmenu.png

@@ -3,7 +3,7 @@
 # https://www.jetbrains.com/intellij-repository/snapshots
 
 name='CSV Plugin'
-pluginVersion=2.3.1
+pluginVersion=2.4.0
 javaVersion=1.8
 javaTargetVersion=1.8
 downloadIntellijSources=false

gradle.properties

@@ -0,0 +1,19 @@
+package net.seesharpsoft.intellij.lang;
+
+import com.intellij.lang.ParserDefinition;
+import com.intellij.lang.PsiParser;
+import com.intellij.lexer.Lexer;
+import com.intellij.psi.PsiFile;
+
+/**
+ * Support for file specific parser definition.
+ */
+public interface FileParserDefinition extends ParserDefinition {
+    default Lexer createLexer(PsiFile file) {
+        return createLexer(file.getProject());
+    }
+
+    default PsiParser createParser(PsiFile file) {
+        return createParser(file.getProject());
+    }
+}

src/main/java/net/seesharpsoft/intellij/lang/FileParserDefinition.java

@@ -25,6 +25,12 @@ public RowInfo getRowInfo(T element) {
         return myElementInfos.get(element);
     }
 
+    public RowInfo getRowInfo(int index) {
+        return myElementInfos.values().stream()
+                .filter(rowInfo -> rowInfo.getRowIndex() == index)
+                .findFirst().orElse(null);
+    }
+
     public int getColumnIndex() {
         return myColumnIndex;
     }

src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvColumnInfo.java

@@ -54,4 +54,19 @@ public boolean hasErrors() {
     public void setHasErrors(boolean hasErrorsArg) {
         hasErrors = hasErrorsArg;
     }
+
+    public boolean hasEmptyLastLine() {
+        CsvColumnInfo<T> columnInfo = myInfoColumnMap.get(0);
+        int size = columnInfo.getSize();
+        if (!columnInfo.getRowInfo(size - 1).getTextRange().isEmpty()) {
+            return false;
+        }
+        for (int columnIndex = 1; columnIndex < myInfoColumnMap.size(); ++columnIndex) {
+            if (myInfoColumnMap.get(columnIndex).getSize() == size) {
+                return false;
+            }
+        }
+        return true;
+    }
+
 }

src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvColumnInfoMap.java

@@ -8,13 +8,15 @@
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiFile;
 import com.intellij.psi.PsiManager;
 import com.intellij.psi.TokenType;
 import com.intellij.psi.impl.source.DummyHolder;
 import com.intellij.psi.impl.source.DummyHolderFactory;
 import com.intellij.psi.impl.source.tree.FileElement;
 import com.intellij.psi.tree.IElementType;
 import com.intellij.psi.util.PsiTreeUtil;
+import net.seesharpsoft.intellij.lang.FileParserDefinition;
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvField;
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvFile;
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvRecord;
@@ -27,14 +29,15 @@ public final class CsvHelper {
 
     // replaces PsiElementFactory.SERVICE.getInstance(element.getProject()).createDummyHolder("<undefined>", CsvTypes.FIELD, null);
     // https://github.com/SeeSharpSoft/intellij-csv-validator/issues/4
-    public static PsiElement createEmptyCsvField(Project project) {
+    public static PsiElement createEmptyCsvField(PsiFile psiFile) {
+        final Project project = psiFile.getProject();
         final String text = "<undefined>";
         final IElementType type = CsvTypes.FIELD;
         final PsiManager psiManager = PsiManager.getInstance(project);
         final DummyHolder dummyHolder = DummyHolderFactory.createHolder(psiManager, null);
         final FileElement fileElement = dummyHolder.getTreeElement();
-        final ParserDefinition parserDefinition = LanguageParserDefinitions.INSTANCE.forLanguage(CsvLanguage.INSTANCE);
-        final Lexer lexer = parserDefinition.createLexer(project);
+        final FileParserDefinition parserDefinition = (FileParserDefinition)LanguageParserDefinitions.INSTANCE.forLanguage(CsvLanguage.INSTANCE);
+        final Lexer lexer = parserDefinition.createLexer(psiFile);
         final PsiBuilder psiBuilder = PsiBuilderFactory.getInstance().createBuilder(project, fileElement, lexer, CsvLanguage.INSTANCE, text);
         final ASTNode node = parserDefinition.createParser(project).parse(type, psiBuilder);
         fileElement.rawAddChildren((com.intellij.psi.impl.source.tree.TreeElement) node);
@@ -44,7 +47,7 @@ public static PsiElement createEmptyCsvField(Project project) {
     public static boolean isCsvFile(Project project, VirtualFile file) {
         final FileType fileType = file.getFileType();
         return (fileType instanceof LanguageFileType && ((LanguageFileType) fileType).getLanguage().isKindOf(CsvLanguage.INSTANCE)) ||
-                (fileType == ScratchFileType.INSTANCE && LanguageUtil.getLanguageForPsi(project, file) == CsvLanguage.INSTANCE);
+                (fileType == ScratchFileType.INSTANCE && LanguageUtil.getLanguageForPsi(project, file).isKindOf(CsvLanguage.INSTANCE));
     }
 
     public static IElementType getElementType(PsiElement element) {

src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvHelper.java

@@ -1,7 +1,6 @@
 package net.seesharpsoft.intellij.plugins.csv;
 
 import com.intellij.lang.ASTNode;
-import com.intellij.lang.ParserDefinition;
 import com.intellij.lang.PsiParser;
 import com.intellij.lexer.Lexer;
 import com.intellij.openapi.project.Project;
@@ -11,21 +10,23 @@
 import com.intellij.psi.TokenType;
 import com.intellij.psi.tree.IFileElementType;
 import com.intellij.psi.tree.TokenSet;
+import net.seesharpsoft.intellij.lang.FileParserDefinition;
 import net.seesharpsoft.intellij.plugins.csv.parser.CsvParser;
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvFile;
+import net.seesharpsoft.intellij.plugins.csv.psi.CsvFileElementType;
 import net.seesharpsoft.intellij.plugins.csv.psi.CsvTypes;
 import net.seesharpsoft.intellij.plugins.csv.settings.CsvCodeStyleSettings;
 import org.jetbrains.annotations.NotNull;
 
-public class CsvParserDefinition implements ParserDefinition {
+public class CsvParserDefinition implements FileParserDefinition {
     public static final TokenSet WHITE_SPACES = TokenSet.create(TokenType.WHITE_SPACE);
 
-    public static final IFileElementType FILE = new IFileElementType(CsvLanguage.INSTANCE);
+    public static final IFileElementType FILE = new CsvFileElementType(CsvLanguage.INSTANCE);
 
     @NotNull
     @Override
     public Lexer createLexer(Project project) {
-        return new CsvLexerAdapter(CsvCodeStyleSettings.getCurrentSeparator(project));
+        throw new UnsupportedOperationException("use 'createLexer(PsiFile file)' instead");
     }
 
     @Override
@@ -72,4 +73,14 @@ public SpaceRequirements spaceExistanceTypeBetweenTokens(ASTNode left, ASTNode r
     public PsiElement createElement(ASTNode node) {
         return CsvTypes.Factory.createElement(node);
     }
+
+    @Override
+    public Lexer createLexer(@NotNull PsiFile file) {
+        return new CsvLexerAdapter(CsvCodeStyleSettings.getCurrentSeparator(file));
+    }
+
+    @Override
+    public PsiParser createParser(@NotNull PsiFile file) {
+        return createParser(file.getProject());
+    }
 }

src/main/java/net/seesharpsoft/intellij/plugins/csv/CsvParserDefinition.java

@@ -15,8 +15,11 @@ private CsvParserUtil() {
     public static boolean separator(PsiBuilder builder, int tokenType) {
         if (builder.getTokenType() == CsvTypes.COMMA) {
             PsiFile currentFile = builder.getUserDataUnprotected(FileContextUtil.CONTAINING_FILE_KEY);
+            if (currentFile == null) {
+                throw new UnsupportedOperationException("parser requires containing file");
+            }
             return builder.getTokenText().equals(
-                    CsvCodeStyleSettings.getCurrentSeparator(builder.getProject(), currentFile != null ? currentFile.getLanguage() : null)
+                    CsvCodeStyleSettings.getCurrentSeparator(currentFile)
             );
         }
         return false;