Skip to content

Pantsbuild

Common plugin tasks

Initializing search

pantsbuild/pants

Pantsbuild

pantsbuild/pants

Introduction
Introduction
Getting Started
Getting Started
Getting Help
Getting Help
- The Pants Community
  The Pants Community
- Service providers
Using Pants
Using Pants
- Key Concepts
  Key Concepts
- Command line help
- Troubleshooting / common issues
- Advanced target selection
- Project introspection
- Assets and archives
- Using Pants in CI
- Setting up an IDE
- Remote caching & execution
  Remote caching & execution
  - Remote caching
  - Remote execution
- Environments: Cross-Platform or Remote Builds
- Generating version tags from Git
- Anonymous telemetry
- Restricted Internet access
- Validating dependencies
Python
Python
- Python Overview
  Python Overview
- Goals
  Goals
  - check
  - fmt
  - lint
  - package
  - repl
  - run
  - test
- Integrations
  Integrations
Go
Go
- Integrations
  Integrations
  - Protobuf
Java and Scala
Java and Scala
- Java and Scala overview
- Kotlin
Shell
Shell
- Run shell commands
Docker
Docker
- Tagging Docker images
Helm
Helm
- Deployments
- Kubeconform
Integrating new tools without plugins
Writing Plugins
Writing Plugins
- Macros
- The Target API
  The Target API
- The Rules API
  The Rules API
- Common plugin tasks
  Common plugin tasks
Releases
Releases
Contributions
Contributions
- Development
  Development
- Releases
  Releases
Tutorials
Tutorials
Reference
Reference
- Global Options
- Goals
  Goals
  - check
  - count-loc
  - dependees
  - dependencies
  - dependents
  - experimental-bsp
  - experimental-deploy
  - experimental-explorer
  - export
  - export-codegen
  - filedeps
  - fix
  - fmt
  - generate-lockfiles
  - generate-snapshots
  - go-generate
  - help
  - help-advanced
  - help-all
  - lint
  - list
  - package
  - paths
  - peek
  - publish
  - py-constraints
  - python-dump-source-analysis
  - repl
  - roots
  - run
  - tailor
  - test
  - update-build-files
  - version
- Subsystems
  Subsystems
  - add-trailing-comma
  - anonymous-telemetry
  - apache-thrift
  - autoflake
  - bandit
  - black
  - buf
  - build-deprecations-fixer
  - buildifier
  - changed
  - cli
  - coursier
  - coverage-py
  - debug-adapter
  - debugpy
  - docformatter
  - docker
  - dockerfile-parser
  - download-terraform
  - environments-preview
  - filter
  - flake8
  - go-test
  - gofmt
  - golang
  - google-java-format
  - grpc-python-plugin
  - hadolint
  - helm
  - helm-k8s-parser
  - helm-post-renderer
  - helm-unittest
  - ipython
  - isort
  - jarjar
  - java-infer
  - javac
  - junit
  - jvm
  - kotlin
  - kotlin-infer
  - kotlinc
  - ktlint
  - lambdex
  - mypy
  - mypy-protobuf
  - nodejs
  - nodejs-infer
  - openapi
  - pex
  - pex-binary-defaults
  - pex-cli
  - preamble
  - protobuf-java-grpc
  - protoc
  - pydocstyle
  - pylint
  - pyoxidizer
  - pytest
  - python
  - python-bootstrap
  - python-infer
  - python-native-code
  - python-protobuf
  - python-repos
  - python-thrift
  - pytype
  - pyupgrade
  - regex-lint
  - scala
  - scala-infer
  - scalac
  - scalafmt
  - scalapb
  - scalatest
  - scc
  - setup-py-generation
  - setuptools
  - setuptools-scm
  - shell-setup
  - shell-test
  - shellcheck
  - shfmt
  - shunit2
  - source
  - spectral
  - stats
  - subprocess-environment
  - terraform-fmt
  - terraform-hcl2-parser
  - terraform-validate
  - thrift
  - twine
  - workunit-logger
  - yamllint
  - yapf
- Targets
  Targets

Common plugin tasks¶

Add a linter
Add a formatter
Add codegen
Add a REPL
Custom setup-py kwargs
Plugin upgrade guide

Made with Material for MkDocs