[Feature Request] builtin help/documentation #7483
colbysadams
started this conversation in
Ideas
Replies: 1 comment
-
|
We're considering a As a halfway solution, we do support Footnotes
|
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Which project is this feature idea for?
Turborepo
Describe the feature you'd like to request
I want to be able to provide a short description and/or link to documentation about what each pipeline step actually does. It would be super helpful for onboarding new engineers if they could run a help command to see what each command is intended to do (and a bonus for showing what steps each one depends on!!).
Describe the solution you'd like
Add a field to each pipeline step in
turbo.jsonthat will be shown if you run the commandturbo helpfor example, a current
turbo.jsonmight look like this{ "$schema": "https://turbo.build/schema.json", "globalDependencies": ["**/.env.*local", "docker/*"], "globalEnv": ["NODE_ENV"], "pipeline": { "build": { "dependsOn": ["^build", "^db-generate"], "outputs": ["dist/**", ".next/**"] }, "dev": { "dependsOn": ["^db-generate"], "cache": false }, "fmt-check": {}, "lint": { "outputs": [] }, "test": {}, "integration-test": {} "docker-build": {}, "docker-push": { "dependsOn": ["docker-build"] }, "db-generate": { "cache": false } } }adding a help command to
turbo.jsoncould look something like{ "$schema": "https://turbo.build/schema.json", "globalDependencies": ["**/.env.*local", "docker/*"], "globalEnv": ["NODE_ENV"], "pipeline": { "build": { "dependsOn": ["^build", "^db-generate"], "outputs": ["dist/**", ".next/**"], "help": "build packages on local machine" }, "dev": { "dependsOn": ["^db-generate"], "cache": false, "help": "run packages in dev mode locally" }, "fmt-check": { "help": "checks whether any files are formatted incorrectly - used in ci" }, "lint": { "outputs": [], "help": "runs eslint against packages" }, "test": { "help": "runs all unit tests of a package" }, "integration-test": { "help": "runs all integration tests - requires local dependencies running in docker" }, "docker-build": { "help": "builds docker containers for packages" }, "docker-push": { "dependsOn": ["docker-build"], "help": "builds and pushes docker containers for all packages" }, "db-generate": { "cache": false, "help":"generates prisma client" } } }the output of
turbo helpwould look something like:Describe alternatives you've considered
the current workaround we have is to use a makefile that allows for comments and threw in a help command that spits out the comments alongside the commands so that users can have a quick reference to what are available as well as a brief description of what each one does.
package.json
{ "scripts": { "turbo": "turbo run ", }Makefile
output of
make helpBeta Was this translation helpful? Give feedback.
All reactions