86ba348887
Automatic update from web-platform-tests [docs] Reorganize information on utility scripts (#18296) The project's top-level README.md file contains a good deal of information which may not be relevant to all readers. This risks overwhelming newcomers, and it also discourages referencing the content in more targeted contexts from the project's documentation website. Move the information on command-line utility scripts from the top-level README.md file to a dedicated document within the docs/ directory. -- wpt-commits: 3a7450af2515bbe2deb7d49c391307d3426ca9be wpt-pr: 18296
1.2 KiB
Command-line utility scripts
Sometimes you may want to add a script to the repository that's meant to be used from the command line, not from a browser (e.g., a script for generating test files). If you want to ensure (e.g., for security reasons) that such scripts won't be handled by the HTTP server, but will instead only be usable from the command line, then place them in either:
-
the
toolssubdir at the root of the repository, or -
the
toolssubdir at the root of any top-level directory in the repository which contains the tests the script is meant to be used with
Any files in those tools directories won't be handled by the HTTP server;
instead the server will return a 404 if a user navigates to the URL for a file
within them.
If you want to add a script for use with a particular set of tests but there
isn't yet any tools subdir at the root of a top-level directory in the
repository containing those tests, you can create a tools subdir at the root
of that top-level directory and place your scripts there.
For example, if you wanted to add a script for use with tests in the
notifications directory, create the notifications/tools subdir and put your
script there.