Skip to content

tidy README comments for example config #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benfc1993 merged 2 commits into from
Oct 17, 2024
Merged

tidy README comments for example config #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
189d6b8
tidy README comments for example config
benfc1993 Oct 17, 2024
656f1de
Merge branch 'main' into readme-tidy
benfc1993 Oct 17, 2024
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
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,12 @@ For each option entry you can provide the following:
/** @type { import("scripts-cli").Config } */

export default {
exclude: ["db:create:migration", "db:migrate:latest", "scripts"], // This list will exclude scripts with this name from being added at the top level by default. Adding them manually to the options will allow them to still be selected.
// This list will exclude scripts with this name from being added at the top level by default.
// Adding them manually to the options will allow them to still be selected.
exclude: ["db:create:migration", "db:migrate:latest", "scripts"],
// These are the options to be presented.
// For package.json scripts the key needs to be the same as in package.json
options: {
// These are the options to be presented. For package.json scripts the key needs to be the same as in package.json
test: {
args: true, // This will ask the user to provide arguments then run 'npm run test' followed by any provided arguments.
},
Expand All @@ -87,7 +90,8 @@ export default {
},
db: {
options: {
// This will mean whenever 'db' is selected from the list nothing will be run but a new list consisting of 'create migration' and 'migrate latest' will show.
// This will mean whenever 'db' is selected from the list nothing will be run
// but a new list consisting of 'create migration' and 'migrate latest' will show.
"create migration": {
args: true,
exec: "npm run db:create:migration",
Expand Down