Thanks to visit codestin.com
Credit goes to github.com

Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 111 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
# This file contains environment variables that are used by the project.
# Copy this file to .env and fill in the values for your local development.

# -----------------------------------------------------------------------------
# General Development
# -----------------------------------------------------------------------------

# Sets the node environment. It's typically 'development' or 'production'.
# The test environment is automatically set to 'test' when running tests.
NODE_ENV=development

# When set to '1', this variable disables colored output in the console.
# NO_COLOR=1

# When set to '1', this variable silences all reporters.
WPK_SILENT_REPORTERS=1

# When set to 'true', this variable enables debug mode in WordPress.
# WP_DEBUG=false

# -----------------------------------------------------------------------------
# Continuous Integration
# -----------------------------------------------------------------------------

# This variable is typically set to 'true' in CI environments.
# It's used to enable or disable certain features when running in CI.
# CI=false

# -----------------------------------------------------------------------------
# Testing
# -----------------------------------------------------------------------------

# Sets the test environment. It can be 'wp-env' or 'playground'.
WPK_TEST_ENV=wp-env

# When set to '1', this variable skips integration tests.
WPK_JEST_SKIP_INTEGRATION=0

# -----------------------------------------------------------------------------
# PHP
# -----------------------------------------------------------------------------

# Sets the memory limit for PHP.
WPK_PHP_MEMORY_LIMIT=512M

# A comma-separated list of paths to PHP files that should be autoloaded by the PHP driver.
WPK_PHP_DRIVER_AUTOLOAD_PATHS=

# A comma-separated list of paths to PHP files that should be autoloaded by wp-kernel.
WPK_PHP_AUTOLOAD_PATHS=

# Path to the PHP binary.
WPK_PHP_BINARY=

# -----------------------------------------------------------------------------
# CLI
# -----------------------------------------------------------------------------

# When set to '1', this variable indicates that the code is running in a pre-commit hook.
# PRECOMMIT=0

# The root directory of the wp-kernel repository.
WPKERNEL_REPO_ROOT=

# The initial working directory when the process was started.
# INIT_CWD=

# When set to '1', this variable forces the CLI to prefer versions from the registry.
WPK_PREFER_REGISTRY_VERSIONS=0

# The URL of the npm registry to use.
# REGISTRY_URL=https://registry.npmjs.org/

# The import.meta.url of the CLI.
WPK_CLI_IMPORT_META_URL=

# The path to the composer binary.
WPK_CLI_COMPOSER_BIN=composer

# -----------------------------------------------------------------------------
# Documentation
# -----------------------------------------------------------------------------

# When set to '1', this variable forces the documentation API to be rebuilt.
WPK_DOCS_API_FORCE=0

# -----------------------------------------------------------------------------
# Gutenberg
# -----------------------------------------------------------------------------

# The path to the Gutenberg repository.
WPK_GUTENBERG_PATH=

# -----------------------------------------------------------------------------
# Miscellaneous
# -----------------------------------------------------------------------------

# The version of the npm package.
# npm_package_version=

# The system's PATH environment variable.
# PATH=

# Custom environment variable for testing.
WPK_CUSTOM_ENV=

# Base environment variable for testing.
WPK_BASE_ENV=

# Extra environment variable for testing.
WPK_EXTRA_ENV=
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -106,4 +106,5 @@ information/
gutenberg/
gutenberg
**/AGENTS.md
docs/internal/
docs/internal/
artifacts/
493 changes: 200 additions & 293 deletions docs/.vitepress/critical-create-generate-failure.md

Large diffs are not rendered by default.

39 changes: 36 additions & 3 deletions docs/api/@wpkernel/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ wpk and UI packages.

- [ConfirmPromptOptions](interfaces/ConfirmPromptOptions.md)
- [EnsureCleanDirectoryOptions](interfaces/EnsureCleanDirectoryOptions.md)
- [EnsureGeneratedPhpCleanOptions](interfaces/EnsureGeneratedPhpCleanOptions.md)
- [FileManifest](interfaces/FileManifest.md)
- [MergeMarkers](interfaces/MergeMarkers.md)
- [MergeOptions](interfaces/MergeOptions.md)
Expand Down Expand Up @@ -111,7 +110,6 @@ wpk and UI packages.
- [BuildDefaultReadinessRegistryOptions](interfaces/BuildDefaultReadinessRegistryOptions.md)
- [BuildGenerateCommandOptions](interfaces/BuildGenerateCommandOptions.md)
- [ComposerHelperDependencies](interfaces/ComposerHelperDependencies.md)
- [ComposerHelperOverrides](interfaces/ComposerHelperOverrides.md)
- [ComposerReadinessState](interfaces/ComposerReadinessState.md)
- [CreateBackupsOptions](interfaces/CreateBackupsOptions.md)
- [CreateHelperOptions](interfaces/CreateHelperOptions.md)
Expand Down Expand Up @@ -143,10 +141,17 @@ wpk and UI packages.
- [PhpCodemodIngestionDependencies](interfaces/PhpCodemodIngestionDependencies.md)
- [PhpCodemodIngestionState](interfaces/PhpCodemodIngestionState.md)
- [PhpDriverConfigurationOptions](interfaces/PhpDriverConfigurationOptions.md)
<<<<<<< HEAD
- [PhpPrinterPathDependencies](interfaces/PhpPrinterPathDependencies.md)
- [PhpPrinterPathState](interfaces/PhpPrinterPathState.md)
||||||| 86d024df
- [PhpDriverDependencies](interfaces/PhpDriverDependencies.md)
- # [PhpDriverState](interfaces/PhpDriverState.md)
- [PhpDriverDependencies](interfaces/PhpDriverDependencies.md)
- [PhpDriverState](interfaces/PhpDriverState.md)
- [PhpPrinterPathDependencies](interfaces/PhpPrinterPathDependencies.md)
- [PhpPrinterPathState](interfaces/PhpPrinterPathState.md)
> > > > > > > upstream/main
- [PhpRuntimeDependencies](interfaces/PhpRuntimeDependencies.md)
- [PhpRuntimeState](interfaces/PhpRuntimeState.md)
- [QuickstartDependencies](interfaces/QuickstartDependencies.md)
Expand All @@ -168,6 +173,7 @@ wpk and UI packages.
- [ReleasePackState](interfaces/ReleasePackState.md)
- [TsxRuntimeDependencies](interfaces/TsxRuntimeDependencies.md)
- [TsxRuntimeState](interfaces/TsxRuntimeState.md)
- [WorkspaceGitStatusEntry](interfaces/WorkspaceGitStatusEntry.md)
- [WorkspaceHygieneDependencies](interfaces/WorkspaceHygieneDependencies.md)
- [WorkspaceHygieneState](interfaces/WorkspaceHygieneState.md)

Expand Down Expand Up @@ -241,6 +247,7 @@ wpk and UI packages.
- [ReadinessOutcomeStatus](type-aliases/ReadinessOutcomeStatus.md)
- [ReadinessStatus](type-aliases/ReadinessStatus.md)
- [ScaffoldStatus](type-aliases/ScaffoldStatus.md)
- [WorkspaceGitStatus](type-aliases/WorkspaceGitStatus.md)

## Variables

Expand Down Expand Up @@ -291,7 +298,6 @@ wpk and UI packages.

- [buildWorkspace](functions/buildWorkspace.md)
- [ensureCleanDirectory](functions/ensureCleanDirectory.md)
- [ensureGeneratedPhpClean](functions/ensureGeneratedPhpClean.md)
- [promptConfirm](functions/promptConfirm.md)

### IR
Expand Down Expand Up @@ -319,6 +325,25 @@ wpk and UI packages.

- [createTsCapabilityBuilder](functions/createTsCapabilityBuilder.md)
- [createTsIndexBuilder](functions/createTsIndexBuilder.md)
<<<<<<< HEAD

### Other

- [assertReadinessRun](functions/assertReadinessRun.md)
- [buildDefaultReadinessRegistry](functions/buildDefaultReadinessRegistry.md)
- [createBootstrapperResolutionReadinessHelper](functions/createBootstrapperResolutionReadinessHelper.md)
- [createComposerReadinessHelper](functions/createComposerReadinessHelper.md)
- [createGitReadinessHelper](functions/createGitReadinessHelper.md)
- [createPhpCodemodIngestionReadinessHelper](functions/createPhpCodemodIngestionReadinessHelper.md)
- [createPhpDriverInstaller](functions/createPhpDriverInstaller.md)
- [createPhpPrinterPathReadinessHelper](functions/createPhpPrinterPathReadinessHelper.md)
- [createPhpRuntimeReadinessHelper](functions/createPhpRuntimeReadinessHelper.md)
- [createQuickstartReadinessHelper](functions/createQuickstartReadinessHelper.md)
- [createReadinessHelper](functions/createReadinessHelper.md)
- [createReadinessRegistry](functions/createReadinessRegistry.md)
- [createReleasePackReadinessHelper](functions/createReleasePackReadinessHelper.md)
||||||| 86d024df
=======

### Other

Expand All @@ -336,8 +361,16 @@ wpk and UI packages.
- [createReadinessHelper](functions/createReadinessHelper.md)
- [createReadinessRegistry](functions/createReadinessRegistry.md)
- [createReleasePackReadinessHelper](functions/createReleasePackReadinessHelper.md)
> > > > > > > upstream/main
- [createTsxRuntimeReadinessHelper](functions/createTsxRuntimeReadinessHelper.md)
- [createWorkspaceHygieneReadinessHelper](functions/createWorkspaceHygieneReadinessHelper.md)
<<<<<<< HEAD
- [readWorkspaceGitStatus](functions/readWorkspaceGitStatus.md)
- [registerDefaultReadinessHelpers](functions/registerDefaultReadinessHelpers.md)
- [registerReadinessHelperFactories](functions/registerReadinessHelperFactories.md)
||||||| 86d024df
=======
- [registerDefaultReadinessHelpers](functions/registerDefaultReadinessHelpers.md)
- [registerReadinessHelperFactories](functions/registerReadinessHelperFactories.md)
> > > > > > > upstream/main
- [toWorkspaceRelative](functions/toWorkspaceRelative.md)
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ComposerReadinessState & gt;

### overrides

[`ComposerHelperOverrides`](../interfaces/ComposerHelperOverrides.md) = `{}`
`Partial`\<[`ComposerHelperDependencies`](../interfaces/ComposerHelperDependencies.md)\> = `{}`

## Returns

Expand Down
22 changes: 0 additions & 22 deletions docs/api/@wpkernel/cli/functions/createPhpDriverReadinessHelper.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@
# Function: createPhpRuntimeReadinessHelper()

```ts
function createPhpRuntimeReadinessHelper(
overrides
): ReadinessHelper<PhpRuntimeState>;
function createPhpRuntimeReadinessHelper(overrides): ReadinessHelper & lt;
PhpRuntimeState & gt;
```

## Parameters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
<<<<<<< HEAD
[**@wpkernel/cli v0.12.1-beta.3**](../README.md)

---

[@wpkernel/cli](../README.md) / createQuickstartReadinessHelper

# Function: createQuickstartReadinessHelper()

```ts
function createQuickstartReadinessHelper(options): ReadinessHelper & lt;
QuickstartState & gt;
```

## Parameters

### options

[`QuickstartHelperOptions`](../interfaces/QuickstartHelperOptions.md) = `{}`

## Returns

[`ReadinessHelper`](../interfaces/ReadinessHelper.md)\<[`QuickstartState`](../interfaces/QuickstartState.md)\>
||||||| 86d024df
=======
[**@wpkernel/cli v0.12.1-beta.3**](../README.md)

---
Expand All @@ -21,3 +46,5 @@ function createQuickstartReadinessHelper(
## Returns

[`ReadinessHelper`](../interfaces/ReadinessHelper.md)\<[`QuickstartState`](../interfaces/QuickstartState.md)\>

> > > > > > > upstream/main
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
<<<<<<< HEAD
[**@wpkernel/cli v0.12.1-beta.3**](../README.md)

---

[@wpkernel/cli](../README.md) / createReleasePackReadinessHelper

# Function: createReleasePackReadinessHelper()

```ts
function createReleasePackReadinessHelper(options): ReadinessHelper & lt;
ReleasePackState & gt;
```

## Parameters

### options

[`ReleasePackHelperOptions`](../interfaces/ReleasePackHelperOptions.md) = `{}`

## Returns

[`ReadinessHelper`](../interfaces/ReadinessHelper.md)\<[`ReleasePackState`](../interfaces/ReleasePackState.md)\>
||||||| 86d024df
=======
[**@wpkernel/cli v0.12.1-beta.3**](../README.md)

---
Expand All @@ -21,3 +46,5 @@ function createReleasePackReadinessHelper(
## Returns

[`ReadinessHelper`](../interfaces/ReadinessHelper.md)\<[`ReleasePackState`](../interfaces/ReleasePackState.md)\>

> > > > > > > upstream/main
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@
# Function: createTsxRuntimeReadinessHelper()

```ts
function createTsxRuntimeReadinessHelper(
overrides
): ReadinessHelper<TsxRuntimeState>;
function createTsxRuntimeReadinessHelper(overrides): ReadinessHelper & lt;
TsxRuntimeState & gt;
```

## Parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@
# Function: createWorkspaceHygieneReadinessHelper()

```ts
function createWorkspaceHygieneReadinessHelper(
overrides
): ReadinessHelper<WorkspaceHygieneState>;
function createWorkspaceHygieneReadinessHelper(overrides): ReadinessHelper & lt;
WorkspaceHygieneState & gt;
```

## Parameters
Expand Down
32 changes: 0 additions & 32 deletions docs/api/@wpkernel/cli/functions/ensureGeneratedPhpClean.md

This file was deleted.

Loading