Skip to content

Code cells in .R files #662

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

Merged
renkun-ken merged 3 commits into from
Jun 7, 2021
Merged

Code cells in .R files #662

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
74ab63d
Code cells in .R files
ElianHugh Jun 7, 2021
4321925
Update rmarkdown.ts
ElianHugh Jun 7, 2021
60949e7
Remove unused languages
renkun-ken Jun 7, 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
37 changes: 18 additions & 19 deletions src/extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<apiImp
// is used to export an interface to the help panel
// this export is used e.g. by vscode-r-debugger to show the help panel from within debug sessions
const rExtension = new apiImplementation.RExtensionImplementation();

// assign extension context to global variable
extensionContext = context;

Expand All @@ -41,7 +41,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<apiImp
// create R terminal
'r.createRTerm': rTerminal.createRTerm,

// run code from editor in terminal
// run code from editor in terminal
'r.nrow': () => rTerminal.runSelectionOrWord(['nrow']),
'r.length': () => rTerminal.runSelectionOrWord(['length']),
'r.head': () => rTerminal.runSelectionOrWord(['head']),
Expand Down Expand Up @@ -103,7 +103,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<apiImp

// (help related commands are registered in rHelp.initializeHelp)
};
for(const key in commands){
for (const key in commands) {
context.subscriptions.push(vscode.commands.registerCommand(key, commands[key]));
}

Expand All @@ -115,15 +115,15 @@ export async function activate(context: vscode.ExtensionContext): Promise<apiImp
// register on-enter rule for roxygen comments
const wordPattern = /(-?\d*\.\d\w*)|([^`~!@$^&*()=+[{\]}\\|;:'",<>/\s]+)/g;
vscode.languages.setLanguageConfiguration('r', {
onEnterRules: [
{
// Automatically continue roxygen comments: #'
action: { indentAction: vscode.IndentAction.None, appendText: '#\' ' },
beforeText: /^#'.*/,
},
],
wordPattern,
});
onEnterRules: [
{
// Automatically continue roxygen comments: #'
action: { indentAction: vscode.IndentAction.None, appendText: '#\' ' },
beforeText: /^#'.*/,
},
],
wordPattern,
});

// initialize httpgd viewer
globalHttpgdManager = httpgdViewer.initializeHttpgd();
Expand All @@ -133,7 +133,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<apiImp


// register codelens and complmetion providers for r markdown
vscode.languages.registerCodeLensProvider('rmd', new rmarkdown.RMarkdownCodeLensProvider());
vscode.languages.registerCodeLensProvider(['r', 'rmd'], new rmarkdown.RMarkdownCodeLensProvider());
vscode.languages.registerCompletionItemProvider('rmd', new rmarkdown.RMarkdownCompletionItemProvider(), ' ', ',');


Expand All @@ -148,13 +148,13 @@ export async function activate(context: vscode.ExtensionContext): Promise<apiImp
vscode.tasks.registerTaskProvider(type, {
provideTasks() {
return [
new vscode.Task({type: type}, vscode.TaskScope.Workspace, 'Check', 'R',
new vscode.Task({ type: type }, vscode.TaskScope.Workspace, 'Check', 'R',
new vscode.ShellExecution('Rscript -e "devtools::check()"')),
new vscode.Task({type: type}, vscode.TaskScope.Workspace, 'Document', 'R',
new vscode.Task({ type: type }, vscode.TaskScope.Workspace, 'Document', 'R',
new vscode.ShellExecution('Rscript -e "devtools::document()"')),
new vscode.Task({type: type}, vscode.TaskScope.Workspace, 'Install', 'R',
new vscode.Task({ type: type }, vscode.TaskScope.Workspace, 'Install', 'R',
new vscode.ShellExecution('Rscript -e "devtools::install()"')),
new vscode.Task({type: type}, vscode.TaskScope.Workspace, 'Test', 'R',
new vscode.Task({ type: type }, vscode.TaskScope.Workspace, 'Test', 'R',
new vscode.ShellExecution('Rscript -e "devtools::test()"')),
];
},
Expand Down Expand Up @@ -195,10 +195,9 @@ export async function activate(context: vscode.ExtensionContext): Promise<apiImp
void vscode.commands.executeCommand('setContext', 'r.WorkspaceViewer:show', enableSessionWatcher);

// if session watcher is active, register dyamic completion provider
const liveTriggerCharacters = ['', '[', '(', ',', '$', '@', '"', '\'' ];
const liveTriggerCharacters = ['', '[', '(', ',', '$', '@', '"', '\''];
vscode.languages.registerCompletionItemProvider('r', new completions.LiveCompletionItemProvider(), ...liveTriggerCharacters);
}

return rExtension;
}

81 changes: 47 additions & 34 deletions src/rmarkdown.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,28 @@ import {
import { runChunksInTerm } from './rTerminal';
import { config } from './util';

function isChunkStartLine(text: string) {
if (text.match(/^\s*```+\s*\{\w+\s*.*$/g)) {
return true;
function isRDocument(document: TextDocument) {
return (document.languageId === 'r');
}

function isRChunkLine(text: string) {
return (!!text.match(/^#+\s*%%/g));
}

function isChunkStartLine(text: string, isRDoc: boolean) {
if (isRDoc) {
return (isRChunkLine(text));
} else {
return (!!text.match(/^\s*```+\s*\{\w+\s*.*$/g));
}
return false;
}

function isChunkEndLine(text: string) {
if (text.match(/^\s*```+\s*$/g)) {
return true;
function isChunkEndLine(text: string, isRDoc: boolean) {
if (isRDoc) {
return (isRChunkLine(text));
} else {
return (!!text.match(/^\s*```+\s*$/g));
}
return false;
}

function getChunkLanguage(text: string) {
Expand Down Expand Up @@ -55,14 +65,14 @@ export class RMarkdownCodeLensProvider implements CodeLensProvider {
const rmdCodeLensCommands: string[] = config().get('rmarkdown.codeLensCommands');

// Iterate through all code chunks for getting chunk information for both CodeLens and chunk background color (set by `editor.setDecorations`)
for (let i = 1 ; i <= chunks.length ; i++) {
for (let i = 1; i <= chunks.length; i++) {
const chunk = chunks.filter(e => e.id === i)[0];
const chunkRange = chunk.chunkRange;
const line = chunk.startLine;
chunkRanges.push(chunkRange);

// Enable/disable only CodeLens, without affecting chunk background color.
if (config().get<boolean>('rmarkdown.enableCodeLens') && chunk.language === 'r') {
if (config().get<boolean>('rmarkdown.enableCodeLens') && (chunk.language === 'r') || isRDocument(document)) {
if (token.isCancellationRequested) {
break;
}
Expand Down Expand Up @@ -141,9 +151,9 @@ export class RMarkdownCodeLensProvider implements CodeLensProvider {
// For user-specified options, both options and sort order are based on options specified in settings UI or settings.json.
return this.codeLenses.
filter(e => rmdCodeLensCommands.includes(e.command.command)).
sort(function(a, b) {
sort(function (a, b) {
const sorted = rmdCodeLensCommands.indexOf(a.command.command) -
rmdCodeLensCommands.indexOf(b.command.command);
rmdCodeLensCommands.indexOf(b.command.command);
return sorted;
});
}
Expand Down Expand Up @@ -176,18 +186,19 @@ function getChunks(document: TextDocument): RMarkdownChunk[] {
let chunkLanguage: string = undefined;
let chunkOptions: string = undefined;
let chunkEval: boolean = undefined;
const isRDoc = isRDocument(document);

while (line < lines.length) {
if (chunkStartLine === undefined) {
if (isChunkStartLine(lines[line])) {
if (isChunkStartLine(lines[line], isRDoc)) {
chunkId++;
chunkStartLine = line;
chunkLanguage = getChunkLanguage(lines[line]);
chunkOptions = getChunkOptions(lines[line]);
chunkEval = getChunkEval(chunkOptions);
}
} else {
if (isChunkEndLine(lines[line])) {
if (isChunkEndLine(lines[line], isRDoc)) {
chunkEndLine = line;

const chunkRange = new Range(
Expand All @@ -211,10 +222,10 @@ function getChunks(document: TextDocument): RMarkdownChunk[] {
});

chunkStartLine = undefined;
}
}
line++;
}
line++;
}
return chunks;
}

Expand All @@ -225,21 +236,23 @@ function getCurrentChunk(chunks: RMarkdownChunk[], line: number): RMarkdownChunk
// `- 1` to cover edge case when cursor is at 'chunk end line'
let chunkEndLineAbove = line - 1;

while (chunkStartLineAtOrAbove >= 0 && !isChunkStartLine(lines[chunkStartLineAtOrAbove])) {
const isRDoc = isRDocument(window.activeTextEditor.document);

while (chunkStartLineAtOrAbove >= 0 && !isChunkStartLine(lines[chunkStartLineAtOrAbove], isRDoc)) {
chunkStartLineAtOrAbove--;
}

while (chunkEndLineAbove >= 0 && !isChunkEndLine(lines[chunkEndLineAbove])) {
while (chunkEndLineAbove >= 0 && !isChunkEndLine(lines[chunkEndLineAbove], isRDoc)) {
chunkEndLineAbove--;
}

// Case: Cursor is within chunk
if (chunkEndLineAbove < chunkStartLineAtOrAbove) {
line = chunkStartLineAtOrAbove;
} else {
// Cases: Cursor is above the first chunk, at the first chunk or outside of chunk. Find the 'chunk start line' of the next chunk below the cursor.
// Cases: Cursor is above the first chunk, at the first chunk or outside of chunk. Find the 'chunk start line' of the next chunk below the cursor.
let chunkStartLineBelow = line + 1;
while (!isChunkStartLine(lines[chunkStartLineBelow])) {
while (!isChunkStartLine(lines[chunkStartLineBelow], isRDoc)) {
chunkStartLineBelow++;
}
line = chunkStartLineBelow;
Expand Down Expand Up @@ -287,32 +300,32 @@ function _getStartLine() {
}

export async function runCurrentChunk(chunks: RMarkdownChunk[] = _getChunks(),
line: number = _getStartLine()): Promise<void> {
line: number = _getStartLine()): Promise<void> {
const currentChunk = getCurrentChunk(chunks, line);
await runChunksInTerm([currentChunk.codeRange]);
}

export async function runPreviousChunk(chunks: RMarkdownChunk[] = _getChunks(),
line: number = _getStartLine()): Promise<void> {
line: number = _getStartLine()): Promise<void> {
const previousChunk = getPreviousChunk(chunks, line);
await runChunksInTerm([previousChunk.codeRange]);
}

export async function runNextChunk(chunks: RMarkdownChunk[] = _getChunks(),
line: number = _getStartLine()): Promise<void> {
line: number = _getStartLine()): Promise<void> {
const nextChunk = getNextChunk(chunks, line);
await runChunksInTerm([nextChunk.codeRange]);
}

export async function runAboveChunks(chunks: RMarkdownChunk[] = _getChunks(),
line: number = _getStartLine()): Promise<void> {
line: number = _getStartLine()): Promise<void> {
const previousChunk = getPreviousChunk(chunks, line);
const firstChunkId = 1;
const previousChunkId = previousChunk.id;

const codeRanges: Range[] = [];

for (let i = firstChunkId ; i <= previousChunkId ; i++) {
for (let i = firstChunkId; i <= previousChunkId; i++) {
const chunk = chunks.filter(e => e.id === i)[0];
if (chunk.eval) {
codeRanges.push(chunk.codeRange);
Expand All @@ -322,15 +335,15 @@ export async function runAboveChunks(chunks: RMarkdownChunk[] = _getChunks(),
}

export async function runBelowChunks(chunks: RMarkdownChunk[] = _getChunks(),
line: number = _getStartLine()): Promise<void> {
line: number = _getStartLine()): Promise<void> {

const nextChunk = getNextChunk(chunks, line);
const nextChunkId = nextChunk.id;
const lastChunkId = chunks.length;

const codeRanges: Range[] = [];

for (let i = nextChunkId ; i <= lastChunkId ; i++) {
for (let i = nextChunkId; i <= lastChunkId; i++) {
const chunk = chunks.filter(e => e.id === i)[0];
if (chunk.eval) {
codeRanges.push(chunk.codeRange);
Expand All @@ -340,14 +353,14 @@ export async function runBelowChunks(chunks: RMarkdownChunk[] = _getChunks(),
}

export async function runCurrentAndBelowChunks(chunks: RMarkdownChunk[] = _getChunks(),
line: number = _getStartLine()): Promise<void> {
line: number = _getStartLine()): Promise<void> {
const currentChunk = getCurrentChunk(chunks, line);
const currentChunkId = currentChunk.id;
const lastChunkId = chunks.length;

const codeRanges: Range[] = [];

for (let i = currentChunkId ; i <= lastChunkId ; i++) {
for (let i = currentChunkId; i <= lastChunkId; i++) {
const chunk = chunks.filter(e => e.id === i)[0];
codeRanges.push(chunk.codeRange);
}
Expand All @@ -361,7 +374,7 @@ export async function runAllChunks(chunks: RMarkdownChunk[] = _getChunks()): Pro

const codeRanges: Range[] = [];

for (let i = firstChunkId ; i <= lastChunkId ; i++) {
for (let i = firstChunkId; i <= lastChunkId; i++) {
const chunk = chunks.filter(e => e.id === i)[0];
if (chunk.eval) {
codeRanges.push(chunk.codeRange);
Expand All @@ -377,19 +390,19 @@ function goToChunk(chunk: RMarkdownChunk) {
}

export function goToPreviousChunk(chunks: RMarkdownChunk[] = _getChunks(),
line: number = _getStartLine()): void {
line: number = _getStartLine()): void {
const previousChunk = getPreviousChunk(chunks, line);
goToChunk(previousChunk);
}

export function goToNextChunk(chunks: RMarkdownChunk[] = _getChunks(),
line: number = _getStartLine()): void {
line: number = _getStartLine()): void {
const nextChunk = getNextChunk(chunks, line);
goToChunk(nextChunk);
}

export function selectCurrentChunk(chunks: RMarkdownChunk[] = _getChunks(),
line: number = _getStartLine()): void {
line: number = _getStartLine()): void {
const editor = window.activeTextEditor;
const currentChunk = getCurrentChunk__CursorWithinChunk(chunks, line);
const lines = editor.document.getText().split(/\r?\n/);
Expand Down Expand Up @@ -426,7 +439,7 @@ export class RMarkdownCompletionItemProvider implements CompletionItemProvider {

public provideCompletionItems(document: TextDocument, position: Position): CompletionItem[] {
const line = document.lineAt(position).text;
if (isChunkStartLine(line) && getChunkLanguage(line) === 'r') {
if (isChunkStartLine(line, false) && getChunkLanguage(line) === 'r') {
return this.chunkOptionCompletionItems;
}

Expand Down