Skip to content

Commit

Permalink
doc: added project layout
Browse files Browse the repository at this point in the history
  • Loading branch information
rsteube committed Feb 23, 2024
1 parent 9d4653b commit ac55701
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
- [Variable](./variable.md)
- [Conditions](./variable/conditions.md)
- [Development](./development.md)
- [Project Layout](./development/projectLayout.md)
- [Build](./development/build.md)
- [Docker](./development/docker.md)
- [Creating completers](./development/creatingCompleters.md)
Expand Down
27 changes: 27 additions & 0 deletions docs/src/development/projectLayout.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Project Layout

```sh
.
├── cmd
│ ├── carapace # main application
│ ├── carapace-fmt # simple formatter
│ ├── carapace-generate # called by `go generate`
│ ├── carapace-lint # simple linter
│ ├── carapace-parse # simple help output parser
│ └── carapace-shim # binary for runnable specs in windows
├── completers # completers
│ └── example_completer # completer for `example`
│ └── cmd
│ └── action # local (coupled) actions
├── completers_release # optimized completers
├── dist # goreleaser dist folder
├── docs # documentation
├── internal # some internal packages
└── pkg # public packages
├── actions # shared actions that are also exposed as macros
│ └── tools # shared actions specific to tools
├── conditions # conditions for environment variable completion
├── env # environment variables
├── styles # style configurations
└── util # some util functions
```

0 comments on commit ac55701

Please sign in to comment.