-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
68 changed files
with
19,741 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# http://editorconfig.org | ||
|
||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
end_of_line = lf | ||
indent_style = space | ||
indent_size = 4 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false | ||
|
||
# Use 2 spaces since npm does not respect custom indentation settings | ||
[package.json] | ||
indent_style = space | ||
indent_size = 2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
|
||
--- | ||
|
||
Before opening a new issue, please take a moment to review our [**community guidelines**](https://dev.gobstones.org/contribution-guidelines) to make the contribution process easy and effective for everyone involved. | ||
|
||
## Description | ||
A clear and concise description of what the bug is. | ||
|
||
## Steps to reproduce | ||
Steps to reproduce the behavior: | ||
|
||
(Add link to a demo on https://jsfiddle.net or similar if possible) | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
|
||
## Versions | ||
|
||
- Library Version: | ||
- Node/NPM Version: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
## Gobstones | ||
|
||
Thank you for contributing! Please take a moment to review our [**contributing guidelines**](https://dev.gobstones.org/contribution-guidelines) | ||
to make the process easy and effective for everyone involved. | ||
|
||
**Please open an issue** before embarking on any significant pull request, | ||
especially those that add a new library or change existing tests, otherwise you | ||
risk spending a lot of time working on something that might not end up being | ||
merged into the project. | ||
|
||
Before opening a pull request, please ensure: | ||
|
||
- [ ] You have followed our [**contributing guidelines**](https://dev.gobstones.org/contribution-guidelines) | ||
- [ ] Double-check your branch is based on `main` and targets `main` | ||
- [ ] Pull request has tests (we are going for 100% coverage!) | ||
- [ ] Code is well-commented, linted and follows project conventions | ||
- [ ] Documentation is updated (if necessary) | ||
- [ ] Internal code generators and templates are updated (if necessary) | ||
- [ ] Description explains the issue/use-case resolved and auto-closes related issues | ||
|
||
Be kind to code reviewers, please try to keep pull requests as small and focused as possible :) | ||
|
||
**IMPORTANT**: By submitting a patch, you agree to allow the project | ||
owners to license your work under the terms of the [MIT License](https://dev.gobstones.org/licence). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
comment: This issue was automatically closed because it does not follow either one of our templates. Please open a new issue and fill out the template that appears instead of deleting it. If you're reporting an issue, it's especially important that you provide detailed steps for how to reproduce it. | ||
|
||
issueConfigs: | ||
|
||
- content: | ||
- Description | ||
- Steps to reproduce | ||
- Versions | ||
|
||
- content: | ||
- Is your feature request related to a problem | ||
- Describe the solution you'd like | ||
- Describe alternatives you've considered | ||
- Additional context |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Configuration for lock-threads - https://github.com/dessant/lock-threads | ||
|
||
# Number of days of inactivity before a closed issue or pull request is locked | ||
daysUntilLock: 30 | ||
|
||
# Issues and pull requests with these labels will not be locked. Set to `[]` to disable | ||
exemptLabels: [] | ||
|
||
# Label to add before locking, such as `outdated`. Set to `false` to disable | ||
lockLabel: 'Auto-Closed' | ||
|
||
# Comment to post before locking. Set to `false` to disable | ||
lockComment: > | ||
This thread has been automatically locked since there has not been | ||
any recent activity after it was closed. Please open a new issue for | ||
related bugs. | ||
# Limit to only `issues` or `pulls` | ||
# only: issues | ||
|
||
# Optionally, specify configuration settings just for `issues` or `pulls` | ||
# issues: | ||
# exemptLabels: | ||
# - help-wanted | ||
# lockLabel: outdated | ||
|
||
# pulls: | ||
# daysUntilLock: 30 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
name: build-on-commit | ||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
branches: | ||
- main | ||
jobs: | ||
test: | ||
name: Run tests | ||
runs-on: ubuntu-latest | ||
env: | ||
NODE_OPTIONS: --experimental-modules | ||
steps: | ||
- uses: actions/checkout@v2 | ||
name: Run tests using Node.js 14.x | ||
- uses: actions/setup-node@v2 | ||
with: | ||
node-version: "16" | ||
- run: npm set-script prepare "" | ||
- run: npm install | ||
- run: npm run build | ||
env: | ||
CI: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
name: release-github-on-tag | ||
|
||
on: | ||
push: | ||
# Sequence of patterns matched against refs/tags | ||
tags: | ||
- "v*" # Push events to matching v*, i.e. v1.0, v20.15.10 | ||
|
||
jobs: | ||
publish-into-github: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v3 | ||
- run: npm set-script prepare "" | ||
- run: npm install | ||
- name: Create Release on GitHub | ||
id: create_release | ||
uses: actions/create-release@v1 | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
with: | ||
tag_name: ${{ github.ref }} | ||
release_name: Release ${{ github.ref }} | ||
body: ${{ github.event.head_commit.message }} | ||
draft: false | ||
prerelease: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
name: release-npm-on-tag | ||
|
||
on: | ||
push: | ||
# Sequence of patterns matched against refs/tags | ||
tags: | ||
- "v*" # Push events to matching v*, i.e. v1.0, v20.15.10 | ||
|
||
jobs: | ||
publish-into-npm: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: actions/setup-node@v3 | ||
env: | ||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} | ||
with: | ||
node-version: 16 | ||
- run: npm set-script prepare "" | ||
- run: npm install | ||
- uses: JS-DevTools/npm-publish@v1 | ||
with: | ||
token: ${{ secrets.NPM_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
name: test-on-commit | ||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
branches: | ||
- main | ||
jobs: | ||
test: | ||
name: Run tests | ||
runs-on: ubuntu-latest | ||
env: | ||
NODE_OPTIONS: --experimental-modules | ||
steps: | ||
- uses: actions/checkout@v2 | ||
name: Run tests using Node.js 14.x | ||
- uses: actions/setup-node@v2 | ||
with: | ||
node-version: "16" | ||
- run: npm set-script prepare "" | ||
- run: npm install | ||
- run: npm test | ||
env: | ||
CI: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Node files # | ||
node_modules/ | ||
npm-debug.log | ||
yarn-error.log | ||
.rollup.cache | ||
|
||
# OS generated files # | ||
.DS_Store | ||
Thumbs.db | ||
.tmp/ | ||
|
||
# Dist # | ||
dist/ | ||
coverage/ | ||
tsconfig.build.json | ||
|
||
# IDE # | ||
.idea/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Editor and style files | ||
.vscode/* | ||
.github/* | ||
|
||
# tests | ||
test/* | ||
coverage | ||
|
||
# docs | ||
docs | ||
|
||
# Additional documentarion | ||
TODO.md | ||
|
||
# Add files in init-files | ||
!init-files/* | ||
!config/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
dist/ | ||
node_modules/ | ||
package-lock.json | ||
yarn.lock | ||
package.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
{ | ||
"printWidth": 100, | ||
"tabWidth": 4, | ||
"useTabs": false, | ||
"semi": true, | ||
"singleQuote": true, | ||
"trailingComma": "none", | ||
"parser": "typescript", | ||
"endOfLine": "lf" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# 0.1.0 | ||
|
||
* Initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Contibution Guidelines | ||
|
||
## On Submitting Bug Reports | ||
|
||
Please make sure you fill the provided template and provide detailed explanation on how to reproduce the issue. Mainly, the string parsed or object stringified, the expected result, and the result obtained. | ||
|
||
Specify the version of NPM/Node you're using and your OS/Browser if relevant. | ||
|
||
We will try to answer as fast as possible, and attempt to fix it if possible. | ||
|
||
## On Submitting Feature Requests | ||
|
||
Please specify thoroughly the feature you want, and what is the reason for such a feature. Follow the provided template and complete it. Discussion will follow on the same issue, until an approval or rejection of the feature is decided. | ||
|
||
## On Submitting New Code | ||
|
||
Please make sure your code complies with the following practices: | ||
* All code is documented | ||
* The code passes the linting process (Without disabling linter) | ||
* Use relevant, descriptive names for functions, parameters, variables or other symbols. | ||
* Test pass OK. | ||
* On new features, tests for additional cases are provided. | ||
|
||
Make sure to open an issue and discuss about it before throwing yourself into coding something that may not be merged, specially when adding new features, modifying the API, or adding/changing libraries. | ||
|
||
Provide clear concise description of the changes in the commit message and pull requests. | ||
|
||
Make sure to only contribute to `dev` branch, as we follow git-flow. |
Oops, something went wrong.