Skip to content

Commit

Permalink
Merge pull request #793 from 06kellyjac/remove_exports
Browse files Browse the repository at this point in the history
  • Loading branch information
JamieSlome authored Nov 14, 2024
2 parents dd5d692 + c5d200d commit 122ceb9
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 21 deletions.
5 changes: 0 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,6 @@
"git-proxy": "./index.js",
"git-proxy-all": "concurrently 'npm run server' 'npm run client'"
},
"exports": {
"./plugin": "./src/plugin.js",
"./proxy/actions": "./src/proxy/actions/index.js",
"./src/config/env": "./src/config/env.js"
},
"workspaces": [
"./packages/git-proxy-cli"
],
Expand Down
6 changes: 3 additions & 3 deletions plugins/git-proxy-plugin-samples/example.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
*/

// Peer dependencies; its expected that these deps exist on Node module path if you've installed @finos/git-proxy
const { PushActionPlugin } = require('@finos/git-proxy/plugin');
const { Step } = require('@finos/git-proxy/proxy/actions');
const { PushActionPlugin } = require('@finos/git-proxy/src/plugin');
const { Step } = require('@finos/git-proxy/src/proxy/actions');
'use strict';

/**
Expand Down Expand Up @@ -42,4 +42,4 @@ module.exports = {
// Sub-classing is fine too if you require more control over the plugin
logRequest: new LogRequestPlugin(),
someOtherValue: 'foo', // This key will be ignored by the plugin loader
};
};
4 changes: 2 additions & 2 deletions plugins/git-proxy-plugin-samples/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
*/

// Peer dependencies; its expected that these deps exist on Node module path if you've installed @finos/git-proxy
import { PullActionPlugin } from "@finos/git-proxy/plugin";
import { Step } from "@finos/git-proxy/proxy/actions";
import { PullActionPlugin } from "@finos/git-proxy/src/plugin";
import { Step } from "@finos/git-proxy/src/proxy/actions";

class RunOnPullPlugin extends PullActionPlugin {
constructor() {
Expand Down
2 changes: 1 addition & 1 deletion test/fixtures/test-package/default-export.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const { PushActionPlugin } = require('@osp0/finos-git-proxy/plugin');
const { PushActionPlugin } = require('@finos/git-proxy/src/plugin');

// test default export
module.exports = new PushActionPlugin(async (req, action) => {
Expand Down
4 changes: 2 additions & 2 deletions test/fixtures/test-package/multiple-export.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const { PushActionPlugin, PullActionPlugin } = require('@osp0/finos-git-proxy/plugin');
const { PushActionPlugin, PullActionPlugin } = require('@finos/git-proxy/src/plugin');


module.exports = {
Expand All @@ -10,4 +10,4 @@ module.exports = {
console.log('PullActionPlugin: ', action);
return action;
}),
}
}
2 changes: 1 addition & 1 deletion test/fixtures/test-package/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"name": "test-package",
"version": "0.0.0",
"dependencies": {
"@osp0/finos-git-proxy": "file:../../.."
"@finos/git-proxy": "file:../../.."
}
}
2 changes: 1 addition & 1 deletion test/fixtures/test-package/subclass.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const { PushActionPlugin } = require('@osp0/finos-git-proxy/plugin');
const { PushActionPlugin } = require('@finos/git-proxy/src/plugin');

class DummyPlugin extends PushActionPlugin {
constructor(exec) {
Expand Down
12 changes: 6 additions & 6 deletions website/docs/development/plugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -124,9 +124,9 @@ Loaded plugin: FooPlugin

To develop a new plugin, you must add `@finos/git-proxy` as a [peer dependency](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#peerdependencies). The main app (also known as the "host application") exports the following extension points:

- `@finos/git-proxy/plugin/PushActionPlugin`: execute as an action in the proxy chain during a `git push`
- `@finos/git-proxy/plugin/PullActionPlugin`: execute as an action in the proxy chain during a `git fetch`
- `@finos/git-proxy/proxy/actions/Step` and `@finos/git-proxy/proxy/actions/Action`: internal classes which act as carriers for `git` state during proxying. Plugins should modify the passed in `action` for affecting any global state of the git operation and add its own custom `Step` object to capture the plugin's own internal state (logs, errored/blocked status, etc.)
- `@finos/git-proxy/src/plugin/PushActionPlugin`: execute as an action in the proxy chain during a `git push`
- `@finos/git-proxy/src/plugin/PullActionPlugin`: execute as an action in the proxy chain during a `git fetch`
- `@finos/git-proxy/src/proxy/actions/Step` and `@finos/git-proxy/src/proxy/actions/Action`: internal classes which act as carriers for `git` state during proxying. Plugins should modify the passed in `action` for affecting any global state of the git operation and add its own custom `Step` object to capture the plugin's own internal state (logs, errored/blocked status, etc.)

GitProxy will load your plugin only if it extends one of the two plugin classes above. It is also important that your package has [`exports`](https://nodejs.org/api/packages.html#exports) defined for the plugin loader to properly load your module(s).

Expand All @@ -135,7 +135,7 @@ Please see the [sample plugin package included in the repo](https://github.com/f
If your plugin relies on custom state, it is recommended to create subclasses in the following manner:

```javascript
import { PushActionPlugin } from "@finos/git-proxy/plugin";
import { PushActionPlugin } from "@finos/git-proxy/src/plugin";

class FooPlugin extends PushActionPlugin {
constructor() {
Expand Down Expand Up @@ -189,8 +189,8 @@ $ npm install --save-peer @finos/git-proxy@latest

`bar.js`
```javascript
import { PushActionPlugin } from "@finos/git-proxy/plugin";
import { Step } from "@finos/git-proxy/proxy/actions";
import { PushActionPlugin } from "@finos/git-proxy/src/plugin";
import { Step } from "@finos/git-proxy/src/proxy/actions";

//Note: Only use a default export if you do not rely on any state. Otherwise, create a sub-class of [Push/Pull]ActionPlugin
export default new PushActionPlugin(function(req, action) {
Expand Down

0 comments on commit 122ceb9

Please sign in to comment.