Support for cargo.toml files (OctoLinker#858)

xt0rted · web-flow · commit 75ab0454bb4f · 2020-03-25T23:07:02.000+01:00
* Initial support for cargo.toml files

* Adjust plugin name to match the others

* Set needsContext to true

* Simplify regex creation

* Simplify toml parsing

* Sort imports

* Add some e2e tests

* Remove unused parameter

* Add githubClasses with an empty array
diff --git a/e2e/fixtures/rust/Cargo.toml b/e2e/fixtures/rust/Cargo.toml
@@ -0,0 +1,22 @@
+[package]
+name = "Octolinker"
+version = "1.0.0"
+
+[dependencies]
+# @OctoLinkerResolve(https://github.com/actix/actix-net)
+actix-rt = "1.0.0"
+
+# @OctoLinkerResolve(https://github.com/actix/actix-web)
+actix-web = "2.0.0"
+
+# @OctoLinkerResolve(https://github.com/actix/actix-web)
+actix-files = "0.2.1"
+
+# @OctoLinkerResolve(https://github.com/rust-lang/futures-rs)
+futures = "0.3.1"
+
+# @OctoLinkerResolve(https://github.com/sebasmagri/env_logger)
+env_logger = "0.5"
+
+# @OctoLinkerResolve(https://github.com/tokio-rs/bytes)
+bytes = "0.5"
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/core/load-plugins.js b/packages/core/load-plugins.js
@@ -20,6 +20,7 @@ export { default as Python } from '@octolinker/plugin-python';
 export { default as RequirementsTxt } from '@octolinker/plugin-requirements-txt';
 export { default as Ruby } from '@octolinker/plugin-ruby';
 export { default as Rust } from '@octolinker/plugin-rust';
+export { default as RustCargo } from '@octolinker/plugin-rust-cargo';
 export { default as Sass } from '@octolinker/plugin-sass';
 export { default as TypeScript } from '@octolinker/plugin-typescript';
 export { default as Vim } from '@octolinker/plugin-vim';
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -37,6 +37,7 @@
     "@octolinker/plugin-requirements-txt": "1.0.0",
     "@octolinker/plugin-ruby": "1.0.0",
     "@octolinker/plugin-rust": "1.0.0",
+    "@octolinker/plugin-rust-cargo": "1.0.0",
     "@octolinker/plugin-sass": "1.0.0",
     "@octolinker/plugin-typescript": "1.0.0",
     "@octolinker/plugin-vim": "1.0.0",
diff --git a/packages/helper-regex-builder/index.js b/packages/helper-regex-builder/index.js
@@ -22,3 +22,10 @@ export function jsonRegExKeyValue(key, value, global = true) {
 export function jsonRegExValue(key, value, global = true) {
   return regexBuilder(key, value, false, global);
 }
+
+export function tomlRegExKeyValue(key, value) {
+  const regexKey = escapeRegexString(key);
+  const regexValue = escapeRegexString(value);
+
+  return new RegExp(`(${regexKey})\\s*=\\s*"(${regexValue})"`, 'g');
+}
diff --git a/packages/plugin-rust-cargo/index.js b/packages/plugin-rust-cargo/index.js
@@ -0,0 +1,42 @@
+import * as TOML from '@iarna/toml';
+import insertLink from '@octolinker/helper-insert-link';
+import { tomlRegExKeyValue } from '@octolinker/helper-regex-builder';
+import liveResolverQuery from '@octolinker/resolver-live-query';
+
+function linkDependency(blob, key, value) {
+  const regex = tomlRegExKeyValue(key, value);
+  return insertLink(blob, regex, this);
+}
+
+function processTOML(blob, plugin) {
+  let results = [];
+  const json = TOML.parse(blob.toString());
+
+  Object.entries(json.dependencies).forEach(([name, version]) => {
+    const linked = linkDependency.call(plugin, blob, name, version);
+
+    results = results.concat(linked);
+  });
+
+  return results;
+}
+
+export default {
+  name: 'RustCargo',
+  needsContext: true,
+
+  resolve(path, values) {
+    return liveResolverQuery({ type: 'crates', target: values[0] });
+  },
+
+  getPattern() {
+    return {
+      pathRegexes: [/cargo\.toml/i],
+      githubClasses: [],
+    };
+  },
+
+  parseBlob(blob) {
+    return processTOML(blob, this);
+  },
+};
diff --git a/packages/plugin-rust-cargo/package.json b/packages/plugin-rust-cargo/package.json
@@ -0,0 +1,15 @@
+{
+  "name": "@octolinker/plugin-rust-cargo",
+  "version": "1.0.0",
+  "description": "",
+  "repository": "https://github.com/octolinker/octolinker/tree/master/packages/plugin-rust",
+  "license": "MIT",
+  "main": "./index.js",
+  "dependencies": {
+    "@iarna/toml": "^2.2.3",
+    "@octolinker/helper-grammar-regex-collection": "1.0.0",
+    "@octolinker/helper-insert-link": "1.0.0",
+    "@octolinker/helper-regex-builder": "1.0.0",
+    "@octolinker/resolver-live-query": "1.0.0"
+  }
+}
