diff --git a/.github/workflows/Node.yml b/.github/workflows/Node.yml index 2fd4da9..d450216 100644 --- a/.github/workflows/Node.yml +++ b/.github/workflows/Node.yml @@ -80,7 +80,7 @@ jobs: cache: "pnpm" cache-dependency-path: ./pnpm-lock.yaml - - run: pnpm install + - run: pnpm install --legacy-peer-deps working-directory: . - run: pnpm run prepublishOnly diff --git a/CHANGELOG.md b/CHANGELOG.md index 43d7b3d..84fcad9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## 0.0.2 + +- Cleanup + ## 0.0.1 - Initial version diff --git a/Documentation/classes/Theme.theme.html b/Documentation/classes/Theme.theme.html index 162bbe8..45669e5 100644 --- a/Documentation/classes/Theme.theme.html +++ b/Documentation/classes/Theme.theme.html @@ -1,4 +1,4 @@ -theme | @playform/document - v0.0.1

Class theme

Hierarchy

  • DefaultTheme
    • theme

Constructors

constructor +theme | @playform/document - v0.0.2

Class theme

Hierarchy

  • DefaultTheme
    • theme

Constructors

constructor

Properties

componentName defaultLayoutTemplate hierarchyTemplate @@ -81,4 +81,4 @@
  • Optional relative: Reflection

    The parent reflection the url generation should stop on.

  • Optional separator: string

    The separator used to generate the url.

    • Returns string

    The generated url.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcomponentNamedefaultLayoutTemplatehierarchyTemplateiconsindexTemplatemarkedPluginreflectionTemplateURL_PREFIX_listenIdapplicationownerbubblebuildNavigationbuildUrlsgetNavigationgetReflectionClassesgetRenderContextgetUrlsinitializelistenTolistenToOnceoffononcerenderstopListeningtriggerapplyAnchorUrlgetUrl

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcomponentNamedefaultLayoutTemplatehierarchyTemplateiconsindexTemplatemarkedPluginreflectionTemplateURL_PREFIX_listenIdapplicationownerbubblebuildNavigationbuildUrlsgetNavigationgetReflectionClassesgetRenderContextgetUrlsinitializelistenTolistenToOnceoffononcerenderstopListeningtriggerapplyAnchorUrlgetUrl

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/functions/Document.Exec.html b/Documentation/functions/Document.Exec.html index 8b4df32..dbe2b96 100644 --- a/Documentation/functions/Document.Exec.html +++ b/Documentation/functions/Document.Exec.html @@ -1,4 +1,4 @@ -Exec | @playform/document - v0.0.1

    Function Exec

    • Exec(Command, Echo?): Promise<void>

    • The 'Exec' function is an asynchronous function that executes a command and logs the +Exec | @playform/document - v0.0.2

      Function Exec

      • Exec(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>

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/functions/Document.document.html b/Documentation/functions/Document.document.html index 8fa9132..a06dda8 100644 --- a/Documentation/functions/Document.document.html +++ b/Documentation/functions/Document.document.html @@ -1,6 +1,6 @@ -document | @playform/document - v0.0.1

    Function document

    • document(File, Option?): Promise<void>

    • Represents a function that processes file patterns.

      +document | @playform/document - v0.0.2

      Function document

      • document(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;
          }

          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.

            -

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/functions/Document.resolve.html b/Documentation/functions/Document.resolve.html index 7ba9a3b..7def681 100644 --- a/Documentation/functions/Document.resolve.html +++ b/Documentation/functions/Document.resolve.html @@ -1,4 +1,4 @@ -resolve | @playform/document - v0.0.1

    Function resolve

    • resolve(...paths): string

    • The right-most parameter is considered {to}. Other parameters are considered an array of {from}.

      +resolve | @playform/document - v0.0.2

      Function resolve

      • resolve(...paths): string

      • The right-most parameter is considered {to}. Other parameters are considered an array of {from}.

        Starting from leftmost {from} parameter, resolves {to} to an absolute path.

        If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, @@ -6,4 +6,4 @@ and trailing slashes are removed unless the path gets resolved to the root directory.

        Parameters

        • Rest ...paths: string[]

          A sequence of paths or path segments.

        Returns string

        Throws

        if any of the arguments is not a string.

        -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/functions/Exec.exec.html b/Documentation/functions/Exec.exec.html index 45a1fb9..3e28e92 100644 --- a/Documentation/functions/Exec.exec.html +++ b/Documentation/functions/Exec.exec.html @@ -1,4 +1,4 @@ -exec | @playform/document - v0.0.1

    Function exec

    • exec(Command, Echo?): Promise<void>

    • The 'Exec' function is an asynchronous function that executes a command and logs the +exec | @playform/document - v0.0.2

      Function exec

      • exec(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>

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/functions/JSON.JSON.html b/Documentation/functions/JSON.JSON.html index d4ec86e..23395b5 100644 --- a/Documentation/functions/JSON.JSON.html +++ b/Documentation/functions/JSON.JSON.html @@ -1,4 +1,4 @@ -JSON | @playform/document - v0.0.1

    Function JSON

    • JSON(File, From?): Promise<any>

    • The function 'JSON' is a TypeScript function that reads a JSON file and returns its +JSON | @playform/document - v0.0.2

      Function JSON

      • JSON(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>

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +

    Returns Promise<any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/functions/Load.load-1.html b/Documentation/functions/Load.load-1.html index 7f57a47..b2f46d9 100644 --- a/Documentation/functions/Load.load-1.html +++ b/Documentation/functions/Load.load-1.html @@ -1 +1 @@ -load | @playform/document - v0.0.1

    Function load

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +load | @playform/document - v0.0.2

    Function load

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/index.html b/Documentation/index.html index 30051e7..ecc4a1a 100644 --- a/Documentation/index.html +++ b/Documentation/index.html @@ -1,8 +1,8 @@ -@playform/document - v0.0.1

    @playform/document - v0.0.1

    📃 TypeScriptDocument

    Document all your TypeScript files using TypeDoc.

    +@playform/document - v0.0.2

    @playform/document - v0.0.2

    📃 TypeScriptDocument

    Document all your TypeScript files using TypeDoc.

    Installation

    Add configuration and setup scripts:

    npm install -D -E @playform/document

    Usage

    package.json

    {
        "scripts": {
            "Document": "TypeScriptDocument 'Source/**/*.ts'"
        }
    }
    -

    Settings

    Member Visibility

    Theme

    On This Page

    📃 TypeScriptDocument

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    📃 TypeScriptDocument

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/Build.Type.html b/Documentation/interfaces/Build.Type.html index 9629082..1c8398c 100644 --- a/Documentation/interfaces/Build.Type.html +++ b/Documentation/interfaces/Build.Type.html @@ -1,6 +1,6 @@ -Type | @playform/document - v0.0.1

    Interface Type

    interface Type ((File, Option?) => Promise<void>)
    • Type(File, Option?): Promise<void>

    • Represents a function that processes file patterns.

      +Type | @playform/document - v0.0.2

      Interface Type

      interface Type ((File, Option?) => Promise<void>)
      • Type(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;
          }

          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.

            -

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/Exec.Type.html b/Documentation/interfaces/Exec.Type.html index 6b95bf5..6014086 100644 --- a/Documentation/interfaces/Exec.Type.html +++ b/Documentation/interfaces/Exec.Type.html @@ -1,4 +1,4 @@ -Type | @playform/document - v0.0.1

    Interface Type

    interface Type ((Command, Echo?) => Promise<void>)
    • Type(Command, Echo?): Promise<void>

    • The 'Exec' function is an asynchronous function that executes a command and logs the +Type | @playform/document - v0.0.2

      Interface Type

      interface Type ((Command, Echo?) => Promise<void>)
      • Type(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>

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/Interface_Mapping.Type.html b/Documentation/interfaces/Interface_Mapping.Type.html index f6e46da..e75c1ba 100644 --- a/Documentation/interfaces/Interface_Mapping.Type.html +++ b/Documentation/interfaces/Interface_Mapping.Type.html @@ -1,5 +1,5 @@ -Type | @playform/document - v0.0.1

    Interface Type

    interface Type {
        Directory: string;
        Kind: ReflectionKind[];
    }

    Properties

    Directory +Type | @playform/document - v0.0.2

    Interface Type

    interface Type {
        Directory: string;
        Kind: ReflectionKind[];
    }

    Properties

    Directory Kind

    Properties

    Directory

    Directory: string

    The name of the directory the output files should be written to.

    -

    Kind

    Kind: ReflectionKind[]

    DeclarationReflection.kind this rule applies to.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    DirectoryKind

    Generated using TypeDoc

    \ No newline at end of file +

    Kind

    Kind: ReflectionKind[]

    DeclarationReflection.kind this rule applies to.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    DirectoryKind

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/Interface_Theme.Type.html b/Documentation/interfaces/Interface_Theme.Type.html index 21f604b..93ef0c0 100644 --- a/Documentation/interfaces/Interface_Theme.Type.html +++ b/Documentation/interfaces/Interface_Theme.Type.html @@ -1,4 +1,4 @@ -Type | @playform/document - v0.0.1

    Interface Type

    interface Type {
        Mapping: Type[];
        _Mapping: ((Reflection) => undefined | Type);
        buildUrls: ((Reflection, URLs) => UrlMapping<any>[]);
        componentName: string;
        defaultLayoutTemplate: ((pageEvent, template) => JsxElement);
        hierarchyTemplate: ((pageEvent) => JsxElement);
        icons: {
            1: (() => JsxElement);
            1024: (() => JsxElement);
            1048576: (() => JsxElement);
            128: (() => JsxElement);
            131072: (() => JsxElement);
            16: (() => JsxElement);
            16384: (() => JsxElement);
            2: (() => JsxElement);
            2048: (() => JsxElement);
            2097152: (() => JsxElement);
            256: (() => JsxElement);
            262144: (() => JsxElement);
            32: (() => JsxElement);
            32768: (() => JsxElement);
            4: (() => JsxElement);
            4096: (() => JsxElement);
            4194304: (() => JsxElement);
            512: (() => JsxElement);
            524288: (() => JsxElement);
            64: (() => JsxElement);
            65536: (() => JsxElement);
            8: (() => JsxElement);
            8192: (() => JsxElement);
            anchor: (() => JsxElement);
            checkbox: (() => JsxElement);
            chevronDown: (() => JsxElement);
            chevronSmall: (() => JsxElement);
            menu: (() => JsxElement);
            search: (() => JsxElement);
        };
        indexTemplate: ((pageEvent) => JsxElement);
        markedPlugin: MarkedPlugin;
        reflectionTemplate: ((pageEvent) => JsxElement);
        get _listenId(): any;
        get application(): Application;
        get owner(): O;
        bubble(name, ...args): this;
        buildNavigation(project): NavigationElement[];
        getNavigation(project): NavigationElement[];
        getReflectionClasses(reflection): string;
        getRenderContext(pageEvent): DefaultThemeRenderContext;
        getUrls(project): UrlMapping<any>[];
        initialize(): void;
        listenTo(obj, name, callback?, priority?): this;
        listenToOnce(obj, eventMap): this;
        listenToOnce(obj, name, callback, priority?): this;
        off(): this;
        off(eventMap, context?): this;
        off(name, callback?, context?): this;
        on(eventMap, context?): this;
        on(eventMap, callback?, context?, priority?): this;
        on(name, callback, context?, priority?): this;
        once(eventMap, context?): this;
        once(name, callback, context?, priority?): this;
        render(page, template): string;
        stopListening(obj?, name?, callback?): this;
        trigger(name, ...args): this;
    }

    Hierarchy

    • DefaultTheme
      • Type

    Properties

    Mapping +Type | @playform/document - v0.0.2

    Interface Type

    interface Type {
        Mapping: Type[];
        _Mapping: ((Reflection) => undefined | Type);
        buildUrls: ((Reflection, URLs) => UrlMapping<any>[]);
        componentName: string;
        defaultLayoutTemplate: ((pageEvent, template) => JsxElement);
        hierarchyTemplate: ((pageEvent) => JsxElement);
        icons: {
            1: (() => JsxElement);
            1024: (() => JsxElement);
            1048576: (() => JsxElement);
            128: (() => JsxElement);
            131072: (() => JsxElement);
            16: (() => JsxElement);
            16384: (() => JsxElement);
            2: (() => JsxElement);
            2048: (() => JsxElement);
            2097152: (() => JsxElement);
            256: (() => JsxElement);
            262144: (() => JsxElement);
            32: (() => JsxElement);
            32768: (() => JsxElement);
            4: (() => JsxElement);
            4096: (() => JsxElement);
            4194304: (() => JsxElement);
            512: (() => JsxElement);
            524288: (() => JsxElement);
            64: (() => JsxElement);
            65536: (() => JsxElement);
            8: (() => JsxElement);
            8192: (() => JsxElement);
            anchor: (() => JsxElement);
            checkbox: (() => JsxElement);
            chevronDown: (() => JsxElement);
            chevronSmall: (() => JsxElement);
            menu: (() => JsxElement);
            search: (() => JsxElement);
        };
        indexTemplate: ((pageEvent) => JsxElement);
        markedPlugin: MarkedPlugin;
        reflectionTemplate: ((pageEvent) => JsxElement);
        get _listenId(): any;
        get application(): Application;
        get owner(): O;
        bubble(name, ...args): this;
        buildNavigation(project): NavigationElement[];
        getNavigation(project): NavigationElement[];
        getReflectionClasses(reflection): string;
        getRenderContext(pageEvent): DefaultThemeRenderContext;
        getUrls(project): UrlMapping<any>[];
        initialize(): void;
        listenTo(obj, name, callback?, priority?): this;
        listenToOnce(obj, eventMap): this;
        listenToOnce(obj, name, callback, priority?): this;
        off(): this;
        off(eventMap, context?): this;
        off(name, callback?, context?): this;
        on(eventMap, context?): this;
        on(eventMap, callback?, context?, priority?): this;
        on(name, callback, context?, priority?): this;
        once(eventMap, context?): this;
        once(name, callback, context?, priority?): this;
        render(page, template): string;
        stopListening(obj?, name?, callback?): this;
        trigger(name, ...args): this;
    }

    Hierarchy

    • DefaultTheme
      • Type

    Properties

    Mapping _Mapping buildUrls componentName @@ -27,12 +27,12 @@ stopListening trigger

    Properties

    Mapping

    Mapping: Type[]

    An array of Mappings representing the theme's mapping configuration.

    -

    _Mapping

    _Mapping: ((Reflection) => undefined | Type)

    A function that maps a DeclarationReflection to a Mapping or returns undefined.

    +

    _Mapping

    _Mapping: ((Reflection) => undefined | Type)

    A function that maps a DeclarationReflection to a Mapping or returns undefined.

    Type declaration

      • (Reflection): undefined | Type

      • Parameters

        • Reflection: DeclarationReflection

          The DeclarationReflection to map to a Mapping.

          -

        Returns undefined | Type

    buildUrls

    buildUrls: ((Reflection, URLs) => UrlMapping<any>[])

    A function that builds URLs for a given DeclarationReflection and an array of URLs mappings.

    +

    Returns undefined | Type

    buildUrls

    buildUrls: ((Reflection, URLs) => UrlMapping<any>[])

    A function that builds URLs for a given DeclarationReflection and an array of URLs mappings.

    Type declaration

      • (Reflection, URLs): UrlMapping<any>[]

      • Parameters

        • Reflection: DeclarationReflection

          The DeclarationReflection for which URLs are being built.

        • URLs: UrlMapping<any>[]

          An array of URLs mappings with any data type.

          -

        Returns UrlMapping<any>[]

    componentName

    componentName: string

    The name of this component as set by the @Component decorator.

    +

    Returns UrlMapping<any>[]

    componentName

    componentName: string

    The name of this component as set by the @Component decorator.

    defaultLayoutTemplate

    defaultLayoutTemplate: ((pageEvent, template) => JsxElement)

    Type declaration

      • (pageEvent, template): JsxElement

      • Parameters

        • pageEvent: PageEvent<Reflection>
        • template: RenderTemplate<PageEvent<Reflection>>

        Returns JsxElement

    hierarchyTemplate

    hierarchyTemplate: ((pageEvent) => JsxElement)

    Type declaration

      • (pageEvent): JsxElement

      • Parameters

        • pageEvent: PageEvent<ProjectReflection>

        Returns JsxElement

    icons

    icons: {
        1: (() => JsxElement);
        1024: (() => JsxElement);
        1048576: (() => JsxElement);
        128: (() => JsxElement);
        131072: (() => JsxElement);
        16: (() => JsxElement);
        16384: (() => JsxElement);
        2: (() => JsxElement);
        2048: (() => JsxElement);
        2097152: (() => JsxElement);
        256: (() => JsxElement);
        262144: (() => JsxElement);
        32: (() => JsxElement);
        32768: (() => JsxElement);
        4: (() => JsxElement);
        4096: (() => JsxElement);
        4194304: (() => JsxElement);
        512: (() => JsxElement);
        524288: (() => JsxElement);
        64: (() => JsxElement);
        65536: (() => JsxElement);
        8: (() => JsxElement);
        8192: (() => JsxElement);
        anchor: (() => JsxElement);
        checkbox: (() => JsxElement);
        chevronDown: (() => JsxElement);
        chevronSmall: (() => JsxElement);
        menu: (() => JsxElement);
        search: (() => JsxElement);
    }

    The icons which will actually be rendered. The source of truth lives on the theme, and the DefaultThemeRenderContext.icons member will produce references to these.

    These icons will be written twice. Once to an icons.svg file in the assets directory @@ -71,4 +71,4 @@ passed the same arguments as trigger is, apart from the event name (unless you're listening on "all", which will cause your callback to receive the true name of the event as the first argument).

    -

    Parameters

    • name: string | Event | EventMap
    • Rest ...args: any[]

    Returns this

    Settings

    Member Visibility

    Theme

    On This Page

    Mapping_MappingbuildUrlscomponentNamedefaultLayoutTemplatehierarchyTemplateiconsindexTemplatemarkedPluginreflectionTemplate_listenIdapplicationownerbubblebuildNavigationgetNavigationgetReflectionClassesgetRenderContextgetUrlsinitializelistenTolistenToOnceoffononcerenderstopListeningtrigger

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns this

    Settings

    Member Visibility

    Theme

    On This Page

    Mapping_MappingbuildUrlscomponentNamedefaultLayoutTemplatehierarchyTemplateiconsindexTemplatemarkedPluginreflectionTemplate_listenIdapplicationownerbubblebuildNavigationgetNavigationgetReflectionClassesgetRenderContextgetUrlsinitializelistenTolistenToOnceoffononcerenderstopListeningtrigger

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/JSON.Type.html b/Documentation/interfaces/JSON.Type.html index b005cdc..73cd890 100644 --- a/Documentation/interfaces/JSON.Type.html +++ b/Documentation/interfaces/JSON.Type.html @@ -1,4 +1,4 @@ -Type | @playform/document - v0.0.1

    Interface Type

    interface Type ((File, From?) => Promise<any>)
    • Type(File, From?): Promise<any>

    • The function 'JSON' is a TypeScript function that reads a JSON file and returns its +Type | @playform/document - v0.0.2

      Interface Type

      interface Type ((File, From?) => Promise<any>)
      • Type(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>

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +

    Returns Promise<any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/Load.Type.html b/Documentation/interfaces/Load.Type.html index 5b8d8bf..c697294 100644 --- a/Documentation/interfaces/Load.Type.html +++ b/Documentation/interfaces/Load.Type.html @@ -1,5 +1,5 @@ -Type | @playform/document - v0.0.1

    Interface Type

    interface Type {
        load: ((Application) => void);
    }

    Properties

    load +Type | @playform/document - v0.0.2

    Interface Type

    interface Type {
        load: ((Application) => void);
    }

    Properties

    load

    Properties

    load

    load: ((Application) => void)

    The Load function is responsible for loading a plugin into the TypeDoc instance.

    Type declaration

      • (Application): void

      • Parameters

        • Application: Application

          The Application parameter is an instance of TypeDoc's Application class, representing the TypeDoc application to which the plugin should be loaded.

          -

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    load

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    load

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Build.html b/Documentation/modules/Build.html index 765d7a2..8430931 100644 --- a/Documentation/modules/Build.html +++ b/Documentation/modules/Build.html @@ -1,2 +1,2 @@ -Build | @playform/document - v0.0.1

    Module Build

    Index

    Interfaces

    Type -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Build | @playform/document - v0.0.2

    Module Build

    Index

    Interfaces

    Type +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Document.html b/Documentation/modules/Document.html index 080cf56..350ab8b 100644 --- a/Documentation/modules/Document.html +++ b/Documentation/modules/Document.html @@ -1,6 +1,6 @@ -Document | @playform/document - v0.0.1

    Module Document

    Index

    Variables

    Current +Document | @playform/document - v0.0.2

    Module Document

    Index

    Variables

    Current Pipe

    Functions

    Exec document resolve -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Exec.html b/Documentation/modules/Exec.html index 76787d4..f85fbc1 100644 --- a/Documentation/modules/Exec.html +++ b/Documentation/modules/Exec.html @@ -1,3 +1,3 @@ -Exec | @playform/document - v0.0.1

    Module Exec

    Index

    Interfaces

    Type +Exec | @playform/document - v0.0.2

    Module Exec

    Index

    Interfaces

    Type

    Functions

    exec -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Interface_Mapping.html b/Documentation/modules/Interface_Mapping.html index daa462f..89df769 100644 --- a/Documentation/modules/Interface_Mapping.html +++ b/Documentation/modules/Interface_Mapping.html @@ -1,2 +1,2 @@ -Interface/Mapping | @playform/document - v0.0.1

    Module Interface/Mapping

    Index

    Interfaces

    Type -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Interface/Mapping | @playform/document - v0.0.2

    Module Interface/Mapping

    Index

    Interfaces

    Type +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Interface_Theme.html b/Documentation/modules/Interface_Theme.html index a2f1b53..8035b9d 100644 --- a/Documentation/modules/Interface_Theme.html +++ b/Documentation/modules/Interface_Theme.html @@ -1,2 +1,2 @@ -Interface/Theme | @playform/document - v0.0.1

    Module Interface/Theme

    Index

    Interfaces

    Type -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Interface/Theme | @playform/document - v0.0.2

    Module Interface/Theme

    Index

    Interfaces

    Type +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/JSON.html b/Documentation/modules/JSON.html index 4715f65..2c9ac71 100644 --- a/Documentation/modules/JSON.html +++ b/Documentation/modules/JSON.html @@ -1,3 +1,3 @@ -JSON | @playform/document - v0.0.1

    Module JSON

    Index

    Interfaces

    Type +JSON | @playform/document - v0.0.2

    Module JSON

    Index

    Interfaces

    Type

    Functions

    JSON -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Load.html b/Documentation/modules/Load.html index d241fe3..a72e5c0 100644 --- a/Documentation/modules/Load.html +++ b/Documentation/modules/Load.html @@ -1,5 +1,5 @@ -Load | @playform/document - v0.0.1

    Module Load

    Index

    Interfaces

    Type +Load | @playform/document - v0.0.2

    Module Load

    Index

    Interfaces

    Type

    Variables

    Theme load

    Functions

    load -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Theme.html b/Documentation/modules/Theme.html index 703658d..b8a4b1f 100644 --- a/Documentation/modules/Theme.html +++ b/Documentation/modules/Theme.html @@ -1,2 +1,2 @@ -Theme | @playform/document - v0.0.1

    Module Theme

    Index

    Classes

    theme -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Theme | @playform/document - v0.0.2

    Module Theme

    Index

    Classes

    theme +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/TypeScriptDocument.html b/Documentation/modules/TypeScriptDocument.html index 0f4317f..083a9ec 100644 --- a/Documentation/modules/TypeScriptDocument.html +++ b/Documentation/modules/TypeScriptDocument.html @@ -1,2 +1,2 @@ -TypeScriptDocument | @playform/document - v0.0.1

    Module TypeScriptDocument

    Index

    Variables

    typeScriptDocument -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +TypeScriptDocument | @playform/document - v0.0.2

    Module TypeScriptDocument

    Index

    Variables

    typeScriptDocument +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/variables/Document.Current.html b/Documentation/variables/Document.Current.html index fa294cf..d304ce0 100644 --- a/Documentation/variables/Document.Current.html +++ b/Documentation/variables/Document.Current.html @@ -1 +1 @@ -Current | @playform/document - v0.0.1

    Variable CurrentConst

    Current: string = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Current | @playform/document - v0.0.2

    Variable CurrentConst

    Current: string = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/variables/Document.Pipe.html b/Documentation/variables/Document.Pipe.html index 6556256..37017d8 100644 --- a/Documentation/variables/Document.Pipe.html +++ b/Documentation/variables/Document.Pipe.html @@ -1 +1 @@ -Pipe | @playform/document - v0.0.1

    Variable PipeConst

    Pipe: string[] = []

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Pipe | @playform/document - v0.0.2

    Variable PipeConst

    Pipe: string[] = []

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/variables/Load.Theme.html b/Documentation/variables/Load.Theme.html index c74c38a..5394a93 100644 --- a/Documentation/variables/Load.Theme.html +++ b/Documentation/variables/Load.Theme.html @@ -1 +1 @@ -Theme | @playform/document - v0.0.1

    Variable Theme

    Theme: typeof theme

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Theme | @playform/document - v0.0.2

    Variable Theme

    Theme: typeof theme

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/variables/Load.load.html b/Documentation/variables/Load.load.html index f664ee5..4a62d7d 100644 --- a/Documentation/variables/Load.load.html +++ b/Documentation/variables/Load.load.html @@ -1 +1 @@ -load | @playform/document - v0.0.1

    Variable load

    load: Type

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +load | @playform/document - v0.0.2

    Variable load

    load: Type

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/variables/TypeScriptDocument.typeScriptDocument.html b/Documentation/variables/TypeScriptDocument.typeScriptDocument.html index 1b82bb3..5ea7540 100644 --- a/Documentation/variables/TypeScriptDocument.typeScriptDocument.html +++ b/Documentation/variables/TypeScriptDocument.typeScriptDocument.html @@ -1 +1 @@ -typeScriptDocument | @playform/document - v0.0.1

    Variable typeScriptDocument

    typeScriptDocument: Command

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +typeScriptDocument | @playform/document - v0.0.2

    Variable typeScriptDocument

    typeScriptDocument: Command

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Target/Class/TypeScriptDocument.js b/Target/Class/TypeScriptDocument.js index 85a27a6..d511b0a 100644 --- a/Target/Class/TypeScriptDocument.js +++ b/Target/Class/TypeScriptDocument.js @@ -1,2 +1,2 @@ #!/usr/bin/env node -var e=new(await import("commander")).Command().name("TypeScriptDocument").version("0.0.1").description("\u{1F4C3}\u2000Document TypeScript.").argument("","Document File.").action((await import("../Function/Document.js")).default).parse();export{e as default}; +var e=new(await import("commander")).Command().name("TypeScriptDocument").version("0.0.2").description("\u{1F4C3}\u2000Document TypeScript.").argument("","Document File.").action((await import("../Function/Document.js")).default).parse();export{e as default}; diff --git a/package.json b/package.json index e927356..454a367 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@playform/document", - "version": "0.0.1", + "version": "0.0.2", "private": false, "description": "📃 TypeDoc Wrapper.", "keywords": ["documentation", "javascript", "typedoc", "typescript"], @@ -25,7 +25,7 @@ "TypeScriptDocument": "Target/Class/TypeScriptDocument.js" }, "scripts": { - "Document": "TypeScriptDocument 'Source/**/*.ts'", + "Document": "node --no-warnings --loader ts-node/esm Source/Class/TypeScriptDocument.ts 'Source/**/*.ts'", "prepublishOnly": "TypeScriptESBuild 'Source/**/*.ts' -ES Configuration/ESBuild.ts" }, "dependencies": { @@ -43,9 +43,6 @@ "esbuild-plugin-copy": "2.1.1", "@playform/build": "0.0.1" }, - "optionalDependencies": { - "@playform/document": "0.0.1" - }, "publishConfig": { "access": "public" }