@decaf-ts/utils 0.2.12 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +21 -157
- package/README.md +403 -12
- package/bin/build-scripts.cjs +236 -52
- package/bin/tag-release.cjs +168 -47
- package/bin/update-scripts.cjs +207 -47
- package/dist/utils.cjs +364 -70
- package/dist/utils.esm.cjs +364 -70
- package/lib/cli/command.cjs +2 -2
- package/lib/cli/command.d.ts +1 -1
- package/lib/cli/commands/build-scripts.cjs +8 -6
- package/lib/cli/constants.cjs +3 -1
- package/lib/cli/constants.d.ts +2 -0
- package/lib/cli/types.cjs +1 -1
- package/lib/cli/types.d.ts +2 -0
- package/lib/esm/bin/build-scripts.js +2 -2
- package/lib/esm/bin/tag-release.js +2 -2
- package/lib/esm/bin/update-scripts.js +2 -2
- package/lib/esm/cli/command.d.ts +1 -1
- package/lib/esm/cli/command.js +7 -7
- package/lib/esm/cli/commands/build-scripts.js +11 -9
- package/lib/esm/cli/commands/index.js +4 -4
- package/lib/esm/cli/commands/tag-release.js +5 -5
- package/lib/esm/cli/commands/update-scripts.js +4 -4
- package/lib/esm/cli/constants.d.ts +2 -0
- package/lib/esm/cli/constants.js +3 -1
- package/lib/esm/cli/index.js +4 -4
- package/lib/esm/cli/types.d.ts +2 -0
- package/lib/esm/cli/types.js +1 -1
- package/lib/esm/index.d.ts +4 -4
- package/lib/esm/index.js +10 -10
- package/lib/esm/input/index.js +3 -3
- package/lib/esm/input/input.d.ts +65 -19
- package/lib/esm/input/input.js +61 -22
- package/lib/esm/input/types.d.ts +7 -7
- package/lib/esm/input/types.js +1 -1
- package/lib/esm/output/common.d.ts +2 -0
- package/lib/esm/output/common.js +4 -1
- package/lib/esm/output/index.js +2 -2
- package/lib/esm/utils/constants.d.ts +12 -6
- package/lib/esm/utils/constants.js +13 -7
- package/lib/esm/utils/environment.d.ts +13 -0
- package/lib/esm/utils/environment.js +16 -3
- package/lib/esm/utils/fs.d.ts +111 -5
- package/lib/esm/utils/fs.js +114 -8
- package/lib/esm/utils/http.d.ts +1 -1
- package/lib/esm/utils/http.js +2 -2
- package/lib/esm/utils/index.js +8 -8
- package/lib/esm/utils/md.d.ts +15 -15
- package/lib/esm/utils/md.js +1 -1
- package/lib/esm/utils/tests.d.ts +26 -3
- package/lib/esm/utils/tests.js +40 -2
- package/lib/esm/utils/text.d.ts +33 -7
- package/lib/esm/utils/text.js +34 -8
- package/lib/esm/utils/timeout.d.ts +11 -0
- package/lib/esm/utils/timeout.js +12 -1
- package/lib/esm/utils/types.d.ts +33 -2
- package/lib/esm/utils/types.js +1 -1
- package/lib/esm/utils/utils.d.ts +44 -2
- package/lib/esm/utils/utils.js +23 -5
- package/lib/esm/utils/web.d.ts +3 -2
- package/lib/esm/utils/web.js +4 -3
- package/lib/esm/writers/OutputWriter.d.ts +2 -2
- package/lib/esm/writers/OutputWriter.js +1 -1
- package/lib/esm/writers/RegexpOutputWriter.d.ts +51 -10
- package/lib/esm/writers/RegexpOutputWriter.js +53 -12
- package/lib/esm/writers/StandardOutputWriter.d.ts +49 -10
- package/lib/esm/writers/StandardOutputWriter.js +51 -12
- package/lib/esm/writers/index.js +5 -5
- package/lib/esm/writers/types.d.ts +2 -2
- package/lib/esm/writers/types.js +1 -1
- package/lib/index.cjs +5 -5
- package/lib/index.d.ts +4 -4
- package/lib/input/input.cjs +61 -22
- package/lib/input/input.d.ts +65 -19
- package/lib/input/types.cjs +1 -1
- package/lib/input/types.d.ts +7 -7
- package/lib/output/common.cjs +4 -1
- package/lib/output/common.d.ts +2 -0
- package/lib/utils/constants.cjs +13 -7
- package/lib/utils/constants.d.ts +12 -6
- package/lib/utils/environment.cjs +14 -1
- package/lib/utils/environment.d.ts +13 -0
- package/lib/utils/fs.cjs +112 -6
- package/lib/utils/fs.d.ts +111 -5
- package/lib/utils/http.cjs +2 -2
- package/lib/utils/http.d.ts +1 -1
- package/lib/utils/md.cjs +1 -1
- package/lib/utils/md.d.ts +15 -15
- package/lib/utils/tests.cjs +39 -1
- package/lib/utils/tests.d.ts +26 -3
- package/lib/utils/text.cjs +34 -8
- package/lib/utils/text.d.ts +33 -7
- package/lib/utils/timeout.cjs +12 -1
- package/lib/utils/timeout.d.ts +11 -0
- package/lib/utils/types.cjs +1 -1
- package/lib/utils/types.d.ts +33 -2
- package/lib/utils/utils.cjs +21 -3
- package/lib/utils/utils.d.ts +44 -2
- package/lib/utils/web.cjs +4 -3
- package/lib/utils/web.d.ts +3 -2
- package/lib/writers/OutputWriter.cjs +1 -1
- package/lib/writers/OutputWriter.d.ts +2 -2
- package/lib/writers/RegexpOutputWriter.cjs +52 -11
- package/lib/writers/RegexpOutputWriter.d.ts +51 -10
- package/lib/writers/StandardOutputWriter.cjs +50 -11
- package/lib/writers/StandardOutputWriter.d.ts +49 -10
- package/lib/writers/types.cjs +1 -1
- package/lib/writers/types.d.ts +2 -2
- package/package.json +2 -2
package/lib/input/types.d.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* to apply color styling to text or chain multiple color operations.
|
|
5
5
|
*
|
|
6
6
|
* @interface Color
|
|
7
|
-
* @memberOf module
|
|
7
|
+
* @memberOf module:utils
|
|
8
8
|
* */
|
|
9
9
|
export interface Color {
|
|
10
10
|
/**
|
|
@@ -25,7 +25,7 @@ export interface Color {
|
|
|
25
25
|
* and text styles to strings in terminal output.
|
|
26
26
|
*
|
|
27
27
|
* @interface Kleur
|
|
28
|
-
* @memberOf module
|
|
28
|
+
* @memberOf module:utils
|
|
29
29
|
*/
|
|
30
30
|
export interface Kleur {
|
|
31
31
|
/** @description Applies black color to the text. */
|
|
@@ -89,7 +89,7 @@ export interface Kleur {
|
|
|
89
89
|
* @property {boolean} [multiple] - Whether the option can be specified multiple times.
|
|
90
90
|
* @property {string} [short] - The short (single-character) alias for the option.
|
|
91
91
|
* @property {string | boolean | string[] | boolean[]} [default] - The default value(s) for the option.
|
|
92
|
-
* @memberOf
|
|
92
|
+
* @memberOf module:utils
|
|
93
93
|
*/
|
|
94
94
|
export interface ParseArgsOptionConfig {
|
|
95
95
|
type: "string" | "boolean";
|
|
@@ -101,7 +101,7 @@ export interface ParseArgsOptionConfig {
|
|
|
101
101
|
* @description Configuration for all command-line argument options.
|
|
102
102
|
* @summary A mapping of long option names to their configurations.
|
|
103
103
|
* @interface ParseArgsOptionsConfig
|
|
104
|
-
* @memberOf
|
|
104
|
+
* @memberOf module:utils
|
|
105
105
|
*/
|
|
106
106
|
export interface ParseArgsOptionsConfig {
|
|
107
107
|
[longOption: string]: ParseArgsOptionConfig;
|
|
@@ -110,7 +110,7 @@ export interface ParseArgsOptionsConfig {
|
|
|
110
110
|
* @description Represents a parsed command-line option token.
|
|
111
111
|
* @summary Can be either an option with a value or an option without a value.
|
|
112
112
|
* @typedef {Object} OptionToken
|
|
113
|
-
* @memberOf
|
|
113
|
+
* @memberOf module:utils
|
|
114
114
|
*/
|
|
115
115
|
export type OptionToken = {
|
|
116
116
|
kind: "option";
|
|
@@ -131,7 +131,7 @@ export type OptionToken = {
|
|
|
131
131
|
* @description Represents a parsed command-line token.
|
|
132
132
|
* @summary Can be an option, a positional argument, or an option terminator.
|
|
133
133
|
* @typedef {OptionToken | Object} Token
|
|
134
|
-
* @memberOf
|
|
134
|
+
* @memberOf module:utils
|
|
135
135
|
*/
|
|
136
136
|
export type Token = OptionToken | {
|
|
137
137
|
kind: "positional";
|
|
@@ -148,7 +148,7 @@ export type Token = OptionToken | {
|
|
|
148
148
|
* @property {string | boolean | string[] | boolean[] | undefined} values - Parsed option values.
|
|
149
149
|
* @property {string[]} positionals - Positional arguments.
|
|
150
150
|
* @property {Token[]} [tokens] - Parsed tokens (if requested).
|
|
151
|
-
* @memberOf
|
|
151
|
+
* @memberOf module:utils
|
|
152
152
|
*/
|
|
153
153
|
export type ParseArgsResult = {
|
|
154
154
|
values: {
|
package/lib/output/common.cjs
CHANGED
|
@@ -10,6 +10,7 @@ const styled_string_builder_1 = require("styled-string-builder");
|
|
|
10
10
|
/**
|
|
11
11
|
* @description Array of ANSI color codes for banner styling.
|
|
12
12
|
* @summary Defines a set of ANSI color codes used to style the banner text.
|
|
13
|
+
* @memberOf module:utils
|
|
13
14
|
*/
|
|
14
15
|
const colors = [
|
|
15
16
|
"\x1b[38;5;215m", // soft orange
|
|
@@ -26,6 +27,7 @@ const colors = [
|
|
|
26
27
|
* @description Prints a styled banner to the console.
|
|
27
28
|
* @summary Generates and prints a colorful ASCII art banner with a random slogan.
|
|
28
29
|
* @param {Logger} [logger] - Optional logger for verbose output.
|
|
30
|
+
* @memberOf module:utils
|
|
29
31
|
* @function printBanner
|
|
30
32
|
* @mermaid
|
|
31
33
|
* sequenceDiagram
|
|
@@ -68,6 +70,7 @@ function printBanner(logger) {
|
|
|
68
70
|
* @param {number} [i] - Optional index to retrieve a specific slogan.
|
|
69
71
|
* @return {string} The selected slogan.
|
|
70
72
|
* @function getSlogan
|
|
73
|
+
* @memberOf module:utils
|
|
71
74
|
* @mermaid
|
|
72
75
|
* sequenceDiagram
|
|
73
76
|
* participant getSlogan
|
|
@@ -96,4 +99,4 @@ function getSlogan(i) {
|
|
|
96
99
|
throw new Error(`Failed to retrieve slogans: ${error}`);
|
|
97
100
|
}
|
|
98
101
|
}
|
|
99
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
102
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/output/common.ts"],"names":[],"mappings":";;;;;AA8CA,kCAkBC;AA2BD,8BAQC;AAnGD,0EAA6C;AAC7C,iEAA8C;AAG9C;;;;GAIG;AACH,MAAM,MAAM,GAAG;IACb,gBAAgB,EAAE,cAAc;IAChC,gBAAgB,EAAE,QAAQ;IAC1B,gBAAgB,EAAE,OAAO;IACzB,gBAAgB,EAAE,SAAS;IAC3B,gBAAgB,EAAE,SAAS;IAC3B,gBAAgB,EAAE,cAAc;IAChC,gBAAgB,EAAE,cAAc;IAChC,gBAAgB,EAAE,aAAa;IAC/B,gBAAgB,EAAE,aAAa;CAChC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,WAAW,CAAC,MAAe;IACzC,MAAM,OAAO,GAAG,SAAS,EAAE,CAAC;IAC5B,MAAM,MAAM,GACV;;;;;;;EAOF,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACb,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9E,MAAM,CAAC,IAAI,CAAC,MAAM,OAAO,CAAC,QAAQ,CAAC,SAAS,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;IACrD,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC7B,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAC7D,IAAA,6BAAK,EAAC,IAAI,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAC1C,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,SAAS,CAAC,CAAU;IAClC,IAAI,CAAC;QACH,CAAC;YACC,OAAO,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,sBAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5E,OAAO,sBAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IAC3B,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,+BAA+B,KAAK,EAAE,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC","sourcesContent":["import slogans from \"../assets/slogans.json\";\nimport { style } from \"styled-string-builder\";\nimport { Logger } from \"@decaf-ts/logging\";\n\n/**\n * @description Array of ANSI color codes for banner styling.\n * @summary Defines a set of ANSI color codes used to style the banner text.\n * @memberOf module:utils\n */\nconst colors = [\n  \"\\x1b[38;5;215m\", // soft orange\n  \"\\x1b[38;5;209m\", // coral\n  \"\\x1b[38;5;205m\", // pink\n  \"\\x1b[38;5;210m\", // peachy\n  \"\\x1b[38;5;217m\", // salmon\n  \"\\x1b[38;5;216m\", // light coral\n  \"\\x1b[38;5;224m\", // light peach\n  \"\\x1b[38;5;230m\", // soft cream\n  \"\\x1b[38;5;230m\", // soft cream\n];\n\n/**\n * @description Prints a styled banner to the console.\n * @summary Generates and prints a colorful ASCII art banner with a random slogan.\n * @param {Logger} [logger] - Optional logger for verbose output.\n * @memberOf module:utils\n * @function printBanner\n * @mermaid\n * sequenceDiagram\n *   participant printBanner\n *   participant getSlogan\n *   participant padEnd\n *   participant console\n *   printBanner->>getSlogan: Call getSlogan()\n *   getSlogan-->>printBanner: Return random slogan\n *   printBanner->>printBanner: Create banner ASCII art\n *   printBanner->>printBanner: Split banner into lines\n *   printBanner->>printBanner: Calculate max line length\n *   printBanner->>padEnd: Call padEnd with slogan\n *   padEnd-->>printBanner: Return padded slogan line\n *   loop For each banner line\n *     printBanner->>style: Call style(line)\n *     style-->>printBanner: Return styled line\n *     printBanner->>console: Log styled line\n *   end\n */\nexport function printBanner(logger?: Logger) {\n  const message = getSlogan();\n  const banner: string | string[] =\n    `#                 ░▒▓███████▓▒░  ░▒▓████████▓▒░  ░▒▓██████▓▒░   ░▒▓██████▓▒░  ░▒▓████████▓▒░       ░▒▓████████▓▒░  ░▒▓███████▓▒░ \n#      ( (        ░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░        ░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░                 ░▒▓█▓▒░     ░▒▓█▓▒░        \n#       ) )       ░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░        ░▒▓█▓▒░        ░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░                 ░▒▓█▓▒░     ░▒▓█▓▒░        \n#    [=======]    ░▒▓█▓▒░░▒▓█▓▒░ ░▒▓██████▓▒░   ░▒▓█▓▒░        ░▒▓████████▓▒░ ░▒▓██████▓▒░            ░▒▓█▓▒░      ░▒▓██████▓▒░  \n#     \\`-----´     ░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░        ░▒▓█▓▒░        ░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░                 ░▒▓█▓▒░            ░▒▓█▓▒░ \n#                 ░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░        ░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░                 ░▒▓█▓▒░            ░▒▓█▓▒░ \n#                 ░▒▓███████▓▒░  ░▒▓████████▓▒░  ░▒▓██████▓▒░  ░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░                 ░▒▓█▓▒░     ░▒▓███████▓▒░  \n#`.split(\"\\n\");\n  const maxLength = banner.reduce((max, line) => Math.max(max, line.length), 0);\n  banner.push(`#  ${message.padStart(maxLength - 3)}`);\n  banner.forEach((line, index) => {\n    (logger ? logger.info.bind(logger) : console.log.bind(console))(\n      style(line || \"\").raw(colors[index]).text\n    );\n  });\n}\n\n/**\n * @description Retrieves a slogan from the predefined list.\n * @summary Fetches a random slogan or a specific one by index from the slogans list.\n * @param {number} [i] - Optional index to retrieve a specific slogan.\n * @return {string} The selected slogan.\n * @function getSlogan\n * @memberOf module:utils\n * @mermaid\n * sequenceDiagram\n *   participant getSlogan\n *   participant Math.random\n *   participant slogans\n *   alt i is undefined\n *     getSlogan->>Math.random: Generate random index\n *     Math.random-->>getSlogan: Return random index\n *   else i is defined\n *     Note over getSlogan: Use provided index\n *   end\n *   getSlogan->>slogans: Access slogan at index\n *   slogans-->>getSlogan: Return slogan\n *   alt Error occurs\n *     getSlogan->>getSlogan: Throw error\n *   end\n *   getSlogan-->>Caller: Return slogan\n */\nexport function getSlogan(i?: number): string {\n  try {\n    i =\n      typeof i === \"undefined\" ? Math.floor(Math.random() * slogans.length) : i;\n    return slogans[i].Slogan;\n  } catch (error: unknown) {\n    throw new Error(`Failed to retrieve slogans: ${error}`);\n  }\n}\n"]}
|
package/lib/output/common.d.ts
CHANGED
|
@@ -3,6 +3,7 @@ import { Logger } from "@decaf-ts/logging";
|
|
|
3
3
|
* @description Prints a styled banner to the console.
|
|
4
4
|
* @summary Generates and prints a colorful ASCII art banner with a random slogan.
|
|
5
5
|
* @param {Logger} [logger] - Optional logger for verbose output.
|
|
6
|
+
* @memberOf module:utils
|
|
6
7
|
* @function printBanner
|
|
7
8
|
* @mermaid
|
|
8
9
|
* sequenceDiagram
|
|
@@ -30,6 +31,7 @@ export declare function printBanner(logger?: Logger): void;
|
|
|
30
31
|
* @param {number} [i] - Optional index to retrieve a specific slogan.
|
|
31
32
|
* @return {string} The selected slogan.
|
|
32
33
|
* @function getSlogan
|
|
34
|
+
* @memberOf module:utils
|
|
33
35
|
* @mermaid
|
|
34
36
|
* sequenceDiagram
|
|
35
37
|
* participant getSlogan
|
package/lib/utils/constants.cjs
CHANGED
|
@@ -5,21 +5,21 @@ exports.AbortCode = exports.Tokens = exports.SetupScriptKey = exports.NoCIFLag =
|
|
|
5
5
|
* @description Default encoding for text operations.
|
|
6
6
|
* @summary The standard UTF-8 encoding used for text processing.
|
|
7
7
|
* @const {string} Encoding
|
|
8
|
-
* @memberOf
|
|
8
|
+
* @memberOf module:utils
|
|
9
9
|
*/
|
|
10
10
|
exports.Encoding = "utf-8";
|
|
11
11
|
/**
|
|
12
12
|
* @description Regular expression for semantic versioning.
|
|
13
13
|
* @summary A regex pattern to match and parse semantic version strings.
|
|
14
14
|
* @const {RegExp} SemVersionRegex
|
|
15
|
-
* @memberOf
|
|
15
|
+
* @memberOf module:utils
|
|
16
16
|
*/
|
|
17
17
|
exports.SemVersionRegex = /^(\d+)\.(\d+)\.(\d+)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z])))/g;
|
|
18
18
|
/**
|
|
19
19
|
* @description Enum for semantic version components.
|
|
20
20
|
* @summary Defines the three levels of semantic versioning: PATCH, MINOR, and MAJOR.
|
|
21
21
|
* @enum {string}
|
|
22
|
-
* @memberOf
|
|
22
|
+
* @memberOf module:utils
|
|
23
23
|
*/
|
|
24
24
|
var SemVersion;
|
|
25
25
|
(function (SemVersion) {
|
|
@@ -34,21 +34,21 @@ var SemVersion;
|
|
|
34
34
|
* @description Flag to indicate non-CI environment.
|
|
35
35
|
* @summary Used to specify that a command should run outside of a Continuous Integration environment.
|
|
36
36
|
* @const {string} NoCIFLag
|
|
37
|
-
* @memberOf
|
|
37
|
+
* @memberOf module:utils
|
|
38
38
|
*/
|
|
39
39
|
exports.NoCIFLag = "-no-ci";
|
|
40
40
|
/**
|
|
41
41
|
* @description Key for the setup script in package.json.
|
|
42
42
|
* @summary Identifies the script that runs after package installation.
|
|
43
43
|
* @const {string} SetupScriptKey
|
|
44
|
-
* @memberOf
|
|
44
|
+
* @memberOf module:utils
|
|
45
45
|
*/
|
|
46
46
|
exports.SetupScriptKey = "postinstall";
|
|
47
47
|
/**
|
|
48
48
|
* @description Enum for various authentication tokens.
|
|
49
49
|
* @summary Defines the file names for storing different types of authentication tokens.
|
|
50
50
|
* @enum {string}
|
|
51
|
-
* @memberOf
|
|
51
|
+
* @memberOf module:utils
|
|
52
52
|
*/
|
|
53
53
|
var Tokens;
|
|
54
54
|
(function (Tokens) {
|
|
@@ -61,5 +61,11 @@ var Tokens;
|
|
|
61
61
|
/** Confluence authentication token file name. */
|
|
62
62
|
Tokens["CONFLUENCE"] = ".confluence-token";
|
|
63
63
|
})(Tokens || (exports.Tokens = Tokens = {}));
|
|
64
|
+
/**
|
|
65
|
+
* @description Code used to indicate an operation was aborted.
|
|
66
|
+
* @summary Standard message used when a process is manually terminated.
|
|
67
|
+
* @const {string} AbortCode
|
|
68
|
+
* @memberOf module:utils
|
|
69
|
+
*/
|
|
64
70
|
exports.AbortCode = "Aborted";
|
|
65
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
71
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3V0aWxzL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQTs7Ozs7R0FLRztBQUNVLFFBQUEsUUFBUSxHQUFHLE9BQU8sQ0FBQztBQUVoQzs7Ozs7R0FLRztBQUNVLFFBQUEsZUFBZSxHQUMxQiw0REFBNEQsQ0FBQztBQUUvRDs7Ozs7R0FLRztBQUNILElBQVksVUFPWDtBQVBELFdBQVksVUFBVTtJQUNwQix3REFBd0Q7SUFDeEQsNkJBQWUsQ0FBQTtJQUNmLDJEQUEyRDtJQUMzRCw2QkFBZSxDQUFBO0lBQ2Ysb0VBQW9FO0lBQ3BFLDZCQUFlLENBQUE7QUFDakIsQ0FBQyxFQVBXLFVBQVUsMEJBQVYsVUFBVSxRQU9yQjtBQUVEOzs7OztHQUtHO0FBQ1UsUUFBQSxRQUFRLEdBQUcsUUFBUSxDQUFDO0FBRWpDOzs7OztHQUtHO0FBQ1UsUUFBQSxjQUFjLEdBQUcsYUFBYSxDQUFDO0FBRTVDOzs7OztHQUtHO0FBQ0gsSUFBWSxNQVNYO0FBVEQsV0FBWSxNQUFNO0lBQ2hCLDBDQUEwQztJQUMxQyx3QkFBYyxDQUFBO0lBQ2QsMENBQTBDO0lBQzFDLDJCQUFpQixDQUFBO0lBQ2pCLDZDQUE2QztJQUM3QyxpQ0FBdUIsQ0FBQTtJQUN2QixpREFBaUQ7SUFDakQsMENBQWdDLENBQUE7QUFDbEMsQ0FBQyxFQVRXLE1BQU0sc0JBQU4sTUFBTSxRQVNqQjtBQUVEOzs7OztHQUtHO0FBQ1UsUUFBQSxTQUFTLEdBQUcsU0FBUyxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAZGVzY3JpcHRpb24gRGVmYXVsdCBlbmNvZGluZyBmb3IgdGV4dCBvcGVyYXRpb25zLlxuICogQHN1bW1hcnkgVGhlIHN0YW5kYXJkIFVURi04IGVuY29kaW5nIHVzZWQgZm9yIHRleHQgcHJvY2Vzc2luZy5cbiAqIEBjb25zdCB7c3RyaW5nfSBFbmNvZGluZ1xuICogQG1lbWJlck9mIG1vZHVsZTp1dGlsc1xuICovXG5leHBvcnQgY29uc3QgRW5jb2RpbmcgPSBcInV0Zi04XCI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIFJlZ3VsYXIgZXhwcmVzc2lvbiBmb3Igc2VtYW50aWMgdmVyc2lvbmluZy5cbiAqIEBzdW1tYXJ5IEEgcmVnZXggcGF0dGVybiB0byBtYXRjaCBhbmQgcGFyc2Ugc2VtYW50aWMgdmVyc2lvbiBzdHJpbmdzLlxuICogQGNvbnN0IHtSZWdFeHB9IFNlbVZlcnNpb25SZWdleFxuICogQG1lbWJlck9mIG1vZHVsZTp1dGlsc1xuICovXG5leHBvcnQgY29uc3QgU2VtVmVyc2lvblJlZ2V4ID1cbiAgL14oXFxkKylcXC4oXFxkKylcXC4oXFxkKykoPzotKFswLTlBLVphLXotXSsoPzpcXC5bMC05QS1aYS16XSkpKS9nO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBFbnVtIGZvciBzZW1hbnRpYyB2ZXJzaW9uIGNvbXBvbmVudHMuXG4gKiBAc3VtbWFyeSBEZWZpbmVzIHRoZSB0aHJlZSBsZXZlbHMgb2Ygc2VtYW50aWMgdmVyc2lvbmluZzogUEFUQ0gsIE1JTk9SLCBhbmQgTUFKT1IuXG4gKiBAZW51bSB7c3RyaW5nfVxuICogQG1lbWJlck9mIG1vZHVsZTp1dGlsc1xuICovXG5leHBvcnQgZW51bSBTZW1WZXJzaW9uIHtcbiAgLyoqIFBhdGNoIHZlcnNpb24gZm9yIGJhY2t3YXJkcy1jb21wYXRpYmxlIGJ1ZyBmaXhlcy4gKi9cbiAgUEFUQ0ggPSBcInBhdGNoXCIsXG4gIC8qKiBNaW5vciB2ZXJzaW9uIGZvciBiYWNrd2FyZHMtY29tcGF0aWJsZSBuZXcgZmVhdHVyZXMuICovXG4gIE1JTk9SID0gXCJtaW5vclwiLFxuICAvKiogTWFqb3IgdmVyc2lvbiBmb3IgY2hhbmdlcyB0aGF0IGJyZWFrIGJhY2t3YXJkcyBjb21wYXRpYmlsaXR5LiAqL1xuICBNQUpPUiA9IFwibWFqb3JcIixcbn1cblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gRmxhZyB0byBpbmRpY2F0ZSBub24tQ0kgZW52aXJvbm1lbnQuXG4gKiBAc3VtbWFyeSBVc2VkIHRvIHNwZWNpZnkgdGhhdCBhIGNvbW1hbmQgc2hvdWxkIHJ1biBvdXRzaWRlIG9mIGEgQ29udGludW91cyBJbnRlZ3JhdGlvbiBlbnZpcm9ubWVudC5cbiAqIEBjb25zdCB7c3RyaW5nfSBOb0NJRkxhZ1xuICogQG1lbWJlck9mIG1vZHVsZTp1dGlsc1xuICovXG5leHBvcnQgY29uc3QgTm9DSUZMYWcgPSBcIi1uby1jaVwiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBLZXkgZm9yIHRoZSBzZXR1cCBzY3JpcHQgaW4gcGFja2FnZS5qc29uLlxuICogQHN1bW1hcnkgSWRlbnRpZmllcyB0aGUgc2NyaXB0IHRoYXQgcnVucyBhZnRlciBwYWNrYWdlIGluc3RhbGxhdGlvbi5cbiAqIEBjb25zdCB7c3RyaW5nfSBTZXR1cFNjcmlwdEtleVxuICogQG1lbWJlck9mIG1vZHVsZTp1dGlsc1xuICovXG5leHBvcnQgY29uc3QgU2V0dXBTY3JpcHRLZXkgPSBcInBvc3RpbnN0YWxsXCI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEVudW0gZm9yIHZhcmlvdXMgYXV0aGVudGljYXRpb24gdG9rZW5zLlxuICogQHN1bW1hcnkgRGVmaW5lcyB0aGUgZmlsZSBuYW1lcyBmb3Igc3RvcmluZyBkaWZmZXJlbnQgdHlwZXMgb2YgYXV0aGVudGljYXRpb24gdG9rZW5zLlxuICogQGVudW0ge3N0cmluZ31cbiAqIEBtZW1iZXJPZiBtb2R1bGU6dXRpbHNcbiAqL1xuZXhwb3J0IGVudW0gVG9rZW5zIHtcbiAgLyoqIEdpdCBhdXRoZW50aWNhdGlvbiB0b2tlbiBmaWxlIG5hbWUuICovXG4gIEdJVCA9IFwiLnRva2VuXCIsXG4gIC8qKiBOUE0gYXV0aGVudGljYXRpb24gdG9rZW4gZmlsZSBuYW1lLiAqL1xuICBOUE0gPSBcIi5ucG10b2tlblwiLFxuICAvKiogRG9ja2VyIGF1dGhlbnRpY2F0aW9uIHRva2VuIGZpbGUgbmFtZS4gKi9cbiAgRE9DS0VSID0gXCIuZG9ja2VydG9rZW5cIixcbiAgLyoqIENvbmZsdWVuY2UgYXV0aGVudGljYXRpb24gdG9rZW4gZmlsZSBuYW1lLiAqL1xuICBDT05GTFVFTkNFID0gXCIuY29uZmx1ZW5jZS10b2tlblwiLFxufVxuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBDb2RlIHVzZWQgdG8gaW5kaWNhdGUgYW4gb3BlcmF0aW9uIHdhcyBhYm9ydGVkLlxuICogQHN1bW1hcnkgU3RhbmRhcmQgbWVzc2FnZSB1c2VkIHdoZW4gYSBwcm9jZXNzIGlzIG1hbnVhbGx5IHRlcm1pbmF0ZWQuXG4gKiBAY29uc3Qge3N0cmluZ30gQWJvcnRDb2RlXG4gKiBAbWVtYmVyT2YgbW9kdWxlOnV0aWxzXG4gKi9cbmV4cG9ydCBjb25zdCBBYm9ydENvZGUgPSBcIkFib3J0ZWRcIjtcbiJdfQ==
|
package/lib/utils/constants.d.ts
CHANGED
|
@@ -2,21 +2,21 @@
|
|
|
2
2
|
* @description Default encoding for text operations.
|
|
3
3
|
* @summary The standard UTF-8 encoding used for text processing.
|
|
4
4
|
* @const {string} Encoding
|
|
5
|
-
* @memberOf
|
|
5
|
+
* @memberOf module:utils
|
|
6
6
|
*/
|
|
7
7
|
export declare const Encoding = "utf-8";
|
|
8
8
|
/**
|
|
9
9
|
* @description Regular expression for semantic versioning.
|
|
10
10
|
* @summary A regex pattern to match and parse semantic version strings.
|
|
11
11
|
* @const {RegExp} SemVersionRegex
|
|
12
|
-
* @memberOf
|
|
12
|
+
* @memberOf module:utils
|
|
13
13
|
*/
|
|
14
14
|
export declare const SemVersionRegex: RegExp;
|
|
15
15
|
/**
|
|
16
16
|
* @description Enum for semantic version components.
|
|
17
17
|
* @summary Defines the three levels of semantic versioning: PATCH, MINOR, and MAJOR.
|
|
18
18
|
* @enum {string}
|
|
19
|
-
* @memberOf
|
|
19
|
+
* @memberOf module:utils
|
|
20
20
|
*/
|
|
21
21
|
export declare enum SemVersion {
|
|
22
22
|
/** Patch version for backwards-compatible bug fixes. */
|
|
@@ -30,21 +30,21 @@ export declare enum SemVersion {
|
|
|
30
30
|
* @description Flag to indicate non-CI environment.
|
|
31
31
|
* @summary Used to specify that a command should run outside of a Continuous Integration environment.
|
|
32
32
|
* @const {string} NoCIFLag
|
|
33
|
-
* @memberOf
|
|
33
|
+
* @memberOf module:utils
|
|
34
34
|
*/
|
|
35
35
|
export declare const NoCIFLag = "-no-ci";
|
|
36
36
|
/**
|
|
37
37
|
* @description Key for the setup script in package.json.
|
|
38
38
|
* @summary Identifies the script that runs after package installation.
|
|
39
39
|
* @const {string} SetupScriptKey
|
|
40
|
-
* @memberOf
|
|
40
|
+
* @memberOf module:utils
|
|
41
41
|
*/
|
|
42
42
|
export declare const SetupScriptKey = "postinstall";
|
|
43
43
|
/**
|
|
44
44
|
* @description Enum for various authentication tokens.
|
|
45
45
|
* @summary Defines the file names for storing different types of authentication tokens.
|
|
46
46
|
* @enum {string}
|
|
47
|
-
* @memberOf
|
|
47
|
+
* @memberOf module:utils
|
|
48
48
|
*/
|
|
49
49
|
export declare enum Tokens {
|
|
50
50
|
/** Git authentication token file name. */
|
|
@@ -56,4 +56,10 @@ export declare enum Tokens {
|
|
|
56
56
|
/** Confluence authentication token file name. */
|
|
57
57
|
CONFLUENCE = ".confluence-token"
|
|
58
58
|
}
|
|
59
|
+
/**
|
|
60
|
+
* @description Code used to indicate an operation was aborted.
|
|
61
|
+
* @summary Standard message used when a process is manually terminated.
|
|
62
|
+
* @const {string} AbortCode
|
|
63
|
+
* @memberOf module:utils
|
|
64
|
+
*/
|
|
59
65
|
export declare const AbortCode = "Aborted";
|
|
@@ -24,6 +24,12 @@ class Environment extends typed_object_accumulator_1.ObjectAccumulator {
|
|
|
24
24
|
constructor() {
|
|
25
25
|
super();
|
|
26
26
|
}
|
|
27
|
+
/**
|
|
28
|
+
* @description Retrieves a value from the environment
|
|
29
|
+
* @summary Gets a value from the environment variables, handling browser and Node.js environments differently
|
|
30
|
+
* @param {string} k - The key to retrieve from the environment
|
|
31
|
+
* @return {unknown} The value from the environment, or undefined if not found
|
|
32
|
+
*/
|
|
27
33
|
fromEnv(k) {
|
|
28
34
|
let env;
|
|
29
35
|
if ((0, web_1.isBrowser)()) {
|
|
@@ -35,6 +41,13 @@ class Environment extends typed_object_accumulator_1.ObjectAccumulator {
|
|
|
35
41
|
}
|
|
36
42
|
return env[k];
|
|
37
43
|
}
|
|
44
|
+
/**
|
|
45
|
+
* @description Expands an object into the environment
|
|
46
|
+
* @summary Defines properties on the environment object that can be accessed as getters and setters
|
|
47
|
+
* @template V - Type of the object being expanded
|
|
48
|
+
* @param {V} value - The object to expand into the environment
|
|
49
|
+
* @return {void}
|
|
50
|
+
*/
|
|
38
51
|
expand(value) {
|
|
39
52
|
Object.entries(value).forEach(([k, v]) => {
|
|
40
53
|
Object.defineProperty(this, k, {
|
|
@@ -91,4 +104,4 @@ class Environment extends typed_object_accumulator_1.ObjectAccumulator {
|
|
|
91
104
|
}
|
|
92
105
|
}
|
|
93
106
|
exports.Environment = Environment;
|
|
94
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
107
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../src/utils/environment.ts"],"names":[],"mappings":";;;AAAA,qCAAqC;AAErC,mCAAkC;AAClC,uEAA6D;AAE7D;;;;;;;GAOG;AACH,MAAa,WAA8B,SAAQ,4CAAoB;IACrE;;;;;;OAMG;aACc,YAAO,GACtB,GAAqB,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC;IAU5C;QACE,KAAK,EAAE,CAAC;IACV,CAAC;IAED;;;;;OAKG;IACO,OAAO,CAAC,CAAS;QACzB,IAAI,GAA4B,CAAC;QACjC,IAAI,IAAA,eAAS,GAAE,EAAE,CAAC;YAChB,GAAG,GAAI,UAA+D,CACpE,KAAK,CACN,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC;YAC7B,CAAC,GAAG,IAAA,kBAAW,EAAC,CAAC,CAAC,CAAC;QACrB,CAAC;QACD,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACgB,MAAM,CAAmB,KAAQ;QAClD,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;YACvC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,EAAE;gBAC7B,GAAG,EAAE,GAAG,EAAE;oBACR,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;oBAChC,OAAO,OAAO,OAAO,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;gBACtD,CAAC;gBACD,GAAG,EAAE,CAAC,GAAe,EAAE,EAAE;oBACvB,CAAC,GAAG,GAAG,CAAC;gBACV,CAAC;gBACD,YAAY,EAAE,IAAI;gBAClB,UAAU,EAAE,IAAI;aACjB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACO,MAAM,CAAC,QAAQ,CAA6B,GAAG,IAAe;QACtE,WAAW,CAAC,SAAS,GAAG,CAAC,WAAW,CAAC,SAAS;YAC5C,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;YAC9B,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC;QAC1B,OAAO,WAAW,CAAC,SAAc,CAAC;IACpC,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,CACf,KAAQ;QAIR,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC;QACxC,OAAO,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,QAAiB,IAAI;QAC/B,OAAO,WAAW,CAAC,QAAQ,EAAE;aAC1B,IAAI,EAAE;aACN,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAA,kBAAW,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9C,CAAC;;AA7GH,kCA8GC","sourcesContent":["import { toENVFormat } from \"./text\";\nimport { EnvironmentFactory } from \"./types\";\nimport { isBrowser } from \"./web\";\nimport { ObjectAccumulator } from \"typed-object-accumulator\";\n\n/**\n * @class Environment\n * @extends {ObjectAccumulator<T>}\n * @template T\n * @description A class representing an environment with accumulation capabilities.\n * @summary Manages environment-related data and provides methods for accumulation and key retrieval.\n * @param {T} [initialData] - The initial data to populate the environment with.\n */\nexport class Environment<T extends object> extends ObjectAccumulator<T> {\n  /**\n   * @static\n   * @protected\n   * @description A factory function for creating Environment instances.\n   * @summary Defines how new instances of the Environment class should be created.\n   * @return {Environment<any>} A new instance of the Environment class.\n   */\n  protected static factory: EnvironmentFactory<any, any> =\n    (): Environment<any> => new Environment();\n\n  /**\n   * @static\n   * @private\n   * @description The singleton instance of the Environment class.\n   * @type {Environment<any>}\n   */\n  private static _instance: Environment<any>;\n\n  protected constructor() {\n    super();\n  }\n\n  /**\n   * @description Retrieves a value from the environment\n   * @summary Gets a value from the environment variables, handling browser and Node.js environments differently\n   * @param {string} k - The key to retrieve from the environment\n   * @return {unknown} The value from the environment, or undefined if not found\n   */\n  protected fromEnv(k: string) {\n    let env: Record<string, unknown>;\n    if (isBrowser()) {\n      env = (globalThis as typeof globalThis & { ENV: Record<string, any> })[\n        \"ENV\"\n      ];\n    } else {\n      env = globalThis.process.env;\n      k = toENVFormat(k);\n    }\n    return env[k];\n  }\n\n  /**\n   * @description Expands an object into the environment\n   * @summary Defines properties on the environment object that can be accessed as getters and setters\n   * @template V - Type of the object being expanded\n   * @param {V} value - The object to expand into the environment\n   * @return {void}\n   */\n  protected override expand<V extends object>(value: V): void {\n    Object.entries(value).forEach(([k, v]) => {\n      Object.defineProperty(this, k, {\n        get: () => {\n          const fromEnv = this.fromEnv(k);\n          return typeof fromEnv === \"undefined\" ? v : fromEnv;\n        },\n        set: (val: V[keyof V]) => {\n          v = val;\n        },\n        configurable: true,\n        enumerable: true,\n      });\n    });\n  }\n\n  /**\n   * @protected\n   * @static\n   * @description Retrieves or creates the singleton instance of the Environment class.\n   * @summary Ensures only one instance of the Environment class exists.\n   * @template E\n   * @param {...unknown[]} args - Arguments to pass to the factory function if a new instance is created.\n   * @return {E} The singleton instance of the Environment class.\n   */\n  protected static instance<E extends Environment<any>>(...args: unknown[]): E {\n    Environment._instance = !Environment._instance\n      ? Environment.factory(...args)\n      : Environment._instance;\n    return Environment._instance as E;\n  }\n\n  /**\n   * @static\n   * @description Accumulates the given value into the environment.\n   * @summary Adds new properties to the environment from the provided object.\n   * @template V\n   * @param {V} value - The object to accumulate into the environment.\n   * @return {V} The updated environment instance.\n   */\n  static accumulate<V extends object>(\n    value: V\n  ): typeof Environment._instance &\n    V &\n    ObjectAccumulator<typeof Environment._instance & V> {\n    const instance = Environment.instance();\n    return instance.accumulate(value);\n  }\n\n  /**\n   * @static\n   * @description Retrieves the keys of the environment, optionally converting them to ENV format.\n   * @summary Gets all keys in the environment, with an option to format them for environment variables.\n   * @param {boolean} [toEnv=true] - Whether to convert the keys to ENV format.\n   * @return {string[]} An array of keys from the environment.\n   */\n  static keys(toEnv: boolean = true): string[] {\n    return Environment.instance()\n      .keys()\n      .map((k) => (toEnv ? toENVFormat(k) : k));\n  }\n}\n"]}
|
|
@@ -25,7 +25,20 @@ export declare class Environment<T extends object> extends ObjectAccumulator<T>
|
|
|
25
25
|
*/
|
|
26
26
|
private static _instance;
|
|
27
27
|
protected constructor();
|
|
28
|
+
/**
|
|
29
|
+
* @description Retrieves a value from the environment
|
|
30
|
+
* @summary Gets a value from the environment variables, handling browser and Node.js environments differently
|
|
31
|
+
* @param {string} k - The key to retrieve from the environment
|
|
32
|
+
* @return {unknown} The value from the environment, or undefined if not found
|
|
33
|
+
*/
|
|
28
34
|
protected fromEnv(k: string): unknown;
|
|
35
|
+
/**
|
|
36
|
+
* @description Expands an object into the environment
|
|
37
|
+
* @summary Defines properties on the environment object that can be accessed as getters and setters
|
|
38
|
+
* @template V - Type of the object being expanded
|
|
39
|
+
* @param {V} value - The object to expand into the environment
|
|
40
|
+
* @return {void}
|
|
41
|
+
*/
|
|
29
42
|
protected expand<V extends object>(value: V): void;
|
|
30
43
|
/**
|
|
31
44
|
* @protected
|