@a5gard/bifrost-plugin 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -7
- package/dist/index.js +7 -9
- package/dist/registry.bifrost +8 -0
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# bifrost-plugin
|
|
1
|
+
# @a5gard/bifrost-plugin
|
|
2
2
|
|
|
3
3
|
Plugin installer / wizard for bifrost projects.
|
|
4
4
|
|
|
@@ -9,7 +9,7 @@ Plugin installer / wizard for bifrost projects.
|
|
|
9
9
|
Once your project has completed its installation process, you may now cd into the newly created directory and run:
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
bunx bifrost-plugin
|
|
12
|
+
bunx @a5gard/bifrost-plugin
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
Entering interactive mode it will display the following options:
|
|
@@ -22,17 +22,17 @@ Entering interactive mode it will display the following options:
|
|
|
22
22
|
Running the following command will start plugin installation process:
|
|
23
23
|
|
|
24
24
|
```bash
|
|
25
|
-
bunx bifrost-plugin list
|
|
25
|
+
bunx @a5gard/bifrost-plugin list
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
The installer will then obtain the list of available plugins to choose from the bifrost-plugin repo (owner `8an3`) from the file labeled `registry.bifrost`
|
|
28
|
+
The installer will then obtain the list of available plugins to choose from the @a5gard/bifrost-plugin repo (owner `8an3`) from the file labeled `registry.bifrost`
|
|
29
29
|
|
|
30
30
|
### Direct Installation
|
|
31
31
|
|
|
32
32
|
or you may use the supplied method
|
|
33
33
|
|
|
34
34
|
```bash
|
|
35
|
-
bunx bifrost-plugin otp-auth-plugin
|
|
35
|
+
bunx @a5gard/bifrost-plugin otp-auth-plugin
|
|
36
36
|
```
|
|
37
37
|
|
|
38
38
|
Which will immediatly start the installation process, after scanning your projects config.bifrost to see if the platforms match for compatibility to ensure you are installing the correct plugin.
|
|
@@ -43,7 +43,7 @@ Which will immediatly start the installation process, after scanning your projec
|
|
|
43
43
|
Running the following command will start the create plugin wizard:
|
|
44
44
|
|
|
45
45
|
```bash
|
|
46
|
-
bunx bifrost-plugin create
|
|
46
|
+
bunx @a5gard/bifrost-plugin create
|
|
47
47
|
```
|
|
48
48
|
|
|
49
49
|
Where it will then inquirer:
|
|
@@ -129,7 +129,7 @@ When installing a plugin it will prompt the user to either confirm the default s
|
|
|
129
129
|
Running the following command will start the submission process without the need of interactive mode:
|
|
130
130
|
|
|
131
131
|
```bash
|
|
132
|
-
bunx bifrost-plugin submit
|
|
132
|
+
bunx @a5gard/bifrost-plugin submit
|
|
133
133
|
```
|
|
134
134
|
|
|
135
135
|
Selecting this option will automate the submission process for you, adding your plugin to the libraries registry. Allowing you to share you plugin with others that will also be posted on the site to allow users to find it more easily.
|
package/dist/index.js
CHANGED
|
@@ -460,7 +460,7 @@ build/
|
|
|
460
460
|
console.log(chalk3.cyan("Next steps:"));
|
|
461
461
|
console.log(chalk3.gray(` 1. Add your plugin files to ${answers.name}/files/`));
|
|
462
462
|
console.log(chalk3.gray(` 2. Update plugin.bifrost with file mappings`));
|
|
463
|
-
console.log(chalk3.gray(" 3. Submit to registry: https
|
|
463
|
+
console.log(chalk3.gray(" 3. Submit to registry: https://@a5gard/bifrost-plugins.dev/submit"));
|
|
464
464
|
console.log();
|
|
465
465
|
}
|
|
466
466
|
function generateReadme(config, username) {
|
|
@@ -471,7 +471,7 @@ ${config.description}
|
|
|
471
471
|
## Installation
|
|
472
472
|
|
|
473
473
|
\`\`\`bash
|
|
474
|
-
bunx bifrost-plugin ${config.name}
|
|
474
|
+
bunx @a5gard/bifrost-plugin ${config.name}
|
|
475
475
|
\`\`\`
|
|
476
476
|
|
|
477
477
|
## Platform
|
|
@@ -509,9 +509,7 @@ Add your plugin files to the \`files/\` directory and update \`plugin.bifrost\`
|
|
|
509
509
|
|
|
510
510
|
## Submit to Registry
|
|
511
511
|
|
|
512
|
-
Once your plugin is ready, submit it to the Bifrost Plugin Registry
|
|
513
|
-
|
|
514
|
-
\u{1F517} [Submit Plugin](https://bifrost-plugins.dev/submit)
|
|
512
|
+
Once your plugin is ready, submit it to the Bifrost Plugin Registry either on the site via the submit button or cli \`bunx @a5gard/bifrost-plugin submit\`
|
|
515
513
|
|
|
516
514
|
## Development
|
|
517
515
|
|
|
@@ -527,9 +525,9 @@ MIT \xA9 ${username}
|
|
|
527
525
|
|
|
528
526
|
## Links
|
|
529
527
|
|
|
530
|
-
- [Bifrost Plugin Registry](https://
|
|
531
|
-
- [Plugin Documentation](https://
|
|
532
|
-
- [Submit a Plugin](https://
|
|
528
|
+
- [Bifrost Plugin Registry](https://github.com/A5GARD/BIFROST-PLUGIN)
|
|
529
|
+
- [Plugin Documentation](https://github.com/A5GARD/BIFROST-PLUGIN)
|
|
530
|
+
- [Submit a Plugin](https://github.com/A5GARD/BIFROST-PLUGIN)
|
|
533
531
|
`;
|
|
534
532
|
}
|
|
535
533
|
|
|
@@ -539,7 +537,7 @@ import path5 from "path";
|
|
|
539
537
|
import chalk4 from "chalk";
|
|
540
538
|
import prompts4 from "prompts";
|
|
541
539
|
import { execSync as execSync3 } from "child_process";
|
|
542
|
-
var REGISTRY_REPO = "
|
|
540
|
+
var REGISTRY_REPO = "A5GARD/BIFROST-PLUGIN";
|
|
543
541
|
var REGISTRY_FILE = "dist/registry.bifrost";
|
|
544
542
|
async function submitPlugin() {
|
|
545
543
|
console.log(chalk4.blue.bold("\n\u{1F4E4} Submit Plugin to Registry\n"));
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@a5gard/bifrost-plugin",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "Plugin installer / wizard for bifrost projects",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
7
|
-
|
|
7
|
+
"bifrost-plugin": "dist/index.js"
|
|
8
8
|
},
|
|
9
9
|
"scripts": {
|
|
10
10
|
"build": "tsup src/index.ts --format esm --dts --clean",
|
|
@@ -14,11 +14,11 @@
|
|
|
14
14
|
"files": [
|
|
15
15
|
"dist"
|
|
16
16
|
],
|
|
17
|
-
"keywords": [
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
],
|
|
17
|
+
"keywords": [
|
|
18
|
+
"bifrost",
|
|
19
|
+
"plugin",
|
|
20
|
+
"cli"
|
|
21
|
+
],
|
|
22
22
|
"publishConfig": {
|
|
23
23
|
"access": "public"
|
|
24
24
|
},
|