From 50ea8b238024f3e43f52b2e466f8e343130bde2c Mon Sep 17 00:00:00 2001 From: Nikola Hristov Date: Wed, 10 Jul 2024 14:14:07 +0300 Subject: [PATCH] Build/v0.1.1 --- .github/dependabot.yml | 14 ++++++ .github/workflows/Dependabot.yml | 45 +++++++++++++++++++ .github/workflows/NPM.yml | 2 +- .github/workflows/Node.yml | 2 +- CHANGELOG.md | 4 ++ Documentation/functions/Build.Exec.html | 4 +- Documentation/functions/Build.Merge.html | 2 +- Documentation/functions/Build.build-1.html | 4 +- Documentation/functions/Exec.exec.html | 4 +- Documentation/functions/File.file.html | 4 +- Documentation/functions/JSON.JSON.html | 4 +- Documentation/functions/Merge.merge.html | 2 +- Documentation/index.html | 16 ++++--- Documentation/interfaces/Build.Interface.html | 4 +- Documentation/interfaces/Exec.Interface.html | 4 +- Documentation/interfaces/File.Interface.html | 4 +- Documentation/interfaces/JSON.Interface.html | 4 +- Documentation/modules/Build.html | 4 +- Documentation/modules/ESBuild.html | 4 +- Documentation/modules/Exec.html | 4 +- Documentation/modules/File.html | 4 +- Documentation/modules/JSON.html | 4 +- Documentation/modules/Merge.html | 4 +- Documentation/variables/Build.Current.html | 2 +- Documentation/variables/Build.Pipe.html | 2 +- Documentation/variables/Build.build.html | 2 +- Documentation/variables/ESBuild.ESBuild.html | 2 +- Target/Class/Build.js | 2 +- package.json | 2 +- 29 files changed, 114 insertions(+), 45 deletions(-) create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/Dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..575fdde6 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,14 @@ +version: 2 +enable-beta-ecosystems: true + +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "daily" + + - package-ecosystem: "npm" + directory: "/" + schedule: + interval: "daily" + versioning-strategy: increase diff --git a/.github/workflows/Dependabot.yml b/.github/workflows/Dependabot.yml new file mode 100644 index 00000000..387fece7 --- /dev/null +++ b/.github/workflows/Dependabot.yml @@ -0,0 +1,45 @@ +name: Dependabot + +concurrency: + group: Dependabot-${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +permissions: + security-events: write + contents: write + pull-requests: write + +on: + workflow_dispatch: + pull_request: + +jobs: + Approve: + runs-on: ubuntu-latest + + if: ${{ github.actor == 'dependabot[bot]' }} + + steps: + - uses: dependabot/fetch-metadata@v2.2.0 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + + - run: gh pr review --approve "$PR_URL" + env: + PR_URL: ${{github.event.pull_request.html_url}} + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + + Merge: + runs-on: ubuntu-latest + + if: ${{ github.actor == 'dependabot[bot]' }} + + steps: + - uses: dependabot/fetch-metadata@v2.2.0 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + + - run: gh pr merge --auto --merge "$PR_URL" + env: + PR_URL: ${{github.event.pull_request.html_url}} + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} diff --git a/.github/workflows/NPM.yml b/.github/workflows/NPM.yml index a3c48117..86bf8e24 100644 --- a/.github/workflows/NPM.yml +++ b/.github/workflows/NPM.yml @@ -58,7 +58,7 @@ jobs: steps: - uses: actions/checkout@v4.1.7 - - uses: actions/setup-node@v4.0.3 + - uses: actions/setup-node@v4.0.2 with: node-version: "18" registry-url: "https://registry.npmjs.org" diff --git a/.github/workflows/Node.yml b/.github/workflows/Node.yml index 216f5b7e..9f425651 100644 --- a/.github/workflows/Node.yml +++ b/.github/workflows/Node.yml @@ -75,7 +75,7 @@ jobs: --unsafe-perm=true ] - - uses: actions/setup-node@v4.0.3 + - uses: actions/setup-node@v4.0.2 with: node-version: ${{ matrix.node-version }} cache: "pnpm" diff --git a/CHANGELOG.md b/CHANGELOG.md index ea3ca059..107fdb2e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## 0.1.1 + +- Cleanup + ## 0.1.0 - Cleanup diff --git a/Documentation/functions/Build.Exec.html b/Documentation/functions/Build.Exec.html index ab448f97..68df9af9 100644 --- a/Documentation/functions/Build.Exec.html +++ b/Documentation/functions/Build.Exec.html @@ -1,4 +1,4 @@ -Exec | @playform/build - v0.1.0
  • The 'Exec' function is an asynchronous function that executes a command and logs the +Exec | @playform/build - v0.1.1

    • The 'Exec' function is an asynchronous function that executes a command and logs the stdout and stderr of the child process.

      Parameters

      • Command: string

        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>

    \ No newline at end of file +

Returns Promise<void>

\ No newline at end of file diff --git a/Documentation/functions/Build.Merge.html b/Documentation/functions/Build.Merge.html index 9a84a9ea..e4217e7c 100644 --- a/Documentation/functions/Build.Merge.html +++ b/Documentation/functions/Build.Merge.html @@ -1 +1 @@ -Merge | @playform/build - v0.1.0
  • Type Parameters

    • Ts extends readonly unknown[]

    Parameters

    • Rest ...objects: Ts

    Returns DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeArraysDefaultURI";
        DeepMergeFilterValuesURI: "DeepMergeFilterValuesDefaultURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

\ No newline at end of file +Merge | @playform/build - v0.1.1
  • Type Parameters

    • Ts extends readonly unknown[]

    Parameters

    • Rest ...objects: Ts

    Returns DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeArraysDefaultURI";
        DeepMergeFilterValuesURI: "DeepMergeFilterValuesDefaultURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

\ No newline at end of file diff --git a/Documentation/functions/Build.build-1.html b/Documentation/functions/Build.build-1.html index 4bacf5c6..2849524e 100644 --- a/Documentation/functions/Build.build-1.html +++ b/Documentation/functions/Build.build-1.html @@ -1,6 +1,6 @@ -build | @playform/build - v0.1.0
  • Represents a function that processes file patterns.

    +build | @playform/build - v0.1.1
    • Represents a function that processes file patterns.

      Parameters

      • File: string[]

        An array of file patterns to be processed. Each pattern can include wildcards (*) to match multiple files.

      • Optional Option: {
            ESBuild?: string;
            TypeScript?: string;
            Watch?: boolean;
        }

        An optional object that can contain two properties.

        • Optional ESBuild?: string

          A string representing the ESBuild option.

        • Optional TypeScript?: string

          A string representing the TypeScript option.

          -
        • Optional Watch?: boolean

      Returns Promise<void>

    \ No newline at end of file +
  • Optional Watch?: boolean

Returns Promise<void>

\ No newline at end of file diff --git a/Documentation/functions/Exec.exec.html b/Documentation/functions/Exec.exec.html index 01d1cc7a..09edecbb 100644 --- a/Documentation/functions/Exec.exec.html +++ b/Documentation/functions/Exec.exec.html @@ -1,4 +1,4 @@ -exec | @playform/build - v0.1.0
  • The 'Exec' function is an asynchronous function that executes a command and logs the +exec | @playform/build - v0.1.1

    • The 'Exec' function is an asynchronous function that executes a command and logs the stdout and stderr of the child process.

      Parameters

      • Command: string

        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>

    \ No newline at end of file +

Returns Promise<void>

\ No newline at end of file diff --git a/Documentation/functions/File.file.html b/Documentation/functions/File.file.html index e0064d3b..68bc41a6 100644 --- a/Documentation/functions/File.file.html +++ b/Documentation/functions/File.file.html @@ -1,2 +1,2 @@ -file | @playform/build - v0.1.0
\ No newline at end of file +file | @playform/build - v0.1.1
\ No newline at end of file diff --git a/Documentation/functions/JSON.JSON.html b/Documentation/functions/JSON.JSON.html index 55caa09d..4003de4d 100644 --- a/Documentation/functions/JSON.JSON.html +++ b/Documentation/functions/JSON.JSON.html @@ -1,4 +1,4 @@ -JSON | @playform/build - v0.1.0
  • The function 'JSON' is a TypeScript function that reads a JSON file and returns its +JSON | @playform/build - v0.1.1

    • The function 'JSON' is a TypeScript function that reads a JSON file and returns its parsed content.

      Parameters

      • File: string

        The File parameter is a string that represents the name or path of the JSON file that you want to parse.

        @@ -6,4 +6,4 @@ the directory path from which the JSON file should be loaded. If 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.

        -

      Returns Promise<any>

    \ No newline at end of file +

Returns Promise<any>

\ No newline at end of file diff --git a/Documentation/functions/Merge.merge.html b/Documentation/functions/Merge.merge.html index 6d86efb0..169cdcf4 100644 --- a/Documentation/functions/Merge.merge.html +++ b/Documentation/functions/Merge.merge.html @@ -1 +1 @@ -merge | @playform/build - v0.1.0
  • Type Parameters

    • Ts extends readonly unknown[]

    Parameters

    • Rest ...objects: Ts

    Returns DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeArraysDefaultURI";
        DeepMergeFilterValuesURI: "DeepMergeFilterValuesDefaultURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

\ No newline at end of file +merge | @playform/build - v0.1.1
  • Type Parameters

    • Ts extends readonly unknown[]

    Parameters

    • Rest ...objects: Ts

    Returns DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeArraysDefaultURI";
        DeepMergeFilterValuesURI: "DeepMergeFilterValuesDefaultURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

\ No newline at end of file diff --git a/Documentation/index.html b/Documentation/index.html index ea97b246..841d4152 100644 --- a/Documentation/index.html +++ b/Documentation/index.html @@ -1,20 +1,26 @@ -@playform/build - v0.1.0

@playform/build - v0.1.0

🌀 Build —

Build all your TypeScript files into JavaScript.

+@playform/build - v0.1.1

@playform/build - v0.1.1

🌀 Build —

Builds all your TypeScript files into JavaScript.

Installation

Add configuration and setup scripts:

npm install -D -E @playform/build
 

Usage

Through a command line run:

npx @playform/build 'Source/**/*.ts'
 
+

Help:

+
Usage: Build [options] <File...>

🌀 Build —

Arguments:
File 📝 File —

Options:
-V, --version output the version number
-ES, --ESBuild <File> 📜 ESBuild —
-TS, --TypeScript <File> 📜 TypeScript — (default: "tsconfig.json")
-W --Watch 👁️ Watch —
-h, --help display help for command +

or in a package.json file:

-
{
"scripts": {
"prepublishOnly": "Build 'Source/**/*.ts'"
}
} +
{
"scripts": {
"Run": "Build 'Source/**/*.ts' --Watch",
"prepublishOnly": "Build 'Source/**/*.ts'"
}
}
-

ESBuild Configuration

Or with a custom ESBuild config file:

+

📜 ESBuild Configuration

Or with a custom ESBuild config file:

package.json

{
"scripts": {
"prepublishOnly": "Build 'Source/**/*.ts' --ESBuild ESBuild.ts"
}
}

See an example of a configuration file in ESBuild.ts

-

TypeScript Configuration

tsconfig.json

+

📜 TypeScript Configuration

tsconfig.json

{
"compilerOptions": {
"outDir": "Target"
},
"extends": "@playform/build/tsconfig",
"include": ["Source"]
}
-
\ No newline at end of file +

JSConfig Configuration (optional)

jsconfig.json

+
{
"compilerOptions": {
"outDir": "Target"
},
"extends": "@playform/build/jsconfig",
"include": ["Source"]
} +
+
\ No newline at end of file diff --git a/Documentation/interfaces/Build.Interface.html b/Documentation/interfaces/Build.Interface.html index b710dc4e..cc1b1d46 100644 --- a/Documentation/interfaces/Build.Interface.html +++ b/Documentation/interfaces/Build.Interface.html @@ -1,6 +1,6 @@ -Interface | @playform/build - v0.1.0
interface Interface ((File, Option?) => Promise<void>)
  • Represents a function that processes file patterns.

    +Interface | @playform/build - v0.1.1
    interface Interface ((File, Option?) => Promise<void>)
    • Represents a function that processes file patterns.

      Parameters

      • File: string[]

        An array of file patterns to be processed. Each pattern can include wildcards (*) to match multiple files.

      • Optional Option: {
            ESBuild?: string;
            TypeScript?: string;
            Watch?: boolean;
        }

        An optional object that can contain two properties.

        • Optional ESBuild?: string

          A string representing the ESBuild option.

        • Optional TypeScript?: string

          A string representing the TypeScript option.

          -
        • Optional Watch?: boolean

      Returns Promise<void>

    \ No newline at end of file +
  • Optional Watch?: boolean

Returns Promise<void>

\ No newline at end of file diff --git a/Documentation/interfaces/Exec.Interface.html b/Documentation/interfaces/Exec.Interface.html index af4479b6..ba4d39fb 100644 --- a/Documentation/interfaces/Exec.Interface.html +++ b/Documentation/interfaces/Exec.Interface.html @@ -1,4 +1,4 @@ -Interface | @playform/build - v0.1.0

Interface Interface

interface Interface ((Command, Echo?) => Promise<void>)
  • The 'Exec' function is an asynchronous function that executes a command and logs the +Interface | @playform/build - v0.1.1

    Interface Interface

    interface Interface ((Command, Echo?) => Promise<void>)
    • The 'Exec' function is an asynchronous function that executes a command and logs the stdout and stderr of the child process.

      Parameters

      • Command: string

        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>

    \ No newline at end of file +

Returns Promise<void>

\ No newline at end of file diff --git a/Documentation/interfaces/File.Interface.html b/Documentation/interfaces/File.Interface.html index e6f72559..c79dfb52 100644 --- a/Documentation/interfaces/File.Interface.html +++ b/Documentation/interfaces/File.Interface.html @@ -1,2 +1,2 @@ -Interface | @playform/build - v0.1.0

Interface Interface

interface Interface ((Path) => Promise<any>)
\ No newline at end of file +Interface | @playform/build - v0.1.1

Interface Interface

interface Interface ((Path) => Promise<any>)
\ No newline at end of file diff --git a/Documentation/interfaces/JSON.Interface.html b/Documentation/interfaces/JSON.Interface.html index 6b25fd3a..d7173a6a 100644 --- a/Documentation/interfaces/JSON.Interface.html +++ b/Documentation/interfaces/JSON.Interface.html @@ -1,4 +1,4 @@ -Interface | @playform/build - v0.1.0

Interface Interface

interface Interface ((File, From?) => Promise<any>)
  • The function 'JSON' is a TypeScript function that reads a JSON file and returns its +Interface | @playform/build - v0.1.1

    Interface Interface

    interface Interface ((File, From?) => Promise<any>)
    • The function 'JSON' is a TypeScript function that reads a JSON file and returns its parsed content.

      Parameters

      • File: string

        The File parameter is a string that represents the name or path of the JSON file that you want to parse.

        @@ -6,4 +6,4 @@ the directory path from which the JSON file should be loaded. If 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.

        -

      Returns Promise<any>

    \ No newline at end of file +

Returns Promise<any>

\ No newline at end of file diff --git a/Documentation/modules/Build.html b/Documentation/modules/Build.html index 793b526f..3b26408a 100644 --- a/Documentation/modules/Build.html +++ b/Documentation/modules/Build.html @@ -1,8 +1,8 @@ -Build | @playform/build - v0.1.0

Index

Interfaces

Interface +Build | @playform/build - v0.1.1
\ No newline at end of file +
\ No newline at end of file diff --git a/Documentation/modules/ESBuild.html b/Documentation/modules/ESBuild.html index 3c22161e..b98ae7be 100644 --- a/Documentation/modules/ESBuild.html +++ b/Documentation/modules/ESBuild.html @@ -1,2 +1,2 @@ -ESBuild | @playform/build - v0.1.0
\ No newline at end of file +ESBuild | @playform/build - v0.1.1
\ No newline at end of file diff --git a/Documentation/modules/Exec.html b/Documentation/modules/Exec.html index 74942d2b..d333086e 100644 --- a/Documentation/modules/Exec.html +++ b/Documentation/modules/Exec.html @@ -1,3 +1,3 @@ -Exec | @playform/build - v0.1.0

Index

Interfaces

Interface +Exec | @playform/build - v0.1.1
\ No newline at end of file +
\ No newline at end of file diff --git a/Documentation/modules/File.html b/Documentation/modules/File.html index 39ab1541..66395035 100644 --- a/Documentation/modules/File.html +++ b/Documentation/modules/File.html @@ -1,3 +1,3 @@ -File | @playform/build - v0.1.0

Index

Interfaces

Interface +File | @playform/build - v0.1.1
\ No newline at end of file +
\ No newline at end of file diff --git a/Documentation/modules/JSON.html b/Documentation/modules/JSON.html index 59460a6f..22cd74d2 100644 --- a/Documentation/modules/JSON.html +++ b/Documentation/modules/JSON.html @@ -1,3 +1,3 @@ -JSON | @playform/build - v0.1.0

Index

Interfaces

Interface +JSON | @playform/build - v0.1.1
\ No newline at end of file +
\ No newline at end of file diff --git a/Documentation/modules/Merge.html b/Documentation/modules/Merge.html index 9d0571fb..0abf45f5 100644 --- a/Documentation/modules/Merge.html +++ b/Documentation/modules/Merge.html @@ -1,2 +1,2 @@ -Merge | @playform/build - v0.1.0
\ No newline at end of file +Merge | @playform/build - v0.1.1
\ No newline at end of file diff --git a/Documentation/variables/Build.Current.html b/Documentation/variables/Build.Current.html index 8df43492..3a063f40 100644 --- a/Documentation/variables/Build.Current.html +++ b/Documentation/variables/Build.Current.html @@ -1 +1 @@ -Current | @playform/build - v0.1.0
\ No newline at end of file +Current | @playform/build - v0.1.1
\ No newline at end of file diff --git a/Documentation/variables/Build.Pipe.html b/Documentation/variables/Build.Pipe.html index a7cf458e..9fdb616d 100644 --- a/Documentation/variables/Build.Pipe.html +++ b/Documentation/variables/Build.Pipe.html @@ -1 +1 @@ -Pipe | @playform/build - v0.1.0
\ No newline at end of file +Pipe | @playform/build - v0.1.1
\ No newline at end of file diff --git a/Documentation/variables/Build.build.html b/Documentation/variables/Build.build.html index bd67572e..c4121897 100644 --- a/Documentation/variables/Build.build.html +++ b/Documentation/variables/Build.build.html @@ -1 +1 @@ -build | @playform/build - v0.1.0
\ No newline at end of file +build | @playform/build - v0.1.1
\ No newline at end of file diff --git a/Documentation/variables/ESBuild.ESBuild.html b/Documentation/variables/ESBuild.ESBuild.html index 1a341a24..396f7b84 100644 --- a/Documentation/variables/ESBuild.ESBuild.html +++ b/Documentation/variables/ESBuild.ESBuild.html @@ -1 +1 @@ -ESBuild | @playform/build - v0.1.0
\ No newline at end of file +ESBuild | @playform/build - v0.1.1
\ No newline at end of file diff --git a/Target/Class/Build.js b/Target/Class/Build.js index 72aa281f..b3460d69 100644 --- a/Target/Class/Build.js +++ b/Target/Class/Build.js @@ -1,2 +1,2 @@ #!/usr/bin/env node -var i=new(await import("commander")).Command().name("Build").version("0.1.0").description("\u{1F300}\u2001Build\u2001\u2014").argument("","\u{1F4DD}\u2001File\u2001\u2014").option("-ES, --ESBuild ","\u{1F4DC}\u2001ESBuild\u2001\u2014").option("-TS, --TypeScript ","\u{1F4DC}\u2001TypeScript\u2001\u2014","tsconfig.json").option("-W --Watch","\u{1F441}\uFE0F\u2001Watch\u2001\u2014").action((await import("../Function/Build.js")).default).parse();export{i as default}; +var i=new(await import("commander")).Command().name("Build").version("0.1.1").description("\u{1F300}\u2001Build\u2001\u2014").argument("","\u{1F4DD}\u2001File\u2001\u2014").option("-ES, --ESBuild ","\u{1F4DC}\u2001ESBuild\u2001\u2014").option("-TS, --TypeScript ","\u{1F4DC}\u2001TypeScript\u2001\u2014","tsconfig.json").option("-W --Watch","\u{1F441}\uFE0F\u2001Watch\u2001\u2014").action((await import("../Function/Build.js")).default).parse();export{i as default}; diff --git a/package.json b/package.json index 21e01ddf..ca244711 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@playform/build", - "version": "0.1.0", + "version": "0.1.1", "private": false, "description": "🌀 Build —", "keywords": [