Create NPM Module

[0x4007]

Plugin developers need to import the configuration to modify the output of their plugins. We should make this as simple as possible with an NPM module. This module should abstract away the following:

1. fetching the repository configuration
2. fetching the organization configuration
3. merging to a single configuration
4. config validation

Pseudo code (I didn't deeply think through this):

import { getConfig } from "@ubiquibot/configuration";
const config = await getConfig(context);

I meant that the configuration could be it's own repository that we distribute as an npm package. This way any project that needs the configuration can just add something like "@ubiquibot/configuration" in the npm packages of the project, this way you get access to the configuration easily, with the parsing / generation methods as well.

Original post: ubiquity/pay.ubq.fi#135 (comment)

That's a great idea. I do envision a developer SDK for our plugins which absolutely should make configuration imports simple (as they seem to need to be handled by the plugin itself.)

[gentlementlegen]

@pavlovcik would like to work on it, but shouldn't you merge back your Ubiquibot fork?

[0x4007]

I have a few things on my plate now so you may be better off just working on my fork lol

[gentlementlegen]

/start

[ubiquibot]

Deadline	Sun, Feb 18, 5:02 AM UTC
Registered Wallet	0x0fC1b909ba9265A846b82CF4CE352fc3e7EeB2ED

Tips:

• Use /wallet 0x0000...0000 if you want to update your registered payment wallet address.
• Be sure to open a draft pull request as soon as possible to communicate updates on your progress.
• Be sure to provide timely updates to us when requested, or you will be automatically unassigned from the task.

[0x4007]

@FernandVEYRIER please refer to the kernel code when designing this.

For context: the kernel is still in a very young development stage. Just to get started we are including some simple GitHub webhook event handlers inside of the kernel. However the plan is to move all of these event handlers into seperate plugins (loaded in from separate codebases)

https://github.com/ubiquity/ubiquibot-kernel/blob/development/src/github/handlers/issue-comment/created.ts

And here is how it is currently mounted:

https://github.com/ubiquity/ubiquibot-kernel/blob/development/src/github/handlers/index.ts

---

I was doing some research around this earlier in the week, and when I loaded the configuration, I would need to do that right after the plugin module's entry (like within the first line of code inside of the function body i.e. here.)

There is a lot of noise in my example because I would not have pushed it under normal circumstances but I wanted to share my insights.

https://github.com/ubiquity/ubiquibot-kernel/blob/f0be88d83d04d50918ca4acfa38814227ffdb73a/src/github/handlers/issue-comment/created.ts#L9

[gentlementlegen]

@pavlovcik Okay thanks for the info. Shouldn't I just focus for now on separating the configuration from the code to make it a standalone easy to integrate in any other project?

[0x4007]

Yes I just wanted to provide context so you know how it is likely to be implemented.

[0x4007]

Now you probably have a better idea of why I want to make a local office. Fast iteration across multiple interconnected systems may be easier in the same room with a whiteboard occasionally.

[gentlementlegen]

I noticed that you have already a repository for NPM packages, currently used for the Ubiquibot logs
https://github.com/ubiquity/ubiquibot-logger
We can use the same process for the configuration.

I think what is needed would be a file representing all the services and the communication with each module of the whole project

[0x4007]

I think what is needed would be a file representing all the services and the communication with each module of the whole project

It's a good idea although I fear that depending on the level of detail it can become deprecated quite fast. I'll see if I can get some help from ChatGPT.

[ubiquibot]

+ Evaluating results. Please wait...

[0x4007]

+ Evaluating results. Please wait...

Looks like the private key is wrong on this org. We need to fix this from the code to take the private key from the runtime secrets (netlify) but let me try and make a quick fix here.

[ubiquibot]

+ Evaluating results. Please wait...

[ubiquibot]

[ 98 WXDAI ]

@pavlovcik

Contributions Overview

View	Contribution	Count	Reward
Issue	Specification	1	21
Issue	Comment	6	67.4
Review	Comment	2	9.6

Conversation Incentives

Comment	Formatting	Relevance	Reward
Plugin developers need to import the configuration to modify the...	21 li: count: 4 score: "4" words: 15 code: count: 1 score: "1" words: 0	1	21
I have a few things on my plate now so you may be better off jus...	4.2	0.33	4.2
@FernandVEYRIER please refer to the kernel code when designing t...	38.2 a: count: 1 score: "1" words: 1 hr: count: 1 score: "1" words: 0	0.68	38.2
Yes I just wanted to provide context so you know how it is likel...	3.4	0.535	3.4
Now you probably have a better idea of why I want to make a loca...	6.6	0.53	6.6
> I think what is needed would be a file representing all the se...	6.4	0.3	6.4
> ```diff > + Evaluating results. Please wait... > ``` Look...	8.6 code: count: 1 score: "1" words: 0	0.25	8.6
> A key should be needed to publish the package to NPM. I don...	3.6	0.35	3.6
Hey writing a test case would be appreciated to show that it wor...	6	0.59	6

[ 212.9 WXDAI ]

@FernandVEYRIER

Contributions Overview

View	Contribution	Count	Reward
Issue	Task	1.00	200
Issue	Comment	3	0
Review	Comment	2	12.9

Conversation Incentives

Comment	Formatting	Relevance	Reward
@pavlovcik would like to work on it, but shouldn't you merge bac...	-	0.43	-
@pavlovcik Okay thanks for the info. Shouldn't I just focus for ...	-	0.65	-
I noticed that you have already a repository for NPM packages, c...	-	0.48	-
A key should be needed to publish the package to NPM. The way...	7.9 code: count: 1 score: "1" words: 1	0.6	7.9
@pavlovcik Renamed all to use `@ubiquibot` scoped name. I will n...	5 code: count: 2 score: "2" words: 2	0.72	5