Commit Graph

57 Commits

Author SHA1 Message Date
Josh Lehman
93e772245f
generate compile_commands.json for use by language servers like clangd (#196)
### Improving Vere developer experience

This PR enables a `bazel run //bazel:refresh_compile_commands` command
that generates a `compile_commands.json` file in the root of the repo.
This file can be used by popular C/C++ editor plugins/extensions to
automatically enable modern IDE features like auto-completion,
cross-references, hovering, refactoring, etc.

To enable this, we add
[this](https://github.com/hedronvision/bazel-compile-commands-extractor)
"compile commands extractor" program to our `BUILD.bazel` file.

If you want to try this yourself with your own installation of vscode
with the official `clangd` extension (for example)...
```
git checkout i/195/better-ide-support

# uninstall any c/c++ extensions you might already have
code --install-extension llvm-vs-code-extensions.vscode-clangd
code --uninstall-extension ms-vscode.cpptools

# add these `clangd` settings to your *user* json:
  "clangd.arguments": [
    "--header-insertion=never",
    "--compile-commands-dir=${workspaceFolder}/",
    "--query-driver=**",
  ],
  
# generate the `compile_commands.json` file
bazel run //bazel:refresh_compile_commands

# finally, reload your vscode window
```

Enjoy no red squigglies, plus lots more.

Resolves #195.
2023-02-10 06:28:43 -08:00
Matthew LeVan
70d974dce9 editor plugin docs link 2023-02-09 17:05:10 -05:00
Matthew LeVan
a9bc1d33f5 typo 2023-02-09 17:02:39 -05:00
Matthew LeVan
0d9a87eebb specify that the clangd arguments format is a vscode example 2023-02-09 17:02:22 -05:00
Matthew LeVan
9aaee7f224 clarify clangd argument instructions 2023-02-09 17:00:49 -05:00
Matthew LeVan
f13ad9f37f add section to CONTRIBUTING.md about clangd LSP 2023-02-09 12:29:37 -05:00
barter-simsum
14c57ae257 vere no longer squashes 2023-02-08 13:20:41 -05:00
Peter McEvoy
eedbbdcd0d
Tidy up markdown documentation (#100)
Co-authored-by: Peter McEvoy <git@mcevoypeter.com>
2023-01-17 15:39:56 -05:00
Matthew LeVan
cadf27fb85 bazel-based continuous integration flow (#21) 2023-01-09 14:44:23 -05:00
Peter McEvoy
b339b5067a Build with bazel on linux-x86_64 (#10) 2023-01-09 13:46:48 -05:00
ryjm
110132bc15 %home -> %base
Mostly cosmetic, but also fixes `language-server` and parts of sundry
neglected components (the nix build for solid pills, aqua, gaze exports,
+help)
2022-03-06 11:55:55 -05:00
drbeefsupreme
f4eed11a1a readme: update CONTRIBUTING.md
This fixes some links and updates the git policy to reflect the use of
`next/` branches.
2022-01-04 16:20:29 -05:00
Matilde Park
953a4b6287 meta: add dev ship instructions from master 2020-09-28 21:58:35 -04:00
Matilde Park
5d0fb12a29 CONTRIBUTING: add link to maintainers in pkg/arvo
Also removes a blurb about accepting emailed patches; this
has never happened in practice, and we don't supply
maintainers' emails. Sticking to what we know we support
is best.
2020-08-31 21:35:52 -04:00
Jared Tobin
8f9d735d59 meta: update CONTRIBUTING, MAINTAINERS
Adjusts these documents to reflect our new branching/release procedure.
2020-03-16 11:32:55 +04:00
Jared Tobin
67ec950dd4 contributing: use alternative rebase tutorial [ci skip] 2019-12-18 08:29:22 -03:30
Jared Tobin
8ed353e728 contributing: update git practice section [ci skip]
Updates our git practice notes regarding long-form commit descriptions
and solid pills, per the urbit-dev thread:

https://groups.google.com/a/urbit.org/d/msg/dev/RLzP6AMAOhM/O8dsJ2rxCQAJ
2019-11-07 17:23:33 +08:00
Jared Tobin
20e8e79ac7 contributing: fix awkward language [ci skip]
This is more of an OCD fix than anything, but technically the canonical
source tree is not located 'in' the master branch; it *is* the master
branch.
2019-10-06 19:03:26 +04:00
Jared Tobin
a9a3bea568 contributing: add notes on describing contributions [ci skip]
Adds a couple of blurbs on how to describe contributions to the git
practice 'contributing' section.
2019-10-06 18:57:47 +04:00
Jared Tobin
a5d00814ad contributing: add note on hotfixes [ci skip] 2019-09-28 14:44:50 +04:00
Jared Tobin
a06865679a contributing: use parentheses instead of commas 2019-09-02 17:08:26 -02:30
Jared Tobin
cca53266bd contributing: s/urbit/Urbit
'Urbit' refers to the project/product/platform, whereas 'urbit' refers
to an individual ship or instance.  This corrects some old, incorrect
lower-case usage.
2019-08-28 13:40:50 -02:30
Jared Tobin
fce36a78e4 Merge branch 'origin/jt-contributing' 2019-08-28 13:34:12 -02:30
Jared Tobin
94ddd0c397 contributing: text fixup
'clear' is preferred to "clear, obvious" here.
2019-08-28 13:31:38 -02:30
Jared Tobin
8af4e7ad21 contributing: remove labelling discussion
In general contributors can't add labels to issues, so this section was
incorrect.
2019-08-28 13:30:50 -02:30
Matilde Park
fdfee4a31c contributing: adds userspace information, links
We had no information on contributing to Landscape.
Now we do. Tried to ensure it follows voice and
line break standards.
2019-08-28 12:00:04 -04:00
Jared Tobin
6f62b23b0f contributing: add hoon style guide link 2019-08-28 13:29:50 -02:30
Jared Tobin
fb3d69f540 contributing: improve description.. description
This factors the finer details out of the broad description spec, moving
them into the next paragraph.
2019-08-28 13:21:22 -02:30
Jared Tobin
92f5e13861 contributing: add 'issues' section
Replaces "what to work on" with a section that describes how we track
issues, as well as guidelines for submitting them.
2019-08-28 12:50:09 -02:30
Jared Tobin
6e4b467ed1 contributing: add mailing list info to intro 2019-08-28 12:49:03 -02:30
Jared Tobin
4ceb25e6e2 contributing: update kernel & pills section
Removes information about our deprecated pill caching framework.
2019-08-28 12:30:35 -02:30
Jared Tobin
cd1413d743 contributing: touch up code style section
Suggests contributors mimic recent Hoon code, rather than only %ford in
particular.
2019-08-28 12:30:35 -02:30
Jared Tobin
41d2dee4d5 contributing: add git/release info
Revamps the "Git practice" section to make it less of a git and GitHub
tutorial and more of a guide of expected contribution style.  In
particular, it answers the questions of:

* what tree contributors should branch from
* how to submit contributions
* how to structure commits
* how to format commit descriptions
* what contributions are considered acceptable
* what our expectations are around committing pills

Additionally, adds a "Releases" section that describes how we go about
making and deploying releases.
2019-08-28 12:30:35 -02:30
Jared Tobin
e58f9d620b Update CONTRIBUTING.md.
Removes references to the old Arvo repository and updates information
about pills.
2019-07-15 08:10:53 -02:30
Jared Tobin
b210871fef Update CONTRIBUTING.md. [ci skip] 2019-06-17 18:44:08 +08:00
benjamin-tlon
aee35d6d20 Nix Build + Monorepo Structure (#1196) 2019-03-04 16:43:53 -08:00
benjamin-tlon
a572793223 Remove trailing whitespace and enforce in CI. (#1212) 2019-02-25 13:35:12 -08:00
Joe Bryan
c2daca3673 updates contact instructions 2019-01-17 20:02:14 -05:00
Joe Bryan
b78416a0b8 updates CONTRIBUTING.md, removing obsolete instructions 2019-01-15 16:13:38 -05:00
Joe Bryan
019825ea8b updates fake-zod examples, removing -I 2018-11-01 00:43:09 -04:00
Raymond Pasco
1f18935e0a Updates contributor guidelines 2016-10-27 13:02:43 -04:00
Tobias Merkle
e92d345667 sub dozbud 2016-06-29 15:26:37 -07:00
Raymond Pasco
e40bd9d81a Fix up README and CONTRIBUTING for new world order 2016-02-15 06:07:17 -05:00
Anton Dyudin
68c9094a0d ape -> app 2016-02-04 16:38:18 -08:00
Raymond Pasco
1c92dea0a8 Put 'test' on ice for outside contributors 2015-11-16 17:56:21 -05:00
John Franklin
159dfe858f Add notes on debugging with gdb. 2015-10-19 13:06:30 -04:00
Raymond Pasco
48e47f48c4 Merge branch 'contributing.md-hotfix' into test 2015-08-29 10:17:40 -04:00
Raymond Pasco
449ec9121c Clarify the situations when a new pill is needed 2015-08-29 10:13:04 -04:00
Raymond Pasco
612763fcde Clearer wording per Michael D.'s feedback 2015-08-25 16:29:02 -04:00
Raymond Pasco
7ad26cdac9 Clearer wording per Michael D.'s feedback 2015-08-25 16:25:56 -04:00