build: update build to export separated modules for index and cli

By updating the gobstones-scripts dependency and ejecting the rollup configuration, along with changes in the package.json, now a separated cli module is exported. Thi is the module to export only from cli baed applications, and only in the cli part of it. fix #22
gobstones · Nov 23, 2023 · 9f9e32e · 9f9e32e
1 parent e182829
commit 9f9e32e
Show file tree

Hide file tree

Showing 106 changed files with 511 additions and 315 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,11 @@
-## <small>0.4.6 (2023-11-21)</small>
+## <small>0.4.7 (2023-11-23)</small>
+
 
-* build: update gobstones-core to latest version of scripts ([2949b1c](https://github.com/gobstones/gobstones-core/commit/2949b1c)), closes [#19](https://github.com/gobstones/gobstones-core/issues/19)
 
 
+## <small>0.4.6 (2023-11-21)</small>
+
+-   build: update gobstones-core to latest version of scripts ([2949b1c](https://github.com/gobstones/gobstones-core/commit/2949b1c)), closes [#19](https://github.com/gobstones/gobstones-core/issues/19)
 
 ## <small>0.4.6 (2023-11-21)</small>
 

diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js
diff --git a/docs/assets/search.js b/docs/assets/search.js
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/functions/cli.readJSON.html b/docs/functions/cli.readJSON.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/interfaces/cli.CLIGeneralTexts.html b/docs/interfaces/cli.CLIGeneralTexts.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/Types_WithRequired.html b/docs/modules/Types_WithRequired.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/Types_WithRequired.WithRequired.html b/docs/types/Types_WithRequired.WithRequired.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,6 +1,6 @@
 {
   "name": "@gobstones/gobstones-core",
-  "version": "0.4.6",
+  "version": "0.4.7",
   "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",
@@ -11,8 +11,32 @@
   "module": "./dist/esm/index.mjs",
   "typings": "./dist/esm/typings/index.d.ts",
   "exports": {
-    "require": "./dist/cjs/index.cjs",
-    "import": "./dist/esm/index.mjs"
+    ".": {
+      "import": {
+        "types": "./dist/esm/typings/index.d.ts",
+        "default": "./dist/esm/index.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/typings/index.d.ts",
+        "default": "./dist/cjs/index.cjs"
+      }
+    },
+    "./cli": {
+      "import": {
+        "types": "./dist/esm/cli/typings/cli.d.ts",
+        "default": "./dist/esm/cli/cli.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/cli/typings/cli.d.ts",
+        "default": "./dist/cjs/cli/cli.cjs"
+      }
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "cli": ["./dist/esm/typings/cli.d.ts"],
+      ".": ["./dist/esm/typings/index.d.ts"]
+    }
   },
   "packageManager": "[email protected]",
   "scripts": {
@@ -37,7 +61,7 @@
     "commander": "^11.1.0"
   },
   "devDependencies": {
-    "@gobstones/gobstones-scripts": "^0.5.3",
+    "@gobstones/gobstones-scripts": "^0.5.4",
     "husky": "^8.0.2"
   }
 }
diff --git a/rollup.config.js b/rollup.config.js
@@ -0,0 +1,60 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const fs = require('fs');
+
+const commonjs = require('@rollup/plugin-commonjs');
+const typescript = require('@rollup/plugin-typescript');
+
+const { config } = require('@gobstones/gobstones-scripts');
+
+const packageJson = JSON.parse(fs.readFileSync('./package.json').toString());
+
+export default [
+    {
+        input: 'src/index.ts',
+        output: [
+            {
+                sourcemap: true,
+                file: packageJson.exports['.'].import.default,
+                format: 'esm'
+            },
+            {
+                sourcemap: true,
+                file: packageJson.exports['.'].require.default,
+                format: 'cjs'
+            }
+        ],
+        preserveSymlinks: true,
+        plugins: [
+            typescript({
+                tsconfig: config.configurationFiles[config.loadedOptions.type].tsConfigFile,
+                declarationDir: './typings'
+            }),
+            commonjs()
+        ],
+        external: [/@gobstones\/.*/]
+    },
+    {
+        input: 'src/cli.ts',
+        output: [
+            {
+                sourcemap: true,
+                file: packageJson.exports['./cli'].import.default,
+                format: 'esm'
+            },
+            {
+                sourcemap: true,
+                file: packageJson.exports['./cli'].require.default,
+                format: 'cjs'
+            }
+        ],
+        preserveSymlinks: true,
+        plugins: [
+            typescript({
+                tsconfig: config.configurationFiles[config.loadedOptions.type].tsConfigFile,
+                declarationDir: './typings'
+            }),
+            commonjs()
+        ],
+        external: [/@gobstones\/.*/, 'commander', 'fs']
+    }
+];
diff --git a/src/Translations/Translator.ts b/src/Translations/Translator.ts
@@ -5,11 +5,11 @@
 import { flatten } from '../Functions/flatten';
 
 /**
- * A Translation consist of an object that hold the state of the current
+ * A Translator consist of an object that hold the state of the current
  * locale being used, and allows for switching between different locales
  * and obtain translated strings.
  *
- * The translation expects a locale to be given as the language definition,
+ * The translator expects a locale to be given as the language definition,
  * and, if constructed with the flatten options, flattens it to allow
  * dot notation access to the different strings in the locale object.
  *

diff --git a/src/Types/WithRequired.ts b/src/Types/WithRequired.ts
@@ -0,0 +1,23 @@
+/**
+ * A type modifier that allows to construct a generic type that
+ * requires only one property of a given type.
+ *
+ * @example
+ * Conider that we have a type
+ * ```
+ * type User = {
+ *    id: string
+ *    name?: string
+ *    email?: string
+ * }
+ * ```
+ *
+ * Then we can create a type like so:
+ * ```
+ * type UserWithName = WithRequired<User, 'name'>
+ * ```
+ *
+ * @param T The base type.
+ * @param K the name of the property to require in the new type.
+ */
+export type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] };
diff --git a/src/Types/index.ts b/src/Types/index.ts
@@ -13,4 +13,4 @@
 
 export * from './BiMap';
 export * from './Subset';
-export * from '../Functions/deepStringAssign';
+export * from './WithRequired';
diff --git a/src/cli.ts b/src/cli.ts
@@ -12,8 +12,36 @@
 import commander, { program } from 'commander';
 
 import { Translator } from './Translations';
+import { WithRequired } from './Types';
 import fs from 'fs';
 
+/**
+ * The general texts that a CLI app uses.
+ * This include the description texts (Or a description key if a {@link Translator} is provided)
+ * that are used a the description of the different parts of the CLI.
+ * The `name` and the `versionNumber` are expected to be the app name (No translation
+ * is used, as the name should be the same through all the app), and the `versionNumber`
+ * should be the version is the major.minor.patch.
+ *
+ * @group API: Options
+ */
+export interface CLIGeneralTexts {
+    /** The application name */
+    name: string;
+    /** The application version number in semVer */
+    versionNumber: string;
+    /** A text displayed when showing the application's help */
+    help: string;
+    /** The language used by the application */
+    language?: string;
+    /** The error message displayed when using a wrong language */
+    languageError?: string;
+    /** Text used by the tool */
+    tool: string;
+    /** The text displayed when showing the version of the application */
+    version: string;
+}
+
 /**
  * The general flags that a CLI app accepts, when configured to used them.
  * Note that currently the default flags cannot be changed.
@@ -47,22 +75,14 @@ export interface CLIAppOptions {
      * is used, as the name should be the same through all the app), and the `versionNumber`
      * should be the version is the major.minor.patch.
      */
-    texts: {
-        name: string;
-        versionNumber: string;
-        help: string;
-        language?: string;
-        languageError?: string;
-        tool: string;
-        version: string;
-    };
+    texts: CLIGeneralTexts;
 
     /**
      * A {@link Translator} used to translate the tool to different locales, both when
      * called with a language flag, and automatically at startup by auto-detecting
      * the user language by checking OS Environment variables.
      */
-    translator?: Translator<any>;
+    translator?: Translator<Record<string, any>>;
 
     /**
      * The flag names to use in this application, if the flags differ in any way from
@@ -75,7 +95,7 @@ export interface CLIAppOptions {
      * * input file for a command: -i, --in
      * * output file for a command: -o, --out
      */
-    flags: CLIGeneralFlags;
+    flags?: CLIGeneralFlags;
 }
 
 /**
@@ -101,20 +121,16 @@ export class CLICommandBuilder {
     protected currentArgs: any[];
     protected currentOptions: any;
     protected onReadErrorMsg: string;
-    protected options: CLIAppOptions;
+    protected options: WithRequired<CLIAppOptions, 'flags'>;
     protected isSubcommand: boolean;
 
     public constructor(
         cmdrProgram: commander.Command,
         options: CLIAppOptions,
         isSubcommand: boolean = false
     ) {
-        this.program = cmdrProgram;
-        this.options = Object.assign({}, options);
-        this.isSubcommand = isSubcommand;
-
         // Set default flags, or use custom ones
-        this.options.flags = options.flags ?? {
+        const defaultFlags = {
             help: {
                 short: CLICommandBuilder.SHORT_HELP_FLAG,
                 long: CLICommandBuilder.LONG_HELP_FLAG
@@ -136,6 +152,13 @@ export class CLICommandBuilder {
                 long: CLICommandBuilder.LONG_OUTPUT_FLAG
             }
         };
+
+        this.program = cmdrProgram;
+        this.options = Object.assign({ ...defaultFlags }, options) as WithRequired<
+            CLIAppOptions,
+            'flags'
+        >;
+        this.isSubcommand = isSubcommand;
     }
 
     /**
@@ -508,3 +531,20 @@ export type cli = CLIApp;
  * @group API: Main
  */
 export const cli = (options: CLIAppOptions): CLIApp => new CLIApp(options);
+
+/**
+ * Retrieves an object with the data from a JSON file
+ * after reading the same from the command line.
+ * This function is useful here as most times you will
+ * want to retrieve data from the package.json file.
+ *
+ * @param fileLocation The location of the file to read.
+ */
+export function readJSON(fileLocation: string): any {
+    try {
+        const fileContents = fs.readFileSync(fileLocation);
+        return JSON.parse(fileContents.toString());
+    } catch {
+        return {};
+    }
+}