Skip to content

Commit

Permalink
refactor: rename folders to match guidelines
Browse files Browse the repository at this point in the history
Now all folders follows the criteria stablished in guidelines. Different libraries have been
updated, and the version ha moved to 0.5.0
  • Loading branch information
alanrodas committed Apr 6, 2024
1 parent c4cb89c commit fd1c235
Show file tree
Hide file tree
Showing 152 changed files with 224 additions and 5,663 deletions.
151 changes: 150 additions & 1 deletion CHANGELOG.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/assets/navigation.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/assets/search.js

Large diffs are not rendered by default.

88 changes: 0 additions & 88 deletions docs/classes/CLI.CLIApp.html

This file was deleted.

80 changes: 0 additions & 80 deletions docs/classes/CLI.CLICommandBuilder.html

This file was deleted.

86 changes: 0 additions & 86 deletions docs/classes/Events.EventEmitter.html

This file was deleted.

20 changes: 0 additions & 20 deletions docs/classes/Expectations.FinishedExpectation.html

This file was deleted.

28 changes: 0 additions & 28 deletions docs/classes/Expectations.JoinedExpectation.html

This file was deleted.

88 changes: 0 additions & 88 deletions docs/classes/Expectations.Matchers.html

This file was deleted.

126 changes: 0 additions & 126 deletions docs/classes/Expectations_Expectation.Expectation.html

This file was deleted.

460 changes: 0 additions & 460 deletions docs/classes/GobstonesLang.Board.html

This file was deleted.

8 changes: 0 additions & 8 deletions docs/classes/GobstonesLang.BoardError.html

This file was deleted.

270 changes: 0 additions & 270 deletions docs/classes/GobstonesLang.Cell.html

This file was deleted.

101 changes: 0 additions & 101 deletions docs/classes/GobstonesLang.Color.html

This file was deleted.

136 changes: 0 additions & 136 deletions docs/classes/GobstonesLang.Direction.html

This file was deleted.

13 changes: 0 additions & 13 deletions docs/classes/GobstonesLang.InvalidBoardDescription.html

This file was deleted.

11 changes: 0 additions & 11 deletions docs/classes/GobstonesLang.InvalidCellReading.html

This file was deleted.

17 changes: 0 additions & 17 deletions docs/classes/GobstonesLang.InvalidSizeChange.html

This file was deleted.

15 changes: 0 additions & 15 deletions docs/classes/GobstonesLang.InvalidStonesAmount.html

This file was deleted.

13 changes: 0 additions & 13 deletions docs/classes/GobstonesLang.LocationFallsOutsideBoard.html

This file was deleted.

310 changes: 0 additions & 310 deletions docs/classes/SourceReader.AbstractDocumentSourcePosition.html

This file was deleted.

291 changes: 0 additions & 291 deletions docs/classes/SourceReader.AbstractKnownSourcePosition.html

This file was deleted.

193 changes: 0 additions & 193 deletions docs/classes/SourceReader.AbstractSourcePosition.html

This file was deleted.

275 changes: 0 additions & 275 deletions docs/classes/SourceReader.DocumentSourcePosition.html

This file was deleted.

299 changes: 0 additions & 299 deletions docs/classes/SourceReader.EndOfDocumentSourcePosition.html

This file was deleted.

281 changes: 0 additions & 281 deletions docs/classes/SourceReader.EndOfInputSourcePosition.html

This file was deleted.

11 changes: 0 additions & 11 deletions docs/classes/SourceReader.InvalidOperationAtEODError.html

This file was deleted.

11 changes: 0 additions & 11 deletions docs/classes/SourceReader.InvalidOperationAtEOIError.html

This file was deleted.

This file was deleted.

13 changes: 0 additions & 13 deletions docs/classes/SourceReader.MismatchedInputsError.html

This file was deleted.

6 changes: 0 additions & 6 deletions docs/classes/SourceReader.NoInputError.html

This file was deleted.

314 changes: 0 additions & 314 deletions docs/classes/SourceReader.SourceReader.html

This file was deleted.

11 changes: 0 additions & 11 deletions docs/classes/SourceReader.SourceReaderError.html

This file was deleted.

205 changes: 0 additions & 205 deletions docs/classes/SourceReader.UnknownSourcePosition.html

This file was deleted.

63 changes: 0 additions & 63 deletions docs/classes/Translator.Translator.html

This file was deleted.

119 changes: 0 additions & 119 deletions docs/classes/Types.BiMap.html

This file was deleted.

6 changes: 3 additions & 3 deletions docs/docs/globals.html

Large diffs are not rendered by default.

4 changes: 0 additions & 4 deletions docs/functions/CLI.cli-1.html

This file was deleted.

7 changes: 0 additions & 7 deletions docs/functions/CLI.readJSON.html

This file was deleted.

7 changes: 0 additions & 7 deletions docs/functions/Expectations.and.html

This file was deleted.

57 changes: 0 additions & 57 deletions docs/functions/Expectations.expect.html

This file was deleted.

7 changes: 0 additions & 7 deletions docs/functions/Expectations.or.html

This file was deleted.

39 changes: 0 additions & 39 deletions docs/functions/Functions.deepEquals.html

This file was deleted.

27 changes: 0 additions & 27 deletions docs/functions/Functions.deepStringAssign.html

This file was deleted.

13 changes: 0 additions & 13 deletions docs/functions/Functions.flatten.html

This file was deleted.

10 changes: 0 additions & 10 deletions docs/functions/Functions.matrix.html

This file was deleted.

12 changes: 0 additions & 12 deletions docs/functions/Functions.unflatten.html

This file was deleted.

6 changes: 3 additions & 3 deletions docs/index.html

Large diffs are not rendered by default.

25 changes: 0 additions & 25 deletions docs/interfaces/CLI.CLIAppOptions.html

This file was deleted.

14 changes: 0 additions & 14 deletions docs/interfaces/CLI.CLIGeneralFlags.html

This file was deleted.

22 changes: 0 additions & 22 deletions docs/interfaces/CLI.CLIGeneralTexts.html

This file was deleted.

58 changes: 0 additions & 58 deletions docs/interfaces/Expectations.IArrayExpectation.html

This file was deleted.

47 changes: 0 additions & 47 deletions docs/interfaces/Expectations.IBooleanExpectation.html

This file was deleted.

18 changes: 0 additions & 18 deletions docs/interfaces/Expectations.IFinishedExpectation.html

This file was deleted.

46 changes: 0 additions & 46 deletions docs/interfaces/Expectations.IGenericExpectation.html

This file was deleted.

62 changes: 0 additions & 62 deletions docs/interfaces/Expectations.INumberExpectation.html

This file was deleted.

57 changes: 0 additions & 57 deletions docs/interfaces/Expectations.IObjectExpectation.html

This file was deleted.

51 changes: 0 additions & 51 deletions docs/interfaces/Expectations.IStringExpectation.html

This file was deleted.

7 changes: 0 additions & 7 deletions docs/interfaces/Expectations.MatcherCall.html

This file was deleted.

11 changes: 0 additions & 11 deletions docs/interfaces/Functions.FlattenOptions.html

This file was deleted.

11 changes: 0 additions & 11 deletions docs/interfaces/Functions.UnflattenOptions.html

This file was deleted.

29 changes: 0 additions & 29 deletions docs/interfaces/GobstonesLang.BoardDefinition.html

This file was deleted.

6 changes: 0 additions & 6 deletions docs/interfaces/GobstonesLang.BoardEvents.html

This file was deleted.

11 changes: 0 additions & 11 deletions docs/interfaces/GobstonesLang.CellDataDefinition.html

This file was deleted.

5 changes: 0 additions & 5 deletions docs/interfaces/GobstonesLang.CellEvents.html

This file was deleted.

13 changes: 0 additions & 13 deletions docs/interfaces/GobstonesLang.CellInfo.html

This file was deleted.

201 changes: 0 additions & 201 deletions docs/interfaces/SourceReader.SourcePosition.html

This file was deleted.

16 changes: 0 additions & 16 deletions docs/modules/CLI.html

This file was deleted.

19 changes: 0 additions & 19 deletions docs/modules/Events.html

This file was deleted.

51 changes: 0 additions & 51 deletions docs/modules/Expectations.html

This file was deleted.

3 changes: 0 additions & 3 deletions docs/modules/Expectations_Expectation.html

This file was deleted.

14 changes: 0 additions & 14 deletions docs/modules/Functions.html

This file was deleted.

52 changes: 0 additions & 52 deletions docs/modules/GobstonesLang.html

This file was deleted.

59 changes: 0 additions & 59 deletions docs/modules/SourceReader.html

This file was deleted.

12 changes: 0 additions & 12 deletions docs/modules/Translator.html

This file was deleted.

12 changes: 0 additions & 12 deletions docs/modules/Types.html

This file was deleted.

3 changes: 0 additions & 3 deletions docs/types/CLI.cli.html

This file was deleted.

6 changes: 0 additions & 6 deletions docs/types/Events.DefaultEventSignature.html

This file was deleted.

6 changes: 0 additions & 6 deletions docs/types/Events.EventSignature.html

This file was deleted.

14 changes: 0 additions & 14 deletions docs/types/GobstonesLang.BoardInfo.html

This file was deleted.

5 changes: 0 additions & 5 deletions docs/types/GobstonesLang.CellLocation.html

This file was deleted.

3 changes: 0 additions & 3 deletions docs/types/GobstonesLang.CellReadingActionAttempt.html

This file was deleted.

3 changes: 0 additions & 3 deletions docs/types/GobstonesLang.InvalidSizeChangeAttempt.html

This file was deleted.

3 changes: 0 additions & 3 deletions docs/types/GobstonesLang.LocationChangeActionAttempt.html

This file was deleted.

12 changes: 0 additions & 12 deletions docs/types/GobstonesLang.OnBoardHeadMovedCallback.html

This file was deleted.

21 changes: 0 additions & 21 deletions docs/types/GobstonesLang.OnBoardSizeChangedCallback.html

This file was deleted.

13 changes: 0 additions & 13 deletions docs/types/GobstonesLang.OnCellStonesChanged.html

This file was deleted.

3 changes: 0 additions & 3 deletions docs/types/GobstonesLang.StonesChangeActionAttempt.html

This file was deleted.

26 changes: 0 additions & 26 deletions docs/types/SourceReader.SourceInput.html

This file was deleted.

8 changes: 0 additions & 8 deletions docs/types/Types.Subset.html

This file was deleted.

12 changes: 0 additions & 12 deletions docs/types/Types.WithRequired.html

This file was deleted.

6 changes: 0 additions & 6 deletions docs/variables/GobstonesLang.identifier.html

This file was deleted.

7 changes: 0 additions & 7 deletions docs/variables/GobstonesLang.lowerId.html

This file was deleted.

8 changes: 0 additions & 8 deletions docs/variables/GobstonesLang.nonAlphabeticId.html

This file was deleted.

3 changes: 0 additions & 3 deletions docs/variables/GobstonesLang.number.html

This file was deleted.

9 changes: 0 additions & 9 deletions docs/variables/GobstonesLang.sigiledNonAlphabeticId.html

This file was deleted.

7 changes: 0 additions & 7 deletions docs/variables/GobstonesLang.upperId.html

This file was deleted.

5 changes: 0 additions & 5 deletions docs/variables/SourceReader.SourcePositions.html

This file was deleted.

10 changes: 2 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,13 @@
"packageManager": "[email protected]",
"scripts": {
"prepare": "is-ci || husky install",
"prepack": "gobstones-scripts run build",
"prepack": "npm start build",
"start": "gobstones-scripts run",
"dev": "gobstones-scripts run dev",
"build": "gobstones-scripts run build",
"test": "gobstones-scripts run test",
"doc": "gobstones-scripts run doc",
"lint": "gobstones-scripts run lint",
"prettify": "gobstones-scripts run prettify",
"gbs": "gobstones-scripts"
},
"config": {
"gobstones-scripts": {
"type": "library",
"type": "cliLibrary",
"manager": "npm"
}
},
Expand Down
60 changes: 0 additions & 60 deletions rollup.config.js

This file was deleted.

50 changes: 0 additions & 50 deletions src/Translations/index.ts

This file was deleted.

3 changes: 1 addition & 2 deletions src/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@
* multiple languages, input and output from and to files as well
* as stdout, and other perks.
*
* @module API.CLI
* @author Alan Rodas Bonjour <[email protected]>
*
* @module CLI
*/
import fs from 'fs';

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* *****************************************************************************
*/
/**
* @module Expectations
* @module API.Expectations
* @author Alan Rodas Bonjour <[email protected]>
*/
import { AbstractFinishedExpectation } from './AbstractFinishedExpectation';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ import { FinishedExpectation } from '../interfaces';
* joiner function. A JoinedExpectation implements {@link AbstractFinishedExpectation},
* where the result is calculated using the given joiner function.
*
* Currently two join forms are provided, {@link Expectations!and},
* and {@link Expectations!or}.
* Currently two join forms are provided, {@link expect!and},
* and {@link expect!or}.
*
* @group API: Types
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Expectations/expect.ts → src/expectations/expect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* *****************************************************************************
*/
/**
* @module Expectations
* @module API.Expectations
* @author Alan Rodas Bonjour <[email protected]>
*/
import { FullExpectation } from './classes/FullExpectation';
Expand Down
6 changes: 3 additions & 3 deletions src/Expectations/index.ts → src/expectations/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,10 @@ expect(x+y).toBeGreaterThan(z)
* `expect(x).toBe(y)` calls the {@link Matchers.toBe} with `x` as `actual` argument
* and `y` as `expected` argument.
*
* Once the first matcher is called over an expectation, a {@link IFinishedExpectation}
* Once the first matcher is called over an expectation, a {@link FinishedExpectation}
* is obtained. A finished matcher has a result, that may be one of `true`
* (if the matcher was satisfied) or `false` if not. A finished matcher may be
* queried for the result, by calling {@link IFinishedExpectation.getResult | getResult},
* queried for the result, by calling {@link FinishedExpectation.getResult | getResult},
* but additional helper methods are provided by the interface in order to fulfill
* different needs, such as throwing an error if the expectation was not satisfied,
* or calling a function if it was.
Expand All @@ -71,7 +71,7 @@ expect(x+y).toBeGreaterThan(z)
* matcher would be calculated as an "and" over all the results. e.g.
* `expect(x).toBeGreaterThan(y).toBeLowerThan(z)`. This creates a new expectations
* that is satisfied only when both parts (x being greater than y, and x being
* lower than z) are true. This itself returns a new {@link IFinishedExpectation},
* lower than z) are true. This itself returns a new {@link FinishedExpectation},
* that can be extended with new matchers, or queried about the results as
* previously mentioned.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,13 @@ export interface Expectation<T> {
/**
* Answers if the actual value is the same as expected, using strict compare.
* Do not use toBe with floating point numbers, use
* {@link Expectations!Matchers.toBeCloseTo} instead.
* {@link Matchers.toBeCloseTo} instead.
*/
toBe(value: T): this & FinishedExpectation;
/**
* Answers if the actual value is the same as expected, using a deep compare mechanism.
* Do not use toBeLike with floating point numbers, use
* {@link Expectations!Matchers.toBeCloseTo} instead.
* {@link Matchers.toBeCloseTo} instead.
*/
toBeLike(value: T): this & FinishedExpectation;
/**
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion src/gobstones-lang/Board.ts
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,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 Functions!matrix} of {@link Cell | Cells}.
* or in another sense, a {@link API.Functions!matrix} of {@link Cell | Cells}.
*
* This is retain only for compatibility reasons.
*
Expand Down
2 changes: 1 addition & 1 deletion src/source-reader/SourceReader.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* @module API.SourceReader
* @author Pablo E. --Fidel-- Martínez López, <[email protected]>
*/
import { SourcePosition, SourcePositions } from './SourcePositions';
import { SourcePosition, SourcePositions } from './source-positions';
import { InvalidOperationAtEODError, InvalidOperationAtEOIError, NoInputError } from './SourceReaderErrors';

import { and, expect } from '../expectations';
Expand Down
2 changes: 1 addition & 1 deletion src/source-reader/SourceReaderErrors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
*/
/**
* The superclass for all {@link SourceReader} errors.
* It provides internationalization of error messages through a {@link Translator}.
* It provides internationalization of error messages through a {@link API.Translator!Translator}.
* It also restores the prototype chain.
*
* @group API: Main
Expand Down
2 changes: 1 addition & 1 deletion src/source-reader/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,5 +80,5 @@
* @module SourceReader
*/
export * from './SourceReader';
export { SourcePosition } from './SourcePositions';
export { SourcePosition } from './source-positions';
export * from './SourceReaderErrors';
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* *****************************************************************************
*/
/**
* @module SourceReader
* @module API.SourceReader
* @author Alan Rodas Bonjour <[email protected]>
*/
import { AbstractSourcePosition } from './AbstractSourcePosition';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* *****************************************************************************
*/
/**
* @module SourceReader
* @module API.SourceReader
* @author Alan Rodas Bonjour <[email protected]>
*/
export * from './SourcePosition';
Expand Down
41 changes: 0 additions & 41 deletions src/source-reader/translations/SourceReaderLocale.ts

This file was deleted.

37 changes: 0 additions & 37 deletions src/source-reader/translations/SourceReaderLocaleEN.ts

This file was deleted.

37 changes: 0 additions & 37 deletions src/source-reader/translations/SourceReaderLocaleES.ts

This file was deleted.

Loading

0 comments on commit fd1c235

Please sign in to comment.