diff --git a/Documentation/assets/navigation.js b/Documentation/assets/navigation.js deleted file mode 100644 index 0d50624..0000000 --- a/Documentation/assets/navigation.js +++ /dev/null @@ -1 +0,0 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAACq2TT2vDMAzFv4vO2cbSrYccNzZooVuhx5JD/iiLqeMWzymF0e8+otVxbMcljF4lvx/vydL2BxSeFCTw0jJeQgSHTNWQQLMvW47fD1S+r1XDIYIdEyUkcQRFzXgpUUCy7QELoVBWWYEGwnRJc/o3DvF5fo560GsrJQplMMdMsiw3bi4PbMYsHiDW7IBhfde9Is7tSbjq3J+IJX87YWHUVSsKxfZCq7uuLZ4/DcQrlF8YVlP7ityx7sqpfffoAdKh/U1gEy6NSbvgQcwQNWYUN4ttL9YoeyPeCP+1kYSZtJAY+FEi4NiHDkO8M45+iK56gxCEmRSismyYEESoPDdOiOXm88MP0VVvEIIwk0LYNkwIIvhunBDOcekUI0cViNGErvMP0YxeZ3pOfwHQqt2PZgUAAA==" \ No newline at end of file diff --git a/Documentation/assets/search.js b/Documentation/assets/search.js deleted file mode 100644 index 231ca6d..0000000 --- a/Documentation/assets/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACtVY227jNhD9Fz6ziobU1Y8tUmALbFtggb4YRqHIdKKtLRm6pAmM/HtBSow4lsbWJinafdKI1BwezuWI0onV1d8NW61P7K+i3LKV4KzMDoqt2O2XH7tiv2WcdfWerdih2nZ71dwM495De9gzzvJ91jSqYSvGXrhFkTTMY1YX2Z0LRANydsxqVbYOzLjGuMQvX377dUJTD17kKMLoFeFT2ap6l+XqFaawIwPS6xOXaRoqcxx/LvZqwlEPfgxHg7SQo6Eyx/H2SeXTdD+p/GM4GqSFHA2VOY7zNXm9Ihez7KEW0qRr8rOq76cJN6MXeUbBK8QBQey6Mm+LqrQgBwLKYddzmMVGLTNCm1InOoeucgd355b5iGvKczdf7XRlOrjKLc0R15SUmq9Qupoc3Nt53EGYrgKf599B/kxkr4emCuECtqOpvxdHNSOoPbSefDPyT11tHqLAh/k3R+UOte95VMzsD/Bm9nfEm8ZBX4S94awot+qJrU7sUdVNUZVsxYQnvZRxtivUfqvfmf2ynOXV4dAHbVvlnTE3w2N/qLytav1w//SNz/ja5wK8OEg2G762zmbCDFiMccQ4AuUIE0dAjoLxNXAIvSRGfmLiJ5CfZHwtZvxkj+fJJOCS+14cBjzgvpfKhIfDfTTcxxw8SARPuO+FScjT4R587ntRJDnA4AHCTklrBNYIewOTlYhsoEn5HIQHqUB0g8k2A+QZEtvU4xBx4UUJcIitkfQGRgwRYqQ90zku0YRLhDxjgose12GRUWxCnUhhQh2FJtKhH/YR9kMdUPD8WHBI9UgsuNCxTiLBBVhDWENaI7BGaI3IGrE1EmukvYF3EqOdJJqxzyHxZCLRXpJJDBLkmRIx0OOmzOKhvOLAbFpfdeY98CWXevdplHAprCF7Ay+Z4tbSnSaDObYwbUs460ugnWdaE/cmUM1pJ/7rLgOsCSDJPuunFjYM4O6FgGwZM/V/r33AkgIhvZ3we9gO1jOI6AqfKhpgSQOjXSEXkZeEEXaOp85YRcDISDTrPNURwEICKalB8KFiAlhNhE+uK6ZqMgyZE8ejqlu1/dSfPNZrljF+Yn8OJ5HXz5fTy3jiWJ2Y7Efi/pL2FxDDNRiu4XA18y/OQUXfakJZ6S4mfGK1eA53Hm/rAgIsoj/Pexa/eS7zh7oqq65BzKmFFjO/Kyp9qnO4U6G3QZUkVH8eHaHkGFeWuCnhTPgDyrjAHGT+cAYpkvduWPucpUvI94OWrTkTO3EML9dAn/xZMPtV4kRyTAqDZFHoVDPJh5MOfyCxDMp8NjpbS0egiAjRW6Ko1+lahStcvDc3/Ue6w94Jg3WWU9ZyXmJISbFfd+5Swb+rYsV9WdV4b/Fbm7cY/xI5wR8jNVAOp8yvlk+BEnqlLb5ZGosWwQPVy1fb7muDkzdKKxNnvt8Cuy/K9qbpmmORF1XX3JSVejrui7xos/IZrUdJ29Xc7at73DNU3S3umeFnnCNAgSNAVjxguEaLyqDaIY5UpS7meMzqRuHX7pV+o5N0zNpW1SWKoqQqyfYr2ZdH88PKQQqd4MWLgnWsq1w1OKvpuyPWg2KBlZTAXt1mrbItgqIIXg1/rY61alSJW1lSh5sFzNruLJtAbfMquabdqrpGmaCOSIsz0bTbqkNveEHp4mLM9iFDiJScfNDLp33ANf7Bst4+H1WT18UR7YkSjctJ3HDTkvuiVGy13ry8/APz/sGwCBwAAA=="; \ No newline at end of file diff --git a/Documentation/functions/Build.Merge.html b/Documentation/functions/Build.Merge.html deleted file mode 100644 index b1438f5..0000000 --- a/Documentation/functions/Build.Merge.html +++ /dev/null @@ -1 +0,0 @@ -
Rest
...objects: TsConst
Const
The 'Exec' function is an asynchronous function that executes a command and logs the +
The 'Exec' function is an asynchronous function that executes a command and logs the stdout and stderr of the child process.
The 'Command' parameter is a string that represents the command you want to execute. It can be any valid command that can be executed in a @@ -7,4 +7,4 @@ of the child process should be logged. If set to 'false', no logging will occur. If set to a function, the function will be called with the stdout and stderr data as a parameter for custom logging. If not provided, stdout and stderr will be logged to the console by default.
-Rest
...objects: TsReturn the last portion of a path. Similar to the Unix basename command. +Often used to extract the file name from a fully qualified path.
+the path to evaluate.
+Optional
suffix: stringoptionally, an extension to remove from the result.
+Represents a function that processes file patterns.
+Represents a function that processes file patterns.
An array of file patterns to be processed. Each pattern can include wildcards (*) to match multiple files.
-Optional
Option: { An optional object that can contain two properties.
+Optional
Option: { An optional object that can contain two properties.
Optional
ESBuild?: stringA string representing the ESBuild option.
-Optional
TypeA string representing the TypeScript option.
-Optional
Watch?: booleanOptional
Exclude?: string[]Optional
TypeA string representing the TypeScript option.
+Optional
Watch?: booleanReturn the extension of the path, from the last '.' to end of string in the last portion of the path. +If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string.
+the path to evaluate.
+Normalize a string path, reducing '..' and '.' parts. +When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used.
+string path to normalize.
+Solve the relative path from {from} to {to} based on the current working directory. +At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve.
+The function 'JSON' is a TypeScript function that reads a JSON file and returns its +
The function 'JSON' is a TypeScript function that reads a JSON file and returns its parsed content.
The File
parameter is a string that represents the name or
path of the JSON file that you want to parse.
From
is provided,
it will be used as the base directory path. If From
is not provided, the current
directory will be used as the base directory path.
-Rest
...objects: TsRest
...objects: TsBuild
is a powerful tool that compiles all your TypeScript
files into
+
Build
is a powerful tool that compiles all your TypeScript
files into
JavaScript
, leveraging the speed of ESBuild
and the type-checking capabilities
of the TypeScript
compiler.
{
"scripts": {
"build": "Build 'Source/**/*.ts'",
"Run": "Build 'Source/**/*.ts' --Watch",
"prepublishOnly": "Build 'Source/**/*.ts'"
}
}
+{
"scripts": {
"Build": "Build 'Source/**/*.ts'",
"Run": "Build 'Source/**/*.ts' --Watch",
"prepublishOnly": "Build 'Source/**/*.ts'"
}
}
⚙️ Configuration
📜 ESBuild Configuration
Create a custom ESBuild
configuration file (e.g., ESBuild.ts
):
@@ -32,7 +32,7 @@
See an example of a configuration file in -ESBuild.ts
+ESBuild.tsCreate a tsconfig.json
file in your project root:
{
"compilerOptions": {
"outDir": "Target",
"rootDir": "Source",
"strict": true
},
"extends": "@playform/build/tsconfig",
"include": ["Source"]
}
@@ -45,4 +45,4 @@
guidelines and feel free to submit a Pull Request.
This project is licensed under the MIT LICENSE.
See CHANGELOG.md for a history of changes to this component.
-Represents a function that processes file patterns.
+Represents a function that processes file patterns.
An array of file patterns to be processed. Each pattern can include wildcards (*) to match multiple files.
-Optional
Option: { An optional object that can contain two properties.
+Optional
Option: { An optional object that can contain two properties.
Optional
ESBuild?: stringA string representing the ESBuild option.
-Optional
TypeA string representing the TypeScript option.
-Optional
Watch?: booleanOptional
Exclude?: string[]Optional
TypeA string representing the TypeScript option.
+Optional
Watch?: booleanThe 'Exec' function is an asynchronous function that executes a command and logs the +
The 'Exec' function is an asynchronous function that executes a command and logs the stdout and stderr of the child process.
The 'Command' parameter is a string that represents the command you want to execute. It can be any valid command that can be executed in a @@ -7,4 +7,4 @@ of the child process should be logged. If set to 'false', no logging will occur. If set to a function, the function will be called with the stdout and stderr data as a parameter for custom logging. If not provided, stdout and stderr will be logged to the console by default.
-The function 'JSON' is a TypeScript function that reads a JSON file and returns its +
The function 'JSON' is a TypeScript function that reads a JSON file and returns its parsed content.
The File
parameter is a string that represents the name or
path of the JSON file that you want to parse.
From
is provided,
it will be used as the base directory path. If From
is not provided, the current
directory will be used as the base directory path.
-Const
Const
The 'Exec' function is an asynchronous function that executes a command and logs the +
- Preparing search index...
- The search index is not available
@playform/build - v0.1.6Function exec
The 'Exec' function is an asynchronous function that executes a command and logs the stdout and stderr of the child process.
Parameters
The 'Command' parameter is a string that represents the command you want to execute. It can be any valid command that can be executed in a @@ -7,4 +7,4 @@ of the child process should be logged. If set to 'false', no logging will occur. If set to a function, the function will be called with the stdout and stderr data as a parameter for custom logging. If not provided, stdout and stderr will be logged to the console by default.
-Returns Promise<void>
Settings