Skip to content

Commit

Permalink
Remove outdated TODOs (#250)
Browse files Browse the repository at this point in the history
  • Loading branch information
theofidry authored May 31, 2018
1 parent ea0f881 commit ac0b91b
Showing 1 changed file with 7 additions and 21 deletions.
28 changes: 7 additions & 21 deletions doc/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,20 +40,13 @@
1. [Git version placeholder (`git-version`)][git-version-placeholder]


// TODO: do not mention when an option is optional but add a red asterix with a foot note for the mandatory
// fields.
// TODO: right now this documentation is a copy/paste of the doc from the comment. This needs to be reworked
// TODO: add a test to keep in sync the type declared here and the one in the schema

The build command will build a new PHAR based on a variety of settings.

This command relies on a configuration file for loading PHAR packaging settings. If a configuration file is not
specified through the `--configuration|-c option`, one of the following files will be used (in order): `box.json`,
`box.json.dist`. If no configuration file is found, Box will proceed with the default settings.

The configuration file is a JSON object saved to a file. Note that all settings are optional.
// TODO: update this last bit of information as this is not true
// TODO: add a test to ensure this schema is always up to date with the actual schema file

```json
{
Expand Down Expand Up @@ -299,12 +292,10 @@ You you want a more granular blacklist leverage the [Finders configuration][find

### Map (`map`)

// TODO: review this setting + doc, default value...]

The map (`array`) setting is used to change where some (or all) files are stored inside the PHAR. The key is a beginning
of the relative path that will be matched against the file being added to the PHAR. If the key is a match, the matched
segment will be replaced with the value. If the key is empty, the value will be prefixed to all paths (except for those
already matched by an earlier key).
The map (`object[]` default `[]`) setting is used to change where some (or all) files are stored inside the PHAR. The key
is a beginning of the relative path that will be matched against the file being added to the PHAR. If the key is a
match, the matched segment will be replaced with the value. If the key is empty, the value will be prefixed to all paths
(except for those already matched by an earlier key).

For example, with the following configuration excerpt:

Expand Down Expand Up @@ -603,12 +594,9 @@ Note that this setting is used only if the compactor `KevinGH\Box\Compactor\Php`

### PHP-Scoper (`php-scoper`)

// TODO: review this setting + doc, default value...]

The PHP-Scoper setting (`string`) points to the path to the [PHP-Scoper configuration][php-scoper-configuration] file.
By default, Box will use the default PHP-Scoper file `php-scoper.inc.php`. For more documentation regarding PHP-Scoper,
you can head to [PHAR code isolation][PHAR code isolation] or
[PHP-Scoper official documentation][php-scoper-official-doc].
The PHP-Scoper setting (`string` default `scoper.inc.php`) points to the path to the
[PHP-Scoper configuration][php-scoper-configuration] file. For more documentation regarding PHP-Scoper, you can head to
[PHAR code isolation][PHAR code isolation] or [PHP-Scoper official documentation][php-scoper-official-doc].

Note that this setting is used only if the compactor `KevinGH\Box\Compactor\PhpScoper` is registered.

Expand Down Expand Up @@ -805,8 +793,6 @@ Example of value the placeholder will be replaced with:

### Git version placeholder (`git-version`)

// TODO: review this setting + doc, default value...]

The git version (`string`) setting is the name of a placeholder value that will be replaced in all
[non-binary files][including-files] by the one of the following (in order):

Expand Down

0 comments on commit ac0b91b

Please sign in to comment.