beast-core-create 0.1.2 → 0.2.0
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/dist/main.js +12379 -0
- package/dist/main.js.map +1 -0
- package/dist/manifests/tpls.manifest.0.0.0.json +145 -0
- package/package.json +19 -21
- package/LICENSE.txt +0 -11
- package/README.md +0 -93
- package/dist/bin.js +0 -21
- package/dist/index.js +0 -3
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
{
|
|
2
|
+
"remotePathPrefix": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/",
|
|
3
|
+
"templates": [
|
|
4
|
+
{
|
|
5
|
+
"key": "devcontainer",
|
|
6
|
+
"sourcePath": "./templates/.devcontainer",
|
|
7
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_devcontainer.0.0.0.tar.gz",
|
|
8
|
+
"targetPath": "./.devcontainer",
|
|
9
|
+
"checksum": "92c0103405a10d4bea8a9f0f924c0131f5cb42b389d36fe1cd898254a7afd8da8a6526f7e758ed3556c698a7d555e52646672cb8c632649d1bc54cb1c671d3cd"
|
|
10
|
+
},
|
|
11
|
+
{
|
|
12
|
+
"key": "dockerignore",
|
|
13
|
+
"sourcePath": "./templates/.dockerignore",
|
|
14
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_dockerignore.0.0.0.tar.gz",
|
|
15
|
+
"targetPath": "./",
|
|
16
|
+
"checksum": "0de93017db2bc3891e95c7456c55703425a28cc2a9a35b4760ae4cb5b879e829a12a08437467f4791582bf2b867dccaec1d61b55a4173a3efe9eabf7e3d4697b"
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
"key": "env",
|
|
20
|
+
"sourcePath": "./templates/env",
|
|
21
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_env.0.0.0.tar.gz",
|
|
22
|
+
"targetPath": "./",
|
|
23
|
+
"checksum": "b2b434e57e1c2ad9fef495d573ca857f3c04209464b20b69e8c87bb7f257728f0d8fc892bea58e6132af37077d954bc02b1629ef68ac30343e21e70beaf509b5"
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"key": "scripts",
|
|
27
|
+
"sourcePath": "./templates/.scripts",
|
|
28
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_scripts.0.0.0.tar.gz",
|
|
29
|
+
"targetPath": "./.scripts",
|
|
30
|
+
"checksum": "15f44fc518e7e3b6438029856c3046a5e666393bb237420c3caf51fc2138188a71701b7f7129ae4acff2065d7fb8665b04e5551ccd110729b2affe26e34f47f7"
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"key": "vscode",
|
|
34
|
+
"sourcePath": "./templates/.vscode",
|
|
35
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_vscode.0.0.0.tar.gz",
|
|
36
|
+
"targetPath": "./.vscode",
|
|
37
|
+
"checksum": "011cad53c8732a175940c2719300469e1c7804384885a5f9b2a1d66569fabcde9b13e90f2335e43990fc6767bf972ef046455c21828d55cb821e0d3583e53c08"
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"key": "backend-dotnet",
|
|
41
|
+
"sourcePath": "./templates/backends/dotnet",
|
|
42
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_backends_dotnet.0.0.0.tar.gz",
|
|
43
|
+
"targetPath": "./backend",
|
|
44
|
+
"checksum": "8e91903c2d9ff746f1aca9ff84f62cdcf459183686571673f4d00439ae99c8e39d11e571885bc0e28e7f9430d0f02eee6e4c9e3729d550ef28d39fb85d85223d"
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"key": "backend-expressjs",
|
|
48
|
+
"sourcePath": "./templates/backends/expressjs",
|
|
49
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_backends_expressjs.0.0.0.tar.gz",
|
|
50
|
+
"targetPath": "./backend",
|
|
51
|
+
"checksum": "fe8ae175476b48d8522502996272c9dddfe06416d326b50b9af648fc9f52899cbea4651b64e95e66cb9d077d2c83ba99489e7e78739a7a85b6fe487aa5ad1133"
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"key": "docker-development",
|
|
55
|
+
"sourcePath": "./templates/docker/common/development",
|
|
56
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_docker_common_development.0.0.0.tar.gz",
|
|
57
|
+
"targetPath": "./docker/development",
|
|
58
|
+
"checksum": "bf70a952e6249b9b90f0c248067860dc076e3be6e3119558a92fd02e78152b65b26dbe83f00315c66c81c3c93ca024965e1475b6d213993710060367b2d4e06f"
|
|
59
|
+
},
|
|
60
|
+
{
|
|
61
|
+
"key": "docker-dotnet-service",
|
|
62
|
+
"sourcePath": "./templates/docker/dotnet/service",
|
|
63
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_docker_dotnet_service.0.0.0.tar.gz",
|
|
64
|
+
"targetPath": "./docker",
|
|
65
|
+
"checksum": "3aaa5cb1c13880b4f8670ae39e8468185082fcea0dcbd7c8251cbefa682eeb7341be45a702f8d6e7a3d37a15f26ffcc0c731181316aba132c383761f84eddcea"
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
"key": "docker-dotnet-plugin",
|
|
69
|
+
"sourcePath": "./templates/docker/dotnet/plugin",
|
|
70
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_docker_dotnet_plugin.0.0.0.tar.gz",
|
|
71
|
+
"targetPath": "./docker",
|
|
72
|
+
"checksum": "26230dbda4b846445251c5fa09f8d0b8e807b36f0c5c9575a46ac37ca6737a1375ac855ec1ed6ed6c63515426904a0d8aa57c37c1cf88c42e5c75a927f48ea60"
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"key": "docker-nodejs-plugin",
|
|
76
|
+
"sourcePath": "./templates/docker/nodejs",
|
|
77
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_docker_nodejs_plugin.0.0.0.tar.gz",
|
|
78
|
+
"targetPath": "./docker",
|
|
79
|
+
"checksum": "3bbb31d2eadc311c15f78b829ad7c51236928b327a78cc28f845106126460b18a8647f25dd2b35c829970e496fbd0f51c249c244f06e92b74a9a4c8d8ed5473a"
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"key": "frontend-vue",
|
|
83
|
+
"sourcePath": "./templates/frontends/vue",
|
|
84
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_frontends_react.0.0.0.tar.gz",
|
|
85
|
+
"targetPath": "./frontend",
|
|
86
|
+
"checksum": "c087877a8f5f19ba11a57e422cab461caf9703e062ed9bf21a57ef69baa1844ef78e54d0bb6743a20e9e8e8a632a87c2ed1c4783f268eff3a747f07bedd16732"
|
|
87
|
+
},
|
|
88
|
+
{
|
|
89
|
+
"key": "frontend-react",
|
|
90
|
+
"sourcePath": "./templates/frontends/react",
|
|
91
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_frontends_vue.0.0.0.tar.gz",
|
|
92
|
+
"targetPath": "./frontend",
|
|
93
|
+
"checksum": "018b45b2f237f24595fac79dfbeade18ff2656aa110d0208b5ab6bff3c6318e6a13252429002075729822988ea328865c3f4bb8ebb66515615f503184121aed6"
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
"key": "gitlab-ci-dotnet-service",
|
|
97
|
+
"sourcePath": "./templates/gitlab-ci/dotnet/service",
|
|
98
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_gitlab-ci_dotnet_service.0.0.0.tar.gz",
|
|
99
|
+
"targetPath": "./",
|
|
100
|
+
"checksum": "ac40928a6c2c1387de530da134587c2fe0798c6a288738f4f8cc7a2d291efda5df3c02723dceb9ef689e58804714d823a6c57fe05e58c764e59dea39a2b11cb2"
|
|
101
|
+
},
|
|
102
|
+
{
|
|
103
|
+
"key": "gitlab-ci-dotnet-plugin",
|
|
104
|
+
"sourcePath": "./templates/gitlab-ci/dotnet/plugin",
|
|
105
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_gitlab-ci_dotnet_plugin.0.0.0.tar.gz",
|
|
106
|
+
"targetPath": "./",
|
|
107
|
+
"checksum": "e1d31e4d91a63be3cbe01d0d80371478bc3c121d15c39ef7bba047237a9452d4a3b644260a02ba2983fb4af47ba663c40926284d741336b833e7cfffd37d1ed4"
|
|
108
|
+
},
|
|
109
|
+
{
|
|
110
|
+
"key": "gitlab-ci-nodejs-plugin",
|
|
111
|
+
"sourcePath": "./templates/gitlab-ci/nodejs/plugin",
|
|
112
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_gitlab-ci_nodejs_plugin.0.0.0.tar.gz",
|
|
113
|
+
"targetPath": "./",
|
|
114
|
+
"checksum": "1709e08ae22fbf5fd04a8e789a5a5a52b8e866f39a5f8baa6642cfd3b1f6059391e1c2830ad9740d555b2f0b287d812dc8a1dad24f078befb48f9d7dce8a8024"
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
"key": "helm",
|
|
118
|
+
"sourcePath": "./templates/helm",
|
|
119
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_helm.0.0.0.tar.gz",
|
|
120
|
+
"targetPath": "./helm",
|
|
121
|
+
"checksum": "fdb113d3291189474e6320d0b9b048a1a8db6c949010a9021357a7a5196b5d9fb3d2f55cc9903679a9bc12c6f612360814676282f865ae79f6a98af0f8da4c17"
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
"key": "service-dotnet",
|
|
125
|
+
"sourcePath": "./templates/services/dotnet",
|
|
126
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_services_dotnet.0.0.0.tar.gz",
|
|
127
|
+
"targetPath": "./backend",
|
|
128
|
+
"checksum": "72a5e50d9a660782aae53bfbe4297acd2fe2d83693071c5dca4d4fce5a311456dce2439751df20d1fc8d34df6b0fc86637618bf5e0a7f91786aaeb942815157a"
|
|
129
|
+
},
|
|
130
|
+
{
|
|
131
|
+
"key": "service-expressjs",
|
|
132
|
+
"sourcePath": "./templates/services/expressjs",
|
|
133
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_services_expresssj.0.0.0.tar.gz",
|
|
134
|
+
"targetPath": "./backend",
|
|
135
|
+
"checksum": "4b206790b1cfb3ecc17a2f1b59db3bf42dfd214d54ce0a2381862370f9c614e2be0b829867b8049c813fab48abc00b7390b1d893f64261f4471293a257e72423"
|
|
136
|
+
},
|
|
137
|
+
{
|
|
138
|
+
"key": "extension-vue",
|
|
139
|
+
"sourcePath": "./templates/sandbox-extension/vue",
|
|
140
|
+
"remotePath": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/templates_sandbox-extension_vue.0.0.0.tar.gz",
|
|
141
|
+
"targetPath": "./frontend",
|
|
142
|
+
"checksum": "60d3cf47d6f9a36123d37e5e1dc73032ad95bad8658b7e5975ef3521d3a2746a87bcc17a26d3ac37cdbfa0a663dcb4bc5e68c69def3c81d1c9833685dbdd5b42"
|
|
143
|
+
}
|
|
144
|
+
]
|
|
145
|
+
}
|
package/package.json
CHANGED
|
@@ -1,38 +1,36 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "beast-core-create",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.2.0",
|
|
4
|
+
"description": "BeastCore plugin and service project scaffolder",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
|
-
"
|
|
6
|
+
"type": "module",
|
|
7
7
|
"scripts": {
|
|
8
8
|
"test": "echo \"Error: no test specified\" && exit 1",
|
|
9
|
-
"build": "
|
|
9
|
+
"build": "rollup --config",
|
|
10
10
|
"dev": "tsc --watch"
|
|
11
11
|
},
|
|
12
12
|
"repository": {
|
|
13
13
|
"type": "git",
|
|
14
|
-
"url": "https://gitlab.phactory.beast-code.com/bcas/devex/beast-core-sdk/beast-core-
|
|
14
|
+
"url": "https://gitlab.phactory.beast-code.com/bcas/devex/beast-core-sdk/beast-core-sdk"
|
|
15
15
|
},
|
|
16
|
-
"author": "Beast Code
|
|
16
|
+
"author": "Beast Code LLC",
|
|
17
17
|
"license": "ISC",
|
|
18
18
|
"bin": {
|
|
19
|
-
"beast-core-create": "dist/
|
|
19
|
+
"beast-core-create": "dist/main.js"
|
|
20
20
|
},
|
|
21
|
+
"files": [
|
|
22
|
+
"dist"
|
|
23
|
+
],
|
|
24
|
+
"bundleDependencies": [
|
|
25
|
+
"@bc/beast-core-sdk-cli"
|
|
26
|
+
],
|
|
21
27
|
"dependencies": {
|
|
22
|
-
"@
|
|
23
|
-
"@inquirer/select": "^4.2.3",
|
|
24
|
-
"adm-zip": "^0.5.16",
|
|
25
|
-
"axios": "^1.9.0",
|
|
26
|
-
"beast-core-cli": "https://s3.us-east-2.amazonaws.com/beast-code.bcas-sdk-20250821152258661600000001/beast-core-cli-0.1.1.tgz",
|
|
27
|
-
"tar": "^7.4.3"
|
|
28
|
+
"@bc/beast-core-sdk-cli": "^0.0.0"
|
|
28
29
|
},
|
|
29
30
|
"devDependencies": {
|
|
30
|
-
"@
|
|
31
|
-
"@
|
|
32
|
-
"
|
|
33
|
-
"typescript": "^5.
|
|
34
|
-
}
|
|
35
|
-
"files": [
|
|
36
|
-
"dist"
|
|
37
|
-
]
|
|
31
|
+
"@rollup/plugin-commonjs": "^29.0.0",
|
|
32
|
+
"@rollup/plugin-node-resolve": "^16.0.3",
|
|
33
|
+
"@types/node": "^24.6.2",
|
|
34
|
+
"typescript": "^5.9.3"
|
|
35
|
+
}
|
|
38
36
|
}
|
package/LICENSE.txt
DELETED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
Copyright 2025 Beast Code LLC
|
|
2
|
-
|
|
3
|
-
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
|
4
|
-
|
|
5
|
-
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
|
6
|
-
|
|
7
|
-
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
|
8
|
-
|
|
9
|
-
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
|
10
|
-
|
|
11
|
-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
package/README.md
DELETED
|
@@ -1,93 +0,0 @@
|
|
|
1
|
-
# beast-core-create
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
## Getting started
|
|
6
|
-
|
|
7
|
-
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
|
8
|
-
|
|
9
|
-
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
|
10
|
-
|
|
11
|
-
## Add your files
|
|
12
|
-
|
|
13
|
-
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
|
14
|
-
- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
|
|
15
|
-
|
|
16
|
-
```
|
|
17
|
-
cd existing_repo
|
|
18
|
-
git remote add origin https://gitlab.phactory.beast-code.com/bcas/devex/beast-core-sdk/beast-core-create.git
|
|
19
|
-
git branch -M main
|
|
20
|
-
git push -uf origin main
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
## Integrate with your tools
|
|
24
|
-
|
|
25
|
-
- [ ] [Set up project integrations](https://gitlab.phactory.beast-code.com/bcas/devex/beast-core-sdk/beast-core-create/-/settings/integrations)
|
|
26
|
-
|
|
27
|
-
## Collaborate with your team
|
|
28
|
-
|
|
29
|
-
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
|
30
|
-
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
|
31
|
-
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
|
32
|
-
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
|
33
|
-
- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
|
|
34
|
-
|
|
35
|
-
## Test and Deploy
|
|
36
|
-
|
|
37
|
-
Use the built-in continuous integration in GitLab.
|
|
38
|
-
|
|
39
|
-
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
|
|
40
|
-
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
|
41
|
-
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
|
42
|
-
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
|
43
|
-
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
|
44
|
-
|
|
45
|
-
***
|
|
46
|
-
|
|
47
|
-
# Editing this README
|
|
48
|
-
|
|
49
|
-
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
|
50
|
-
|
|
51
|
-
## Suggestions for a good README
|
|
52
|
-
|
|
53
|
-
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
|
54
|
-
|
|
55
|
-
## Name
|
|
56
|
-
Choose a self-explaining name for your project.
|
|
57
|
-
|
|
58
|
-
## Description
|
|
59
|
-
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
|
60
|
-
|
|
61
|
-
## Badges
|
|
62
|
-
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
|
63
|
-
|
|
64
|
-
## Visuals
|
|
65
|
-
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
|
66
|
-
|
|
67
|
-
## Installation
|
|
68
|
-
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
|
69
|
-
|
|
70
|
-
## Usage
|
|
71
|
-
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
|
72
|
-
|
|
73
|
-
## Support
|
|
74
|
-
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
|
75
|
-
|
|
76
|
-
## Roadmap
|
|
77
|
-
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
|
78
|
-
|
|
79
|
-
## Contributing
|
|
80
|
-
State if you are open to contributions and what your requirements are for accepting them.
|
|
81
|
-
|
|
82
|
-
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
|
83
|
-
|
|
84
|
-
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
|
85
|
-
|
|
86
|
-
## Authors and acknowledgment
|
|
87
|
-
Show your appreciation to those who have contributed to the project.
|
|
88
|
-
|
|
89
|
-
## License
|
|
90
|
-
For open source projects, say how it is licensed.
|
|
91
|
-
|
|
92
|
-
## Project status
|
|
93
|
-
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
package/dist/bin.js
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
2
|
-
"use strict";
|
|
3
|
-
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
4
|
-
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
5
|
-
return new (P || (P = Promise))(function (resolve, reject) {
|
|
6
|
-
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
7
|
-
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
8
|
-
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
9
|
-
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
10
|
-
});
|
|
11
|
-
};
|
|
12
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
13
|
-
//@ts-ignore
|
|
14
|
-
const beast_core_cli_1 = require("beast-core-cli");
|
|
15
|
-
new beast_core_cli_1.SdkCreateCommand();
|
|
16
|
-
(() => __awaiter(void 0, void 0, void 0, function* () {
|
|
17
|
-
const cmd = new beast_core_cli_1.SdkCreateCommand();
|
|
18
|
-
//@ts-ignore
|
|
19
|
-
cmd.mainAsync(process.argv.slice(2));
|
|
20
|
-
}))();
|
|
21
|
-
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmluLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2Jpbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7QUFDQSxZQUFZO0FBQ1osbURBQWlEO0FBQ2pELElBQUksaUNBQWdCLEVBQUUsQ0FBQztBQUN2QixDQUFDLEdBQVMsRUFBRTtJQUNSLE1BQU0sR0FBRyxHQUFxQixJQUFJLGlDQUFnQixFQUFFLENBQUM7SUFDckQsWUFBWTtJQUNaLEdBQUcsQ0FBQyxTQUFTLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztBQUN6QyxDQUFDLENBQUEsQ0FBQyxFQUFFLENBQUMifQ==
|
package/dist/index.js
DELETED