diff options
| author | slackline <776695+slackline@users.noreply.github.com> | 2024-11-13 04:50:11 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-11-13 04:50:11 +0000 |
| commit | d18e308ea9b7473b69f904d40ed4835b3e34d5e2 (patch) | |
| tree | e515eeed68f387cf3cdb17961125fd5e3126e08d /doc/modules | |
| parent | 9b466af28bac6d61fd0e717f1a4b0fcd2f18f37f (diff) | |
Expands table of files for project markers (#1919)
First attempt at expanding the table of file markers for projects based on code at
[master/projectile.el#L3441](https://github.com/bbatsov/projectile/blob/master/projectile.el?rgh-link-date=2024-10-22T08%3A55%3A41Z#L3441)
I've followed the order of the languages/files in `projectile.el` (I hope!).
Not sure descriptions under `Project Type` are 100% correct so happy to revise anything that needs changing.
Diffstat (limited to 'doc/modules')
| -rw-r--r-- | doc/modules/ROOT/pages/projects.adoc | 241 |
1 files changed, 182 insertions, 59 deletions
diff --git a/doc/modules/ROOT/pages/projects.adoc b/doc/modules/ROOT/pages/projects.adoc index f41586c..5b123fa 100644 --- a/doc/modules/ROOT/pages/projects.adoc +++ b/doc/modules/ROOT/pages/projects.adoc @@ -40,110 +40,233 @@ Projectile considers many files to denote the root of a project. Usually those f are the configuration files of various build tools. Out of the box the following are supported: |=== -| File | Project Type +| Language/Family | File | Project Type -| `.ensime` -| Ensime configuration file +| Universal +| `xmake.lua` +| xmake project -| `CMakeLists.txt` -| CMake +| Universal +| `SConstruct` +| Scons project file -| `Cargo.toml` -| Cargo project file +| Universal +| `meson.build` +| project file -| `DESCRIPTION` -| R package description file +| Universal +| `default.nix` +| Nix project file -| `GTAGS` -| GNU Global tags +| Universal +| `flake.nix` +| Nix flake project file -| `Gemfile` -| Bundler file +| Universal +| `WORKSPACE` +| Bazel workspace file +| Universal +| `debian/control` +| Debian package dpkg control file + +| Make & CMake | `Makefile` | Make -| `SConstruct` -| Scons project file +| Make & CMake +| `GNUMakefile` +| GNU Make -| `TAGS` -| etags/ctags are usually in the root of project +| Make & CMake +| `CMakeLists.txt` +| CMake -| `WORKSPACE` -| Bazel workspace file +| Go-task/Task +| `Taskfile.yaml` +| Go-task/Task project file -| `build.boot` -| Boot-clj project file +| PHP +| `composer.json` +| PHP project file + +| Erlang & Elixir +| `rebar.config` +| Rebar project file + +| Erlang & Elixir +| `mix.exs` +| Elixir mix project file + +| JavaScript +| `Gruntfile.js` +| Grunt project file + +| Angular +| `angular.json` +| Angular project file +| JavaScript +| `gulpfile.js` +| Javascript Gulp file + +| JavaScript +| `package.json` +| npm, pnpm and yarn project file + +| Python +| `manage.py` +| Django project file + +| Python +| `requirements.txt` +| Python requirements file + +| Python +| `setup.py` +| Setuptools file + +| Python +| `tox.ini` +| Python Tox file + +| Python +| `Pipfile` +| Python Pip file + +| Python +| `poetry.lock` +| Python Poetry project file + +| Python +| `pyproject.toml` +| Python project file + +| Java & friends +| `pom.xml` +| Maven project file + +| Java & friends +| `application.yml` +| Gradle project file + +| Java & friends | `build.gradle` | Gradle project file +| Java & friends +| `gradlew` +| Gradle wrapper script + +| Java & friends +| `application.yaml` +| Gradle wrapper script + +| Scala | `build.sbt` | SBT project file +| Scala | `build.sc` | Mill project file -| `composer.json` -| Composer project file +| Ensime +| `.ensime` +| Ensime configuration file -| `configure.ac` -| autoconf new style +| Clojure +| `project.clj` +| Leiningen project file -| `configure.in` -| autoconf old style +| Clojure +| `build.boot` +| Boot-clj project file -| `cscope.out` -| cscope +| Clojure +| `deps.edn` +| Clojure CLI project file -| `debian/control` -| Debian package dpkg control file +| Clojure +| `.bloop` +| Clojure CLI project file -| `default.nix` -| Nix project file +| Ruby +| `Gemfile` +| Bundler file -| `deps.edn` -| Clojure CLI project file +| Crystal +| `shard.yml` +| Crystal project file -| `dune-project` -| OCaml Dune project file +| Emacs +| `Cask` +| Emacs cask file -| `flake.nix` -| Nix flake project file +| Emacs +| `Eask` +| Emacs cask file -| `gradlew` -| Gradle wrapper script +| Emacs +| `Eldev` +| Emacs LISP project file + +| R +| `DESCRIPTION` +| R package description file + +| Haskell +| `stack.yaml` +| Haskell's stack tool based project +| Rust +| `Cargo.toml` +| Cargo project file + +| Racket | `info.rkt` | Racket package description file -| `mix.exs` -| Elixir mix project file +| Dart +| `pubspec.yaml` +| Dart project file -| `pom.xml` -| Maven project file +| Elm +| `elm.json` +| Elm project file -| `project.clj` -| Leiningen project file +| Julia +| `Project.toml` +| Julia project file -| `rebar.config` -| Rebar project file +| OCaml +| `dune-project` +| OCaml Dune project file -| `requirements.txt` -| Python Pip file +| Universal +| `GTAGS` +| GNU Global tags -| `setup.py` -| Setuptools file +| Universal +| `TAGS` +| etags/ctags are usually in the root of project -| `stack.yaml` -| Haskell's stack tool based project +| Universal +| `configure.ac` +| autoconf new style -| `tox.ini` -| Tox file +| Universal +| `configure.in` +| autoconf old style -| `xmake.lua` -| xmake project +| C +| `cscope.out` +| cscope + +| Composer +| `composer.json` +| Composer project file +| Zig | `build.zig.zon` | Zig project file |=== |
