Skip to content

Commit

Permalink
update npm dependencies and run prettier:fix
Browse files Browse the repository at this point in the history
  • Loading branch information
alcohol committed Dec 24, 2024
1 parent 5a1eb9f commit 8662af2
Show file tree
Hide file tree
Showing 5 changed files with 245 additions and 268 deletions.
26 changes: 13 additions & 13 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting
- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ registry that can be hosted anywhere (even via Docker, locally).

Satis requires a recent PHP version, it does not run with unsupported PHP versions. Check the `composer.json` file for details.

- Install Satis: `composer create-project --keep-vcs --no-dev composer/satis:dev-main`
- Build a repository: `php bin/satis build <configuration-file> <output-directory>`
- Install Satis: `composer create-project --keep-vcs --no-dev composer/satis:dev-main`
- Build a repository: `php bin/satis build <configuration-file> <output-directory>`

Read the more detailed instructions in the [documentation][].

Expand Down Expand Up @@ -96,12 +96,12 @@ See the list of [contributors][] who participate(d) in this project.

## Community Tools

- [satisfy][] - Symfony based composer repository manager with a simple web UI.
- [satisfy][] - Symfony based composer repository manager with a simple web UI.

## Examples

- [eventum/composer] - A simple static set of packages hosted in GitHub Pages
- [satis.spatie.be] - A brief guide to setting up and securing a Satis repository
- [eventum/composer] - A simple static set of packages hosted in GitHub Pages
- [satis.spatie.be] - A brief guide to setting up and securing a Satis repository

## License

Expand Down
72 changes: 36 additions & 36 deletions docs/using.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,21 +252,21 @@ and Subversion) your packages, add the following to your `satis.json`:

#### Options explained

- `directory`: required, the location of the dist files (inside the
`output-dir`)
- `format`: optional, `zip` (default) or `tar`
- `prefix-url`: optional, location of the downloads, homepage (from
`satis.json`) followed by `directory` by default
- `skip-dev`: optional, `false` by default, when enabled (`true`) satis will
not create downloads for branches
- `absolute-directory`: optional, a _local_ directory where the dist files are
dumped instead of `output-dir`/`directory`
- `whitelist`: optional, if set as a list of package names, satis will only
dump the dist files of these packages (use `*` for wildcard matching)
- `blacklist`: optional, if set as a list of package names, satis will not
dump the dist files of these packages (use `*` for wildcard matching)
- `checksum`: optional, `true` by default, when disabled (`false`) satis will
not provide the sha1 checksum for the dist files
- `directory`: required, the location of the dist files (inside the
`output-dir`)
- `format`: optional, `zip` (default) or `tar`
- `prefix-url`: optional, location of the downloads, homepage (from
`satis.json`) followed by `directory` by default
- `skip-dev`: optional, `false` by default, when enabled (`true`) satis will
not create downloads for branches
- `absolute-directory`: optional, a _local_ directory where the dist files are
dumped instead of `output-dir`/`directory`
- `whitelist`: optional, if set as a list of package names, satis will only
dump the dist files of these packages (use `*` for wildcard matching)
- `blacklist`: optional, if set as a list of package names, satis will not
dump the dist files of these packages (use `*` for wildcard matching)
- `checksum`: optional, `true` by default, when disabled (`false`) satis will
not provide the sha1 checksum for the dist files

Once enabled, all downloads (include those from GitHub and BitBucket) will be
replaced with a _local_ version.
Expand All @@ -283,12 +283,12 @@ Example: A `prefix-url` of `https://my-bucket.s3.amazonaws.com` (and

### Web outputs

- `output-html`: optional, `true` by default, when disabled (`false`) satis
will not generate the `output-dir`/index.html page.
- `twig-template`: optional, a path to a personalized [Twig] template for
the `output-dir`/index.html page.
- `allow-seo-indexing`: optional, `false` by default, when enabled (`true`) satis
will allow the generated page to be indexed by search engines.
- `output-html`: optional, `true` by default, when disabled (`false`) satis
will not generate the `output-dir`/index.html page.
- `twig-template`: optional, a path to a personalized [Twig] template for
the `output-dir`/index.html page.
- `allow-seo-indexing`: optional, `false` by default, when enabled (`true`) satis
will allow the generated page to be indexed by search engines.

### Abandoned packages

Expand Down Expand Up @@ -333,21 +333,21 @@ is set to true.

### Other options

- `providers`: optional, `false` by default, when enabled (`true`) each
package will be dumped into a separate include file which will be only
loaded by composer when the package is really required. Speeds up composer
handling for repositories with huge number of packages like f.i. packagist.
- `output-dir`: optional, defines where to output the repository files if not
provided as an argument when calling the `build` command.
- `config`: optional, lets you define all config options from composer, except
`archive-format` and `archive-dir` as the configuration is done through
[archive](#downloads) instead. See docs on [config schema] for more details.
- `notify-batch`: optional, specify a URL that will be called every time a
user installs a package. See [notify-batch].
- `include-types`: optional, an array of [composer types]. When provided
only packages with this type will be selected by Satis.
- `exclude-types`: optional, an array of [composer types]. Any packages
with a type in this array will not be selected by Satis.
- `providers`: optional, `false` by default, when enabled (`true`) each
package will be dumped into a separate include file which will be only
loaded by composer when the package is really required. Speeds up composer
handling for repositories with huge number of packages like f.i. packagist.
- `output-dir`: optional, defines where to output the repository files if not
provided as an argument when calling the `build` command.
- `config`: optional, lets you define all config options from composer, except
`archive-format` and `archive-dir` as the configuration is done through
[archive](#downloads) instead. See docs on [config schema] for more details.
- `notify-batch`: optional, specify a URL that will be called every time a
user installs a package. See [notify-batch].
- `include-types`: optional, an array of [composer types]. When provided
only packages with this type will be selected by Satis.
- `exclude-types`: optional, an array of [composer types]. Any packages
with a type in this array will not be selected by Satis.

[ssh2 context options]: https://secure.php.net/manual/en/wrappers.ssh2.php#refsect1-wrappers.ssh2-options
[ssl context options]: https://secure.php.net/manual/en/context.ssl.php
Expand Down
Loading

0 comments on commit 8662af2

Please sign in to comment.