initial commit

atsyplenkov · atsyplenkov · commit d08625f2d5fd · 2024-12-16T15:54:07.000+13:00
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,25 @@
+{
+	"env": {
+		"browser": false,
+		"commonjs": true,
+		"es6": true,
+		"node": true,
+		"mocha": true
+	},
+	"parserOptions": {
+		"ecmaVersion": 2018,
+		"ecmaFeatures": {
+			"jsx": true
+		},
+		"sourceType": "module"
+	},
+	"rules": {
+		"no-const-assign": "warn",
+		"no-this-before-super": "warn",
+		"no-undef": "warn",
+		"no-unreachable": "warn",
+		"no-unused-vars": "warn",
+		"constructor-super": "warn",
+		"valid-typeof": "warn"
+	}
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+node_modules
+.vscode-test/
+*.vsix
diff --git a/.vscode-test.mjs b/.vscode-test.mjs
@@ -0,0 +1,5 @@
+import { defineConfig } from '@vscode/test-cli';
+
+export default defineConfig({
+	files: 'test/**/*.test.js',
+});
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,8 @@
+{
+	// See https://go.microsoft.com/fwlink/?LinkId=733558
+	// for the documentation about the extensions.json format
+	"recommendations": [
+		"dbaeumer.vscode-eslint",
+		"ms-vscode.extension-test-runner"
+	]
+}
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,17 @@
+// A launch configuration that launches the extension inside a new window
+// Use IntelliSense to learn about possible attributes.
+// Hover to view descriptions of existing attributes.
+// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"name": "Run Extension",
+			"type": "extensionHost",
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}"
+			]
+		}
+	]
+}
diff --git a/.vscodeignore b/.vscodeignore
@@ -0,0 +1,11 @@
+.vscode/**
+.vscode-test/**
+test/**
+.gitignore
+.yarnrc
+vsc-extension-quickstart.md
+**/jsconfig.json
+**/*.map
+**/.eslintrc.json
+**/.vscode-test.*
+*.vsix
diff --git a/.yarnclean b/.yarnclean
@@ -0,0 +1,45 @@
+# test directories
+__tests__
+test
+tests
+powered-test
+
+# asset directories
+docs
+doc
+website
+images
+assets
+
+# examples
+example
+examples
+
+# code coverage directories
+coverage
+.nyc_output
+
+# build scripts
+Makefile
+Gulpfile.js
+Gruntfile.js
+
+# configs
+appveyor.yml
+circle.yml
+codeship-services.yml
+codeship-steps.yml
+wercker.yml
+.tern-project
+.gitattributes
+.editorconfig
+.*ignore
+.eslintrc
+.jshintrc
+.flowconfig
+.documentup.json
+.yarn-metadata.json
+.travis.yml
+
+# misc
+*.md
diff --git a/.yarnrc b/.yarnrc
@@ -0,0 +1 @@
+--ignore-engines true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,9 @@
+# Change Log
+
+All notable changes to the "formalist" extension will be documented in this file.
+
+Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+
+## [Unreleased]
+
+- Initial release
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2024 formalist authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,32 @@
+<!-- badges: start -->
+[![Website](https://img.shields.io/website?url=https%3A%2F%2Fformalist.anatolii.nz)](https://formalist.anatolii.nz/) [![Open VSX Downloads](https://img.shields.io/open-vsx/dt/atsyplenkov/formalist?label=Open%20VSX%20downloads&color=c160ef)](https://open-vsx.org/extension/atsyplenkov/formalist) [![Deploy Extension](https://github.com/atsyplenkov/formalist/actions/workflows/publish-extensions.yml/badge.svg)](https://github.com/atsyplenkov/formalist/actions/workflows/publish-extensions.yml) ![GitHub License](https://img.shields.io/github/license/atsyplenkov/formalist?color=blue) [![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://img.shields.io/badge/repo_status-WIP-yellow)](https://www.repostatus.org/#wip)
+<!-- badges: end -->
+
+# Formalist — Positron Extension
+
+This is an extension to help add explicit R function calls instead of implicit ones using the [`{pedant}`](https://github.com/wurli/pedant) R package. In other words, it checks the currently attached packages, i.e., the ones already loaded using `library()`, and transforms R function calls like `select(mtcars, mpg, cyl)` to `dplyr::select(mtcars, mpg, cyl)`.
+
+> ⚠ The extension is designed to work ONLY in
+> [Positron](https://github.com/posit-dev/positron) IDE starting from version 2025.01.0, as it heavily depends
+> on the Positron API.
+
+![](https://github.com/atsyplenkov/formalist/raw/master/assets/formalist_demo.gif)
+
+# Installation
+
+The extension is published on the [Open VSX Registry](https://open-vsx.org/extension/atsyplenkov/formalist): just click `Install` there or manually install it with:
+
+1) Start the [Positron](https://github.com/posit-dev/positron).
+
+2) Inside Positron, go to the extensions view either by executing the `View: Show Extensions` command (click View -> Command Palette...) or by clicking on the extension icon on the left side of the Positron window.
+
+3) In the extensions view, simply search for the term `formalist` in the marketplace search box, then select the extension named `Formalist` and click the install button.
+
+Alternatively, you can install the latest version from the [Releases](https://github.com/atsyplenkov/formalist/releases/) page. Download the latest `.vsix` file and install it as described [here](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix).
+
+
+# Contributions
+
+Contributions are welcome! If you'd like to contribute, please, fork, submit a
+PR and I'll merge it.
+
diff --git a/assets/formalist_demo.gif b/assets/formalist_demo.gif
diff --git a/extension.js b/extension.js
@@ -0,0 +1,20 @@
+const vscode = require('vscode');
+const positron = require('positron');
+const { makeRFunctionCallExplicit } = require('./src/makeExplicit');
+
+function activate(context) {
+    console.log(positron);
+
+    context.subscriptions.push(
+        vscode.commands.registerCommand(
+            'formalist.makeRFunctionCallExplicit', makeRFunctionCallExplicit
+        )
+    );
+}
+
+function deactivate() { }
+
+module.exports = {
+    activate,
+    deactivate
+}; 
diff --git a/jsconfig.json b/jsconfig.json
@@ -0,0 +1,13 @@
+{
+	"compilerOptions": {
+		"module": "Node16",
+		"target": "ES2022",
+		"checkJs": false,  /* Typecheck .js files. */
+		"lib": [
+			"ES2022"
+		]
+	},
+	"exclude": [
+		"node_modules"
+	]
+}
diff --git a/package.json b/package.json
@@ -0,0 +1,72 @@
+{
+  "name": "formalist",
+  "displayName": "formalist",
+  "description": "Make R function calls excplicit",
+  "version": "0.1.0",
+  "publisher": "atsyplenkov",
+  "license": "MIT",
+  "pricing": "Free",
+  "sponsor": {
+    "url": "https://github.com/sponsors/atsyplenkov"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/atsyplenkov/formalist"
+  },
+  "bugs": {
+    "url": "https://github.com/atsyplenkov/formalist/issues",
+    "email": "atsyplenkov@fastmail.com"
+  },
+  "engines": {
+    "positron": ">=2025.01.0",
+    "vscode": "^1.93.0"
+  },
+  "categories": [
+    "Other"
+  ],
+  "activationEvents": [],
+  "main": "./extension.js",
+  "contributes": {
+    "commands": [
+      {
+        "command": "formalist.makeRFunctionCallExplicit",
+        "title": "Make R Function Call Explicit",
+        "category": "Formalist"
+      }
+    ],
+    "menus": {
+      "editor/context": [
+        {
+          "when": "editorHasSelection && config.formalist.showContextMenu && editorLangId == 'r'",
+          "command": "formalist.makeRFunctionCallExplicit",
+          "group": "navigation@1"
+        }
+      ]
+    },
+    "configuration": {
+      "type": "object",
+      "title": "Formalist Configuration",
+      "properties": {
+        "formalist.showContextMenu": {
+          "type": "boolean",
+          "default": true,
+          "description": "Show the 'Make R Function Call Explicit' command in the editor context menu."
+        }
+      }
+    }
+  },
+  "scripts": {
+    "lint": "eslint .",
+    "pretest": "yarn run lint",
+    "test": "vscode-test"
+  },
+  "devDependencies": {
+    "@types/vscode": "^1.93.0",
+    "@types/mocha": "^10.0.7",
+    "@types/node": "20.x",
+    "eslint": "^8.57.0",
+    "typescript": "^5.4.5",
+    "@vscode/test-cli": "^0.0.9",
+    "@vscode/test-electron": "^2.4.0"
+  }
+}
diff --git a/src/checkR.js b/src/checkR.js
@@ -0,0 +1,78 @@
+const positron = require('positron');
+const os = require('os');
+const fs = require('fs/promises');
+const path = require('path');
+const { randomUUID } = require('crypto');
+
+async function checkR() {
+    // Create a temporary file path
+    const id = randomUUID();
+    const tempFilePath = path.join(os.tmpdir(), `pedant_${id}.txt`);
+    const normalizedPath = tempFilePath.replace(/\\/g, "/");
+
+    // Prepare the R commands
+    const r_check_command = `writeLines(as.character(c(nchar(system.file(package = "pedant")) != 0, nchar(system.file(package = "remotes")) != 0, nchar(system.file(package = "pak")) != 0)), con = '${normalizedPath}')`;
+    const pak_install_command = 'pak::pak("wurli/pedant")';
+    const remotes_install_command = 'remotes::install_github("wurli/pedant")';
+    const install_pak_package = 'install.packages("pak")';
+
+    // Run R commands
+    await positron.runtime.executeCode(
+        'r', r_check_command, false, false,
+        positron.RuntimeCodeExecutionMode.Silent
+    );
+    // Write results to a tempfile
+    console.log(`Wrote results to ${tempFilePath}`);
+
+    // Wait and read the output
+    await new Promise(resolve => setTimeout(resolve, 100));
+
+    // Read the output from the temporary file
+    const output = await fs.readFile(tempFilePath, { encoding: 'utf8' });
+    const pedant = output.split('\n')[0];
+    const remotes = output.split('\n')[1];
+    const pak = output.split('\n')[2];
+    console.log('Pedant is installed? -- ' + pedant);
+
+    if (pedant.includes('FALSE')) {
+        // Offer to install pedant
+        const install_pedant = await positron.window.showSimpleModalDialogPrompt(
+            'Formalist extension is missing {pedant} R package',
+            '{pedant} R package is required. Do you want to install {pedant}?',
+            'Yes',
+            'No'
+        );
+
+        if (install_pedant && pak.includes('TRUE')) {
+            await positron.runtime.executeCode(
+                'r', pak_install_command, false, false
+            );
+        } else if (install_pedant && remotes.includes('TRUE')) {
+            await positron.runtime.executeCode(
+                'r', remotes_install_command, false, false
+            );
+        }
+    } else if (pedant.includes('FALSE') && remotes.includes('FALSE') && pak.includes('FALSE')) {
+        // Offer to install pedant
+        const install_pak = await positron.window.showSimpleModalDialogPrompt(
+            'Formalist extension is missing {pedant} R package',
+            '{pedant} R package is required. However, it cannot be installed as {pak} or {remotes} packages are missing too. Do you want to install {pak} and {pedant}?',
+            'Yes',
+            'No'
+        );
+
+        if (install_pak) {
+            await positron.runtime.executeCode(
+                'r', install_pak_package, false, false
+            );
+            await positron.runtime.executeCode(
+                'r', pak_install_command, false, false
+            );
+        }
+    }
+
+    // Delete the temporary file
+    await fs.unlink(tempFilePath);
+}
+
+module.exports = { checkR }; 
diff --git a/src/makeExplicit.js b/src/makeExplicit.js
diff --git a/test/extension.test.js b/test/extension.test.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+node_modules`
	`2`	`+.vscode-test/`
	`3`	`+*.vsix`