chore: update scripts to version 5

gobstones · Nov 11, 2023 · 0f87679 · 0f87679
1 parent 750a569
commit 0f87679
Show file tree

Hide file tree

Showing 100 changed files with 306 additions and 297 deletions.
diff --git a/.github/workflows/on-tag-release-github.yml b/.github/workflows/on-tag-release-github.yml
@@ -21,6 +21,8 @@ jobs:
               run: npm pkg delete scripts.prepare
             - name: Installing project dependencies
               run: npm install
+            - name: Building the project
+              run: npm run build
             - name: Create Release on GitHub
               uses: ncipollo/release-action@v1
               with:

diff --git a/.github/workflows/on-tag-release-npm.yml b/.github/workflows/on-tag-release-npm.yml
@@ -21,6 +21,8 @@ jobs:
               run: npm pkg delete scripts.prepare
             - name: Installing project dependencies
               run: npm install
+            - name: Building the project
+              run: npm run build
             - name: Publishing to NPM
               uses: JS-DevTools/npm-publish@v3
               with:

diff --git a/.npmignore b/.npmignore
@@ -5,6 +5,7 @@
 .eslintrc.js
 .vscode/*
 .github/*
+.husky/*
 
 # tests
 test/*

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,11 +1,15 @@
-## <small>0.4.4 (2023-11-10)</small>
+## <small>0.4.5 (2023-11-11)</small>
+
+* chore: update scripts to version 5 ([4e2f67d](https://github.com/gobstones/gobstones-core/commit/4e2f67d))
 
-* [PARTIAL] Docs completed for the change. ([1e0864c](https://github.com/gobstones/gobstones-core/commit/1e0864c))
-* [PARTIAL] Docs regenerated ([132eb3c](https://github.com/gobstones/gobstones-core/commit/132eb3c))
-* [PARTIAL] Input name changed, tests updated ([947a16c](https://github.com/gobstones/gobstones-core/commit/947a16c))
-* Fixed, although the casting is now on the constructor... ([fd8eece](https://github.com/gobstones/gobstones-core/commit/fd8eece))
 
 
+## <small>0.4.4 (2023-11-10)</small>
+
+-   [PARTIAL] Docs completed for the change. ([1e0864c](https://github.com/gobstones/gobstones-core/commit/1e0864c))
+-   [PARTIAL] Docs regenerated ([132eb3c](https://github.com/gobstones/gobstones-core/commit/132eb3c))
+-   [PARTIAL] Input name changed, tests updated ([947a16c](https://github.com/gobstones/gobstones-core/commit/947a16c))
+-   Fixed, although the casting is now on the constructor... ([fd8eece](https://github.com/gobstones/gobstones-core/commit/fd8eece))
 
 ## <small>0.4.4 (2023-11-10)</small>
 

diff --git a/docs/classes/Events.EventEmitter.html b/docs/classes/Events.EventEmitter.html
diff --git a/docs/classes/Expectations.Expectation.html b/docs/classes/Expectations.Expectation.html
diff --git a/docs/classes/Expectations.FinishedExpectation.html b/docs/classes/Expectations.FinishedExpectation.html
diff --git a/docs/classes/Expectations.JoinedExpectation.html b/docs/classes/Expectations.JoinedExpectation.html
diff --git a/docs/classes/Expectations.Matchers.html b/docs/classes/Expectations.Matchers.html
diff --git a/docs/classes/GobstonesLang.Board.html b/docs/classes/GobstonesLang.Board.html
diff --git a/docs/classes/GobstonesLang.BoardError.html b/docs/classes/GobstonesLang.BoardError.html
diff --git a/docs/classes/GobstonesLang.Cell.html b/docs/classes/GobstonesLang.Cell.html
diff --git a/docs/classes/GobstonesLang.Color.html b/docs/classes/GobstonesLang.Color.html
diff --git a/docs/classes/GobstonesLang.Direction.html b/docs/classes/GobstonesLang.Direction.html
diff --git a/docs/classes/GobstonesLang.InvalidBoardDescription.html b/docs/classes/GobstonesLang.InvalidBoardDescription.html
diff --git a/docs/classes/GobstonesLang.InvalidCellReading.html b/docs/classes/GobstonesLang.InvalidCellReading.html
diff --git a/docs/classes/GobstonesLang.InvalidSizeChange.html b/docs/classes/GobstonesLang.InvalidSizeChange.html
diff --git a/docs/classes/GobstonesLang.InvalidStonesAmount.html b/docs/classes/GobstonesLang.InvalidStonesAmount.html
diff --git a/docs/classes/GobstonesLang.LocationFallsOutsideBoard.html b/docs/classes/GobstonesLang.LocationFallsOutsideBoard.html
diff --git a/docs/classes/SourceReader.DefinedSourcePosition.html b/docs/classes/SourceReader.DefinedSourcePosition.html
diff --git a/docs/classes/SourceReader.EndOfInputSourcePosition.html b/docs/classes/SourceReader.EndOfInputSourcePosition.html
diff --git a/docs/classes/SourceReader.EndOfStringSourcePosition.html b/docs/classes/SourceReader.EndOfStringSourcePosition.html
diff --git a/docs/classes/SourceReader.ErrorAtEndOfInputBy.html b/docs/classes/SourceReader.ErrorAtEndOfInputBy.html
diff --git a/docs/classes/SourceReader.ErrorAtEndOfStringBy.html b/docs/classes/SourceReader.ErrorAtEndOfStringBy.html
diff --git a/docs/classes/SourceReader.ErrorNoInput.html b/docs/classes/SourceReader.ErrorNoInput.html
diff --git a/docs/classes/SourceReader.ErrorUnmatchingPositionsBy.html b/docs/classes/SourceReader.ErrorUnmatchingPositionsBy.html
diff --git a/docs/classes/SourceReader.KnownSourcePosition.html b/docs/classes/SourceReader.KnownSourcePosition.html
diff --git a/docs/classes/SourceReader.SourcePosition.html b/docs/classes/SourceReader.SourcePosition.html
diff --git a/docs/classes/SourceReader.SourceReader.html b/docs/classes/SourceReader.SourceReader.html
diff --git a/docs/classes/SourceReader.SourceReaderError.html b/docs/classes/SourceReader.SourceReaderError.html
diff --git a/docs/classes/SourceReader.SourceReaderErrorBy.html b/docs/classes/SourceReader.SourceReaderErrorBy.html
diff --git a/docs/classes/SourceReader.StringSourcePosition.html b/docs/classes/SourceReader.StringSourcePosition.html
diff --git a/docs/classes/SourceReader.UnknownSourcePosition.html b/docs/classes/SourceReader.UnknownSourcePosition.html
diff --git a/docs/classes/Translator.Translator.html b/docs/classes/Translator.Translator.html
diff --git a/docs/classes/Types.BiMap.html b/docs/classes/Types.BiMap.html
diff --git a/docs/classes/cli.CLIApp.html b/docs/classes/cli.CLIApp.html
diff --git a/docs/classes/cli.CLICommandBuilder.html b/docs/classes/cli.CLICommandBuilder.html
diff --git a/docs/docs/globals.html b/docs/docs/globals.html
diff --git a/docs/functions/Expectations.and.html b/docs/functions/Expectations.and.html
diff --git a/docs/functions/Expectations.expect.html b/docs/functions/Expectations.expect.html
diff --git a/docs/functions/Expectations.or.html b/docs/functions/Expectations.or.html
diff --git a/docs/functions/Functions.deepEquals.html b/docs/functions/Functions.deepEquals.html
diff --git a/docs/functions/Functions.deepStringAssign.html b/docs/functions/Functions.deepStringAssign.html
diff --git a/docs/functions/Functions.flatten.html b/docs/functions/Functions.flatten.html
diff --git a/docs/functions/Functions.matrix.html b/docs/functions/Functions.matrix.html
diff --git a/docs/functions/Functions.unflatten.html b/docs/functions/Functions.unflatten.html
diff --git a/docs/functions/cli.cli-1.html b/docs/functions/cli.cli-1.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/interfaces/Expectations.IArrayExpectation.html b/docs/interfaces/Expectations.IArrayExpectation.html
diff --git a/docs/interfaces/Expectations.IFinishedExpectation.html b/docs/interfaces/Expectations.IFinishedExpectation.html
diff --git a/docs/interfaces/Expectations.IGenericExpectation.html b/docs/interfaces/Expectations.IGenericExpectation.html
diff --git a/docs/interfaces/Expectations.INumberExpectation.html b/docs/interfaces/Expectations.INumberExpectation.html
diff --git a/docs/interfaces/Expectations.IObjectExpectation.html b/docs/interfaces/Expectations.IObjectExpectation.html
diff --git a/docs/interfaces/Expectations.IStringExpectation.html b/docs/interfaces/Expectations.IStringExpectation.html
diff --git a/docs/interfaces/Expectations.MatcherCall.html b/docs/interfaces/Expectations.MatcherCall.html
diff --git a/docs/interfaces/Functions.FlattenOptions.html b/docs/interfaces/Functions.FlattenOptions.html
diff --git a/docs/interfaces/Functions.UnflattenOptions.html b/docs/interfaces/Functions.UnflattenOptions.html
diff --git a/docs/interfaces/GobstonesLang.BoardDefinition.html b/docs/interfaces/GobstonesLang.BoardDefinition.html
diff --git a/docs/interfaces/GobstonesLang.BoardEvents.html b/docs/interfaces/GobstonesLang.BoardEvents.html
diff --git a/docs/interfaces/GobstonesLang.CellDataDefinition.html b/docs/interfaces/GobstonesLang.CellDataDefinition.html
diff --git a/docs/interfaces/GobstonesLang.CellEvents.html b/docs/interfaces/GobstonesLang.CellEvents.html
diff --git a/docs/interfaces/GobstonesLang.CellInfo.html b/docs/interfaces/GobstonesLang.CellInfo.html
diff --git a/docs/interfaces/SourceReader.SourceReaderLocale.html b/docs/interfaces/SourceReader.SourceReaderLocale.html
diff --git a/docs/interfaces/cli.CLIAppOptions.html b/docs/interfaces/cli.CLIAppOptions.html
diff --git a/docs/interfaces/cli.CLIGeneralFlags.html b/docs/interfaces/cli.CLIGeneralFlags.html
diff --git a/docs/modules/Events.html b/docs/modules/Events.html
diff --git a/docs/modules/Expectations.html b/docs/modules/Expectations.html
diff --git a/docs/modules/Functions.html b/docs/modules/Functions.html
diff --git a/docs/modules/GobstonesLang.html b/docs/modules/GobstonesLang.html
diff --git a/docs/modules/SourceReader.html b/docs/modules/SourceReader.html
diff --git a/docs/modules/Translator.html b/docs/modules/Translator.html
diff --git a/docs/modules/Types.html b/docs/modules/Types.html
diff --git a/docs/modules/cli.html b/docs/modules/cli.html
diff --git a/docs/types/Events.DefaultEventSignature.html b/docs/types/Events.DefaultEventSignature.html
diff --git a/docs/types/Events.EventSignature.html b/docs/types/Events.EventSignature.html
diff --git a/docs/types/GobstonesLang.BoardInfo.html b/docs/types/GobstonesLang.BoardInfo.html
diff --git a/docs/types/GobstonesLang.CellLocation.html b/docs/types/GobstonesLang.CellLocation.html
diff --git a/docs/types/GobstonesLang.CellReadingActionAttempt.html b/docs/types/GobstonesLang.CellReadingActionAttempt.html
diff --git a/docs/types/GobstonesLang.InvalidSizeChangeAttempt.html b/docs/types/GobstonesLang.InvalidSizeChangeAttempt.html
diff --git a/docs/types/GobstonesLang.LocationChangeActionAttempt.html b/docs/types/GobstonesLang.LocationChangeActionAttempt.html
diff --git a/docs/types/GobstonesLang.OnBoardHeadMovedCallback.html b/docs/types/GobstonesLang.OnBoardHeadMovedCallback.html
diff --git a/docs/types/GobstonesLang.OnBoardSizeChangedCallback.html b/docs/types/GobstonesLang.OnBoardSizeChangedCallback.html
diff --git a/docs/types/GobstonesLang.OnCellStonesChanged.html b/docs/types/GobstonesLang.OnCellStonesChanged.html
diff --git a/docs/types/GobstonesLang.StonesChangeActionAttempt.html b/docs/types/GobstonesLang.StonesChangeActionAttempt.html
diff --git a/docs/types/SourceReader.SourceInput.html b/docs/types/SourceReader.SourceInput.html
diff --git a/docs/types/Types.Subset.html b/docs/types/Types.Subset.html
diff --git a/docs/types/cli.cli.html b/docs/types/cli.cli.html
diff --git a/docs/variables/GobstonesLang.identifier.html b/docs/variables/GobstonesLang.identifier.html
diff --git a/docs/variables/GobstonesLang.lowerId.html b/docs/variables/GobstonesLang.lowerId.html
diff --git a/docs/variables/GobstonesLang.nonAlphabeticId.html b/docs/variables/GobstonesLang.nonAlphabeticId.html
diff --git a/docs/variables/GobstonesLang.number.html b/docs/variables/GobstonesLang.number.html
diff --git a/docs/variables/GobstonesLang.sigiledNonAlphabeticId.html b/docs/variables/GobstonesLang.sigiledNonAlphabeticId.html
diff --git a/docs/variables/GobstonesLang.upperId.html b/docs/variables/GobstonesLang.upperId.html
diff --git a/docs/variables/SourceReader.SourceReaderIntl.html b/docs/variables/SourceReader.SourceReaderIntl.html
diff --git a/docs/variables/SourceReader.availableLocales.html b/docs/variables/SourceReader.availableLocales.html
diff --git a/docs/variables/SourceReader.en.html b/docs/variables/SourceReader.en.html
diff --git a/docs/variables/SourceReader.es.html b/docs/variables/SourceReader.es.html
diff --git a/package.json b/package.json
@@ -1,23 +1,19 @@
 {
   "name": "@gobstones/gobstones-core",
-  "version": "0.4.4",
+  "version": "0.4.5",
   "description": "A set of utility types, interfaces and classes that are used through all the Gobstones Platform repositories.",
   "repository": "https://github.com/gobstones/gobstones-core",
   "homepage": "https://gobstones.github.io/gobstones-core",
   "author": "Alan Rodas Bonjour <alanrodas@gmail.com>",
   "license": "AGPL-3.0",
-  "keywords": ["Gobstones", "Library", "Keywords"],
+  "keywords": ["Gobstones", "Library", "Core", "Utilities"],
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "typings": "./dist/typings/index.d.ts",
   "exports": {
     ".": "./dist/index.js"
   },
   "packageManager": "npm@9.2.0",
-  "gobstones-scripts": {
-    "type": "library",
-    "manager": "npm"
-  },
   "scripts": {
     "prepare": "husky install",
     "prepack": "gobstones-scripts run build",
@@ -30,11 +26,17 @@
     "prettify": "gobstones-scripts run prettify",
     "gbs": "gobstones-scripts"
   },
+  "config": {
+    "gobstones-scripts": {
+      "type": "library",
+      "manager": "npm"
+    }
+  },
   "dependencies": {
     "commander": "^11.1.0"
   },
   "devDependencies": {
-    "@gobstones/gobstones-scripts": "^0.4.7",
+    "@gobstones/gobstones-scripts": "^0.5.0",
     "husky": "^8.0.2"
   }
 }
diff --git a/src/GobstonesLang/Board.ts b/src/GobstonesLang/Board.ts
@@ -420,7 +420,7 @@ export class Board extends EventEmitter<BoardEvents> implements BoardDefinition
     /**
      * Obtain the cells of the board as an array of `width` elements, each
      * of which is an array of `height` elements, each of which is a {@link Cell},
-     * or in another sense, a {@link helpers!Matrix} of {@link Cell | Cells}.
+     * or in another sense, a {@link Functions!matrix} of {@link Cell | Cells}.
      *
      * This is retain only for compatibility reasons.
      *

diff --git a/src/Types/index.ts b/src/Types/index.ts
@@ -5,8 +5,7 @@
  * packages should be added here for better accessibility in all packages.
  *
  * This module includes the class {@link BiMap} as a bi-directional map,
- * {@link Matrix} as a bi-dimentional array, and {@link Subset} as a recursive
- * partial type definition.
+ * and {@link Subset} as a recursive partial type definition.
  *
  * @module Types
  * @author Alan Rodas Bonjour <alanrodas@gmail.com>