Skip to content

Commit

Permalink
Updated docs and build to latest gobstones-scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
alanrodas committed Oct 26, 2022
1 parent 67f44ab commit 610bf94
Show file tree
Hide file tree
Showing 132 changed files with 7,034 additions and 21,018 deletions.
253 changes: 127 additions & 126 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,158 +1,159 @@
module.exports = {
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": 2018,
"sourceType": "module",
"impliedStrict": true
parser: '@typescript-eslint/parser',
parserOptions: {
ecmaVersion: 2018,
sourceType: 'module',
impliedStrict: true,
warnOnUnsupportedTypeScriptVersion: false
},
"env": {
"node": true
env: {
node: true
},
"plugins": [
"@typescript-eslint",
"import",
"no-null",
"prefer-arrow",
"prettier"
plugins: ['@typescript-eslint', 'import', 'no-null', 'prefer-arrow', 'prettier'],
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'plugin:@typescript-eslint/eslint-recommended',
'plugin:prettier/recommended',
'prettier/prettier'
],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"plugin:@typescript-eslint/eslint-recommended",
"plugin:prettier/recommended",
"prettier/@typescript-eslint"
],
"noInlineConfig": false,
"reportUnusedDisableDirectives": true,
"rules": {
"@typescript-eslint/array-type": "error",
"@typescript-eslint/ban-types": "error",
"@typescript-eslint/consistent-type-definitions": "error",
"@typescript-eslint/explicit-function-return-type": [
"error",
noInlineConfig: false,
reportUnusedDisableDirectives: true,
rules: {
'@typescript-eslint/array-type': 'error',
'@typescript-eslint/ban-types': 'error',
'@typescript-eslint/consistent-type-definitions': 'error',
'@typescript-eslint/explicit-function-return-type': [
'error',
{
allowExpressions: true,
allowTypedFunctionExpressions: true,
allowHigherOrderFunctions: true
}
],
'@typescript-eslint/explicit-member-accessibility': [
'error',
{
"allowExpressions": true,
"allowTypedFunctionExpressions": true,
"allowHigherOrderFunctions": true
accessibility: 'explicit'
}
],
"@typescript-eslint/explicit-member-accessibility": [
"error",
'@typescript-eslint/member-ordering': [
'error',
{
"accessibility": "explicit"
default: [
// Index signature
'signature',
// Fields
'field',
// Constructors
'constructor',
// Getters and Setters at the same rank
['get', 'set'],
// Methods
'method'
]
}
],
"@typescript-eslint/member-ordering": "error",
"@typescript-eslint/no-empty-function": "error",
"@typescript-eslint/no-explicit-any": "off",
"@typescript-eslint/no-inferrable-types": "off",
"@typescript-eslint/no-namespace": "off",
"@typescript-eslint/no-parameter-properties": "off",
"@typescript-eslint/no-shadow": [
"error",
'@typescript-eslint/no-empty-function': 'error',
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/no-inferrable-types': 'off',
'@typescript-eslint/no-namespace': 'off',
'@typescript-eslint/no-parameter-properties': 'off',
'@typescript-eslint/no-shadow': [
'error',
{
"hoist": "all"
hoist: 'all'
}
],
"@typescript-eslint/no-unused-vars": ["error", {
"vars": "all",
"args": "none",
"ignoreRestSiblings": false
}],
"@typescript-eslint/prefer-for-of": "error",
"@typescript-eslint/prefer-function-type": "error",
"@typescript-eslint/prefer-namespace-keyword": "error",
"@typescript-eslint/triple-slash-reference": "error",
"@typescript-eslint/unified-signatures": "error",
'@typescript-eslint/no-unused-vars': [
'error',
{
vars: 'all',
args: 'none',
ignoreRestSiblings: false
}
],
'@typescript-eslint/prefer-for-of': 'error',
'@typescript-eslint/prefer-function-type': 'error',
'@typescript-eslint/prefer-namespace-keyword': 'error',
'@typescript-eslint/triple-slash-reference': 'error',
'@typescript-eslint/unified-signatures': 'error',

"no-null/no-null": "error",
'no-null/no-null': 'error',

"prettier/prettier": "error",
'prettier/prettier': 'error',

"prefer-arrow/prefer-arrow-functions": [
"error",
'prefer-arrow/prefer-arrow-functions': [
'error',
{
"disallowPrototype": true,
"singleReturnOnly": true,
"classPropertiesAllowed": false
disallowPrototype: true,
singleReturnOnly: true,
classPropertiesAllowed: false
}
],

"arrow-body-style": "error",
"camelcase": "error",
"capitalized-comments": "off",
"comma-dangle": [
"error",
'arrow-body-style': 'error',
camelcase: 'error',
'capitalized-comments': 'off',
'comma-dangle': [
'error',
{
"objects": "never",
"arrays": "never",
"functions": "never"
objects: 'never',
arrays: 'never',
functions: 'never'
}
],
"complexity": "off",
"default-case": "error",
"dot-location": [
"error",
"property"
],
"eqeqeq": [
"error",
"smart"
],
"max-len": [
"error",
complexity: 'off',
'default-case': 'error',
'dot-location': ['error', 'property'],
eqeqeq: ['error', 'smart'],
'max-len': [
'error',
{
"code": 100
code: 100
}
],
"no-alert": "error",
"no-bitwise": "error",
"no-caller": "error",
"no-console": "error",
"no-constructor-return": "error",
"no-div-regex": "error",
"no-empty": "error",
"no-empty-function": [
"error",
'no-alert': 'error',
'no-bitwise': 'error',
'no-caller': 'error',
'no-console': 'error',
'no-constructor-return': 'error',
'no-div-regex': 'error',
'no-empty': 'error',
'no-empty-function': [
'error',
{
"allow": ["constructors"]
allow: ['constructors']
}
],
"no-eval": "error",
"no-extra-bind": "error",
"no-import-assign": "error",
"no-invalid-this": "error",
"no-labels": "error",
"no-multiple-empty-lines": "error",
"no-new-wrappers": "error",
"no-regex-spaces": "error",
"no-return-assign": "error",
"no-return-await": "error",
"no-self-compare": "error",
'no-eval': 'error',
'no-extra-bind': 'error',
'no-import-assign': 'error',
'no-invalid-this': 'error',
'no-labels': 'error',
'no-multiple-empty-lines': 'error',
'no-new-wrappers': 'error',
'no-regex-spaces': 'error',
'no-return-assign': 'error',
'no-return-await': 'error',
'no-self-compare': 'error',
'no-shadow': 'off',
"no-throw-literal": "error",
"no-undef-init": "error",
"no-underscore-dangle": "error",
"no-unused-expressions": "error",
"no-useless-call": "error",
"no-useless-concat": "error",
"no-var": "error",
"object-shorthand": "error",
"one-var": [
"error",
"never"
],
"prefer-const": "error",
"prefer-regex-literals": "error",
"quote-props": [
"error",
"consistent-as-needed"
],
"radix": "error",
"require-await": "error",
"spaced-comment": "error",
"use-isnan": "error",
"valid-typeof": "error",
"yoda": "error"
'no-throw-literal': 'error',
'no-undef-init': 'error',
'no-underscore-dangle': 'error',
'no-unused-expressions': 'error',
'no-useless-call': 'error',
'no-useless-concat': 'error',
'no-var': 'error',
'object-shorthand': 'error',
'one-var': ['error', 'never'],
'prefer-const': 'error',
'prefer-regex-literals': 'error',
radix: 'error',
'require-await': 'error',
'spaced-comment': 'error',
'use-isnan': 'error',
'valid-typeof': 'error',
yoda: 'error'
}
};
6 changes: 4 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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.
Before opening a new issue, please take a moment to review our [**guidelines**](https://github.com/gobstones/gobstones-guidelines) to make the contribution process easy and effective for everyone involved.

## Description
A clear and concise description of what the bug is.
Expand All @@ -21,4 +21,6 @@ A clear and concise description of what you expected to happen.
## Versions

- Library Version:
- Node/NPM Version:
- Node/NPM Version (if any):
- Operating System Version:
- Browser Version:
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ about: Suggest an idea for this project

---

Before opening a new feature request, please take a moment to review our [**guidelines**](https://github.com/gobstones/gobstones-guidelines) to make the contribution process easy and effective for everyone involved.

More specifically, see our **roadmap** to be aware if the feature you are considering is already planned. If you still considere the feature is worth requesting, please complete the following:

**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 [...]

Expand Down
18 changes: 11 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
## 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.
Thank you for contributing! Please take a moment to review our
[**guidelines**](https://github.com/gobstones/gobstones-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
Expand All @@ -10,15 +11,18 @@ merged into the project.

Before opening a pull request, please ensure:

- [ ] You have followed our [**contributing guidelines**](https://dev.gobstones.org/contribution-guidelines)
- [ ] You have followed our [**guidelines**](https://github.com/gobstones/gobstones-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
- [ ] 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 :)
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).
**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
license your work under the terms of the
[MIT License](https://github.com/gobstones/gobstones-guidelines/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion .github/lock.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ lockComment: >
related bugs.
# Limit to only `issues` or `pulls`
# only: issues
only: issues

# Optionally, specify configuration settings just for `issues` or `pulls`
# issues:
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ jobs:
name: Run tests using Node.js 14.x
- uses: actions/setup-node@v2
with:
node-version: "14"
node-version: "16"
- run: npm set-script prepare ""
- run: npm install
- run: npm run build
env:
Expand Down
27 changes: 27 additions & 0 deletions .github/workflows/release-github.yml
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
Loading

0 comments on commit 610bf94

Please sign in to comment.