Skip to content

Commit a2d42ca

Browse files
extremeheatextremeheat
authored
Initial commit
0 parents  commit a2d42ca

18 files changed

+300
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: possible bug
6+
assignees: ''
7+
8+
---
9+
10+
- [ ] The [readme](https://github.com/PrismarineJS/prismarine-template/README.md) doesn't contain a resolution to my issue
11+
- [ ] The [example](https://github.com/PrismarineJS/prismarine-template/example.js) doesn't contain a resolution to my issue
12+
13+
<!-- To mark the checkbox, insert `x` into it: [x] -->
14+
15+
## Versions
16+
- node: #.#.#
17+
- prismarine-template: #.#.#
18+
19+
## Detailed description of a problem
20+
A clear and concise description of what the problem is.
21+
22+
## Your current code
23+
```js
24+
console.log("Hello world.")
25+
```
26+
27+
## Expected behavior
28+
A clear and concise description of what you expected to happen.
29+
30+
## Additional context
31+
Add any other context about the problem here.
32+
---

‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: new feature
6+
assignees: ''
7+
8+
---
9+
10+
## Is your feature request related to a problem? Please describe.
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
## Describe the solution you'd like
14+
A clear and concise description of what you want to happen.
15+
16+
## Describe alternatives you've considered
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
## Additional context
20+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/question.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Question
3+
about: Ask a question
4+
title: ''
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
- [ ] The [readme](https://github.com/PrismarineJS/prismarine-template/README.md) doesn't contain a resolution to my issue
11+
- [ ] The [example](https://github.com/PrismarineJS/prismarine-template/example.js) doesn't contain a resolution to my issue
12+
13+
14+
<!-- To mark the checkbox, insert `x` into it: [x] -->
15+
16+
## Versions
17+
18+
- mineflayer: #.#.#
19+
- server: vanilla/spigot/paper #.#.#
20+
- node: #.#.#
21+
22+
## Clear question
23+
24+
A clear question, with as much context as possible.
25+
What are you building? What problem are you trying to solve?
26+
27+
## What did you try yet?
28+
29+
Did you try any method from the API?
30+
Did you try any example? Any error from those?
31+
32+
## Your current code
33+
34+
Please put here any custom code you tried yet.
35+
36+
```js
37+
38+
/*
39+
Some code here, replace this
40+
*/
41+
42+
```
43+
44+
## Additional context
45+
46+
Add any other context about the problem here.

‎.github/dependabot.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: npm
4+
directory: "/"
5+
schedule:
6+
interval: daily
7+
open-pull-requests-limit: 10

‎.github/workflows/ci.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
pull_request:
7+
branches: [ master ]
8+
9+
jobs:
10+
build:
11+
12+
runs-on: ubuntu-latest
13+
14+
strategy:
15+
matrix:
16+
node-version: [18.x]
17+
18+
steps:
19+
- uses: actions/checkout@v2
20+
- name: Use Node.js ${{ matrix.node-version }}
21+
uses: actions/setup-node@v1
22+
with:
23+
node-version: ${{ matrix.node-version }}
24+
- run: npm install
25+
- run: npm test

‎.github/workflows/commands.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Repo Commands
2+
3+
on:
4+
issue_comment: # Handle comment commands
5+
types: [created]
6+
pull_request: # Handle renamed PRs
7+
types: [edited]
8+
9+
jobs:
10+
comment-trigger:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Check out repository
14+
uses: actions/checkout@v3
15+
- name: Run command handlers
16+
uses: PrismarineJS/prismarine-repo-actions@master
17+
with:
18+
# NOTE: You must specify a Personal Access Token (PAT) with repo access here. While you can use the default GITHUB_TOKEN, actions taken with it will not trigger other actions, so if you have a CI workflow, commits created by this action will not trigger it.
19+
token: ${{ secrets.PAT_PASSWORD }}
20+
# See `Options` section below for more info on these options
21+
install-command: npm install
22+
/fixlint.fix-command: npm run fix

‎.github/workflows/publish.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: npm-publish
2+
on:
3+
push:
4+
branches:
5+
- master # Change this to your default branch
6+
jobs:
7+
npm-publish:
8+
name: npm-publish
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Checkout repository
12+
uses: actions/checkout@master
13+
- name: Set up Node.js
14+
uses: actions/setup-node@master
15+
with:
16+
node-version: 18.0.0
17+
- id: publish
18+
uses: JS-DevTools/npm-publish@v1
19+
with:
20+
token: ${{ secrets.NPM_AUTH_TOKEN }}
21+
- name: Create Release
22+
if: steps.publish.outputs.type != 'none'
23+
id: create_release
24+
uses: actions/create-release@v1
25+
env:
26+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
27+
with:
28+
tag_name: ${{ steps.publish.outputs.version }}
29+
release_name: Release ${{ steps.publish.outputs.version }}
30+
body: ${{ steps.publish.outputs.version }}
31+
draft: false
32+
prerelease: false

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules/
2+
package-lock.json
3+
.vscode

‎.gitpod

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
image:
2+
file: .gitpod.DockerFile
3+
tasks:
4+
- command: npm install

‎.gitpod.DockerFile

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
FROM gitpod/workspace-full:latest
2+
3+
RUN bash -c ". .nvm/nvm.sh \
4+
&& nvm install 18 \
5+
&& nvm use 18 \
6+
&& nvm alias default 18"
7+
8+
RUN echo "nvm use default &>/dev/null" >> ~/.bashrc.d/51-nvm-fix

‎.npmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
package-lock=false

‎HISTORY.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## History
2+
3+
### 1.0.0
4+
5+
* initial implementation

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 PrismarineJS
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# prismarine-template
2+
[![NPM version](https://img.shields.io/npm/v/prismarine-template.svg?logo=npm)](http://npmjs.com/package/prismarine-template)
3+
[![Build Status](https://img.shields.io/github/actions/workflow/status/PrismarineJS/prismarine-template/ci.yml.svg?label=CI&logo=github)](https://github.com/PrismarineJS/prismarine-template/actions?query=workflow%3A%22CI%22)
4+
[![Try it on gitpod](https://img.shields.io/static/v1.svg?label=try&message=on%20gitpod&color=brightgreen&logo=gitpod)](https://gitpod.io/#https://github.com/PrismarineJS/prismarine-template)
5+
[![GitHub Sponsors](https://img.shields.io/github/sponsors/PrismarineJS)](https://github.com/sponsors/PrismarineJS)
6+
7+
[![Official Discord](https://img.shields.io/static/v1.svg?label=OFFICIAL&message=DISCORD&color=blue&logo=discord&style=for-the-badge)](https://discord.gg/GsEFRM8)
8+
9+
10+
A template repository to make it easy to create new prismarine repo
11+
12+
## Usage
13+
14+
```js
15+
const template = require('prismarine-template')
16+
17+
template.helloWorld()
18+
```
19+
20+
## API
21+
22+
### helloWorld()
23+
24+
Prints hello world

‎example.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
const template = require('prismarine-template')
2+
3+
template.helloWorld()

‎index.js

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
if (typeof process !== 'undefined' && parseInt(process.versions.node.split('.')[0]) < 18) {
2+
console.error('Your node version is currently', process.versions.node)
3+
console.error('Please update it to a version >= 18.x.x from https://nodejs.org/')
4+
process.exit(1)
5+
}
6+
7+
module.exports.helloWorld = function () {
8+
console.log('Hello world !')
9+
}

‎package.json

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "prismarine-template",
3+
"version": "1.0.0",
4+
"description": "A template repository to make it easy to create new prismarine repo",
5+
"main": "index.js",
6+
"scripts": {
7+
"test": "mocha --reporter spec --exit",
8+
"pretest": "npm run lint",
9+
"lint": "standard",
10+
"fix": "standard --fix"
11+
},
12+
"repository": {
13+
"type": "git",
14+
"url": "git+https://github.com/PrismarineJS/prismarine-template.git"
15+
},
16+
"keywords": [
17+
"prismarine",
18+
"template"
19+
],
20+
"author": "Romain Beaumont",
21+
"license": "MIT",
22+
"bugs": {
23+
"url": "https://github.com/PrismarineJS/prismarine-template/issues"
24+
},
25+
"homepage": "https://github.com/PrismarineJS/prismarine-template#readme",
26+
"devDependencies": {
27+
"prismarine-template": "file:.",
28+
"standard": "^17.0.0",
29+
"mocha": "^10.0.0"
30+
}
31+
}

‎test/basic.test.js

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
/* eslint-env mocha */
2+
3+
describe('basic', () => {
4+
it('test', () => {
5+
6+
})
7+
})

0 commit comments

Comments
 (0)