chore(BREAKING CHANGES): Parser now uses Board.

Fix #3 Fix #4 The Board returned now corresponds to a Board from gobstones-core package, wich has multiple method that allow easy handling of the elements. BREAKING CHANGES
gobstones · Feb 12, 2021 · a3595b0 · a3595b0
1 parent d85f2eb
commit a3595b0
Show file tree

Hide file tree

Showing 80 changed files with 22,366 additions and 6,718 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -48,6 +48,7 @@ module.exports = {
         "@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-unused-vars": ["error", {
             "vars": "all",
             "args": "none",
@@ -123,12 +124,6 @@ module.exports = {
         "no-return-assign": "error",
         "no-return-await": "error",
         "no-self-compare": "error",
-        "no-shadow": [
-            "error",
-            {
-                "hoist": "all"
-            }
-        ],
         "no-throw-literal": "error",
         "no-undef-init": "error",
         "no-underscore-dangle": "error",
@@ -149,14 +144,6 @@ module.exports = {
         ],
         "radix": "error",
         "require-await": "error",
-        "space-before-function-paren": [
-            "error",
-            {
-                "anonymous": "never",
-                "asyncArrow": "always",
-                "named": "never"
-            }
-        ],
         "spaced-comment": "error",
         "use-isnan": "error",
         "valid-typeof": "error",

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -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://github.com/gobstones/gobstones-gbb-parser/blob/master/CONTRIBUTING.md) to make the contribution process easy and effective for everyone involved.
+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.
@@ -20,5 +20,5 @@ A clear and concise description of what you expected to happen.
 
 ## Versions
 
-- Gobstones GBB Parser:
-- Node/NPM:
+- Library Version:
+- Node/NPM Version:
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,6 +1,6 @@
-## Gobstones Authentication Server
+## Gobstones
 
-Thank you for contributing! Please take a moment to review our [**contributing guidelines**](https://github.com/gobstones/gobstones-gbb-parser/blob/master/CONTRIBUTING.md)
+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,
@@ -10,8 +10,8 @@ merged into the project.
 
 Before opening a pull request, please ensure:
 
-- [ ] You have followed our [**contributing guidelines**](https://github.com/gobstones/gobstones-gbb-parser/blob/master/CONTRIBUTING.md)
-- [ ] Double-check your branch is based on `dev` and targets `dev`
+- [ ] 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)
@@ -21,4 +21,4 @@ Before opening a pull request, please ensure:
 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://github.com/gobstones/gobstones-gbb-parser/blob/master/LICENSE.md).
+owners to license your work under the terms of the [MIT License](https://dev.gobstones.org/licence).
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,26 @@
+name: build-on-commit
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+        branches:
+            - main
+jobs:
+    test:
+        name: Run tests
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                node-version:
+                    - 14.x
+        steps:
+            - uses: actions/checkout@v2
+              name: Run tests using Node.js ${{ matrix.node-version }}
+            - uses: actions/setup-node@v1
+              with:
+                  node-version: "${{ matrix.node-version }}"
+            - run: npm install
+            - run: npm run build
+              env:
+                  CI: true
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,47 +1,47 @@
-name: Release on Tag
+name: release-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
+    push:
+        # Sequence of patterns matched against refs/tags
+        tags:
+            - "v*" # Push events to matching v*, i.e. v1.0, v20.15.10
 
 jobs:
-  build:
-    name: Create Release
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      # Add release to GitHub releases
-      - 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
-      # Setup .npmrc file to publish to npm
-      - name: Publish on NPM
-        uses: actions/setup-node@v1
-        with:
-          node-version: "14.x"
-          registry-url: "https://registry.npmjs.org"
-      - run: npm install
-      # Publish to NPM
-      - run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-      # Setup .npmrc file to publish to GitHub Packages
-      - name: Publish on GitHub Packages
-        uses: actions/setup-node@v1
-        with:
-          registry-url: "https://npm.pkg.github.com"
-      # Publish to GitHub Packages
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    build:
+        name: Create Release
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v2
+            # Add release to GitHub releases
+            - 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
+            # Setup .npmrc file to publish to npm
+            - name: Publish on NPM
+              uses: actions/setup-node@v1
+              with:
+                  node-version: "14.x"
+                  registry-url: "https://registry.npmjs.org"
+            - run: npm install
+            # Publish to NPM
+            - run: npm publish --access public
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+            # Setup .npmrc file to publish to GitHub Packages
+            - name: Publish on GitHub Packages
+              uses: actions/setup-node@v1
+              with:
+                  registry-url: "https://npm.pkg.github.com"
+            # Publish to GitHub Packages
+            - run: npm publish
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,21 +1,18 @@
-name: Run Tests on Push
+name: test-on-commit
 on:
     push:
         branches:
-            - master
-            - dev
+            - main
     pull_request:
         branches:
-            - master
-            - dev
+            - main
 jobs:
     test:
         name: Run tests
         runs-on: ubuntu-latest
         strategy:
             matrix:
                 node-version:
-                    - 12.x
                     - 14.x
         steps:
             - uses: actions/checkout@v2
@@ -24,7 +21,6 @@ jobs:
               with:
                   node-version: "${{ matrix.node-version }}"
             - run: npm install
-            - run: npm run build
             - run: npm test
               env:
                   CI: true
diff --git a/.husky/.gitignore b/.husky/.gitignore
@@ -0,0 +1 @@
+_
diff --git a/.huskyrc b/.huskyrc
@@ -0,0 +1,6 @@
+{
+    "hooks": {
+        "pre-commit": "npm start doc; git add ./docs; npm test",
+        "pre-push": "npm test"
+    }
+}
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,5 +1,12 @@
 {
-  "recommendations": [
-    "karyfoundation.nearley"
-  ]
-}
+    "recommendations": [
+      "streetsidesoftware.code-spell-checker",
+      "editorconfig.editorconfig",
+      "esbenp.prettier-vscode",
+      "dbaeumer.vscode-eslint",
+      "amatiasq.sort-imports",
+      "orta.vscode-jest",
+      "christian-kohler.path-intellisense",
+      "karyfoundation.nearley"
+    ]
+  }
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -5,25 +5,30 @@
     "version": "0.2.0",
     "configurations": [
         {
+            "name": "Run in Development Mode",
             "type": "node",
             "request": "launch",
-            "name": "Debug",
-            "program": "${workspaceRoot}/dist/app.js",
-            "smartStep": true,
-            "outFiles": [
-                "../dist/**/*.js"
+            "args": ["${relativeFile}"],
+            "runtimeArgs": [
+                "--nolazy",
+                "-r",
+                "ts-node/register"
             ],
-            "protocol": "inspector",
-            "env": {
-                "NODE_ENV": "production"
-            }
+            "cwd": "${workspaceRoot}",
+            "protocol": "inspector"
         },
         {
+            "name": "vscode-jest-tests",
             "type": "node",
-            "request": "attach",
-            "name": "Nodemon Debug",
-            "port": 9229,
-            "restart": true
+            "request": "launch",
+            "program": "${workspaceFolder}/node_modules/jest/bin/jest",
+            "args": [
+                "--runInBand"
+            ],
+            "cwd": "${workspaceFolder}",
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen",
+            "disableOptimisticBPs": true
         }
     ]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -5,7 +5,6 @@
     "files.exclude": {
         "tsconfig.build.json": true,
     },
-    "importSorter.generalConfiguration.sortOnBeforeSave": true,
     "files.trimTrailingWhitespace": true,
     "editor.formatOnSave": true,
     "editor.defaultFormatter": "esbenp.prettier-vscode"

diff --git a/.vscode/tasks.json b/.vscode/tasks.json