Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Desktop: Resolves #4813 : skip empty lines while converting selection to list #4832

Merged
merged 7 commits into from
May 4, 2021
Merged

Desktop: Resolves #4813 : skip empty lines while converting selection to list #4832

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2e68c00
unexpected insert- list behaviour fixed
adarsh-sgh Apr 12, 2021
80004ad
tests added
adarsh-sgh Apr 22, 2021
bc969bb
only skip last empty line
adarsh-sgh Apr 27, 2021
00d5b1f
refactored
adarsh-sgh May 1, 2021
3055603
a console logging removed
adarsh-sgh May 3, 2021
f50d9d0
Update useCursorUtils.test.ts
laurent22 May 4, 2021
5a358c3
Update useCursorUtils.test.ts
laurent22 May 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .eslintignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,9 @@ packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/types.js.map
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useCursorUtils.d.ts
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useCursorUtils.js
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useCursorUtils.js.map
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useCursorUtils.test.d.ts
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useCursorUtils.test.js
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useCursorUtils.test.js.map
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useEditorSearch.d.ts
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useEditorSearch.js
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useEditorSearch.js.map
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,9 @@ packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/types.js.map
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useCursorUtils.d.ts
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useCursorUtils.js
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useCursorUtils.js.map
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useCursorUtils.test.d.ts
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useCursorUtils.test.js
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useCursorUtils.test.js.map
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useEditorSearch.d.ts
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useEditorSearch.js
packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useEditorSearch.js.map
Expand Down
21 changes: 21 additions & 0 deletions packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useCursorUtils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { modifyListLines } from './useCursorUtils';

describe('Check list item modification', () => {
const num = 0;
let lineInitial = `- item1
- item2
- item3`;
let lineFinal = `item1
item2
item3`;
test('should remove "- " from beggining of each line of input string', () => {
expect(JSON.stringify(modifyListLines(lineInitial.split('\n'), num, '- '))).toBe(JSON.stringify(lineFinal.split('\n')));
});
test('should add "- " at the beggining of each line of the input string', () => {
// swap input and expected output
const temp = lineInitial;
lineInitial = lineFinal;
lineFinal = temp;
expect(JSON.stringify(modifyListLines(lineInitial.split('\n'), num, '- '))).toBe(JSON.stringify(lineFinal.split('\n')));
});
});
40 changes: 21 additions & 19 deletions packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useCursorUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
import markdownUtils from '@joplin/lib/markdownUtils';
import Setting from '@joplin/lib/models/Setting';

export function modifyListLines(lines: string[],num: number,string1: string) {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please could you give a descriptive name to "string1"?

for (let j = 0; j < lines.length; j++) {
const line = lines[j];
if (!line && j == lines.length - 1) continue;
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

strict equality ===

// Only add the list token if it's not already there
// if it is, remove it
if (!line.startsWith(string1)) {
if (num) {
lines[j] = `${num.toString()}. ${line}`;
num++;
} else {
lines[j] = string1 + line;
}
} else {
lines[j] = line.substr(string1.length, line.length - string1.length);
}
}
return lines;
}
// Helper functions that use the cursor
export default function useCursorUtils(CodeMirror: any) {

Expand Down Expand Up @@ -81,28 +99,12 @@ export default function useCursorUtils(CodeMirror: any) {
for (let i = 0; i < selectedStrings.length; i++) {
const selected = selectedStrings[i];

let num = markdownUtils.olLineNumber(string1);
const num = markdownUtils.olLineNumber(string1);

const lines = selected.split(/\r?\n/);
// Save the newline character to restore it later
const newLines = selected.match(/\r?\n/);

for (let j = 0; j < lines.length; j++) {
const line = lines[j];
// Only add the list token if it's not already there
// if it is, remove it
if (!line.startsWith(string1)) {
if (num) {
lines[j] = `${num.toString()}. ${line}`;
num++;
} else {
lines[j] = string1 + line;
}
} else {
lines[j] = line.substr(string1.length, line.length - string1.length);
}
}

modifyListLines(lines,num,string1);
const newLine = newLines !== null ? newLines[0] : '\n';
selectedStrings[i] = lines.join(newLine);
}
Expand Down