Commit Graph

50 Commits

Author SHA1 Message Date
Gabriel Horner
8fca36629f Document repl test workflow as a followup to #9372
Also organized unit test sections more
2023-05-16 14:25:26 -04:00
Gabriel Horner
50ff53ea72 Mention setup required for bb command 2023-04-09 23:13:33 +08:00
Gabriel Horner
fef07fe812 Add docs and workflow for dep
Also rename dep to publishing for consistency with existing names
2023-04-09 23:13:33 +08:00
Gabriel Horner
06fa65861f Minor clean up and help with feedback
- basic clj-kondo config and cleanup unused binding
- Add some unit tests
- Add a basic readme
2023-03-28 09:14:42 +08:00
Gabriel Horner
b78c689458 Fix remaining todos and add a section to practices about this new action 2023-02-21 12:01:58 -05:00
Gabriel Horner
c4d15ec848 Document dev commands and dev tools 2023-02-03 10:58:24 -05:00
Gabriel Horner
d58a2a95dc Make optional fns section more readable 2023-01-20 17:28:55 -05:00
Gabriel Horner
0d60dfd953 Make first bb cmd more readable per Bad3r. Close #8394 2023-01-20 17:15:28 -05:00
Gabriel Horner
2a56dc133e Add a section for fn instrumentation and make test section less confusing
Follow up to #8265
2023-01-13 14:36:18 -05:00
Junyi Du
7790c791fa chore: update dev-practices for E2E dump 2023-01-13 22:25:10 +08:00
Bad3r
d8303d055c docs(dev): maintain style 2023-01-12 18:28:53 +08:00
Bad3r
55971f085b docs(dev): update linting to match bb dev:lint
update to match `$ bb dev:lint`
```cljs
(defn lint
  "Run all lint tasks
  - clj-kondo lint
  - carve lint for unused vars
  - lint for vars that are too large
  - lint invalid translation entries"
  []
  (doseq [cmd ["clojure -M:clj-kondo --parallel --lint src --cache false"
               "bb lint:carve"
               "bb lint:large-vars"
               "bb lang:invalid-translations"
               "bb lint:ns-docstrings"]]
    (println cmd)
    (shell cmd)))
```

not sure if we should just add `$ bb dev:lint` since it doesn't seem to be documented anywhere

this update is a pre-req to adding docs for data validation with Malli from https://github.com/logseq/logseq/blob/dev/malli-schema%2526kondo-config/

```sh
bb dev:gen-malli-kondo-config
```

Note that it will also need to be added to `build.yaml`
https://github.com/logseq/logseq/blob/dev/malli-schema%26kondo-config/.github/workflows/build.yml

CC: @RCmerci
2023-01-12 18:28:53 +08:00
Junyi Du
cfce689632 chore: upgrade dev-practivce on upgrading electron 2023-01-12 17:26:42 +08:00
Bad3r
a2bb85331e fix: do not link to a specific cljfmt version docs
the link https://cljdoc.org/d/cljfmt/ will always load the most up to date documentation of cljfmt. 
It should be used instead of a specific version number
2023-01-04 12:53:41 -05:00
Gabriel Horner
4eec463cbb Tweaks to PR
- Move auto-formatting down as it's not as important as other sections
- Reword to have focus be on auto-formatting and less so on cljfmt
2023-01-04 12:38:40 -05:00
Phoenix Eliot
133028c043 Update per CR feedback 2023-01-04 12:37:27 -05:00
Phoenix Eliot
83a7beea3a Add note about auto-formatting 2023-01-04 12:37:27 -05:00
Junyi Du
f45317e569 chore: query performance: enlarge test timeout and add dev doc 2022-12-15 20:37:17 +08:00
Gabriel Horner
effaf0f741 Doc e2e debugging workflow available with #7505 2022-11-30 14:42:39 -05:00
Junyi Du
14ee3d0cca Update e2e practices 2022-11-24 20:17:59 +08:00
Gabriel Horner
2685cd1325 Fix bug with certain plugins and misc cleanup
- Plugins that used effects weren't loading correctly e.g.
  logseq-power-plugin
- Cleaned up translation, docs and some fn naming
2022-10-17 10:31:07 -04:00
Gabriel Horner
784ad7cce3 Add unit tests for create-if-not-exists and misc test improvements
- Added unit test as it is used by several handlers
- Fixed test suite failing from last commit now that a test fs is used
- Fixed test stat implementation
- Extracted out Plugin schema to make usage of it less impl dependent
- Made test.helper alias consistent
- Made async testing consistent for export-test
2022-10-17 10:13:27 -04:00
Gabriel Horner
c8cda90373 Fix plugin install bugs and add plugin-config tests
- Add validation for plugins.edn with malli
- Add bb task using malli schema
- Add first async test that interacts with frontend.fs
- Add test helpers to make future async testing easier
2022-10-17 10:13:27 -04:00
Gabriel Horner
1f0e22275d Add ns docstrings for most ns in src/main
- Added to CI now that it passes
- Added no-doc for docstrings that don't add any more than what's in the
ns name or for ones where I didn't know the ns that well
2022-09-27 13:55:16 +08:00
Gabriel Horner
a368cab5e4 Add ns linter to deps libs and then add+update ns docstrings 2022-09-21 10:17:15 +08:00
Konstantinos Kaloutas
fc7141518d feat: accessibility guidelines 2022-08-26 11:52:23 +08:00
Gabriel Horner
f26681c2ee Skip intermittent failing test and add more testing advice 2022-07-25 14:17:46 -04:00
Gabriel Horner
981b1ad69e Fix autorun tests doc, close #5967 2022-07-19 21:04:02 -04:00
Gabriel Horner
f39f26c8d3 Improve and update lint documentation 2022-07-07 09:34:08 -04:00
Gabriel Horner
ee9f390761 Localize bb-tasks for deps
Deps need to be independent to not introduce testing bugs.
These bb tasks are good candidates to move into bb-tasks gitlib
2022-06-10 15:39:11 +08:00
Gabriel Horner
17d2462343 Move rules into db dep as it's useful for external apps
- rules is already used by logseq-query and will be useful for
  nbb-logseq
- Updated db jobs to run in deps/db by default. Less typing but
  more importantly discourages independent libraries from depending on
  external scripts.
- Moved lint-rules task into db since it is db specific now
- Also remove nbb-logseq from top-level as all nbb compatibility is in
  deps.
2022-06-10 15:39:11 +08:00
Gabriel Horner
29f73549aa Moved nbb tasks to another repo
They are useful outside of logseq development and don't need to be
embedded in the Logseq app
2022-06-01 01:17:29 -04:00
Gabriel Horner
b142327491 Finish up logseq.graph-parser
- Parser now parses all graph files like the app does, not just pages and journals.
  This required extracting another fn from repo-handler
- Add and tweak CI steps that are specific to graph-parser. All
  namespaces in this library are checked for nbb compatibility
- Cleaned up parser cli API so only one fn is needed for scripts
- Tests were updated to match new parsing behavior
- large_vars.clj can run with a smaller max-line-count after only refactoring two fns
- Add docs
2022-05-27 00:54:30 -04:00
Gabriel Horner
65804b4183 Split out text ns to graph-parser 2022-05-10 20:22:48 -04:00
Gabriel Horner
823b8ec39e Add basic docs explaining nbb compatibility 2022-05-04 12:27:52 -04:00
Gabriel Horner
0ccbe4d046 Enhance: validate local storage (#4784)
* Validate localStorage with spec

This will help get at the source of errors like #4706 quicker

* Fix settings bugs

Close #4679 as shortcut tooltip setting is now visible.
No need to js/alert when a setting is changed. Probably leftover bugging

* Add docs and example of reusing specs in bb task

Co-authored-by: Andelf <andelf@gmail.com>
2022-04-01 15:46:52 +08:00
Gabriel Horner
320fbea9b9 Document datalog linter introduced in #4503 2022-03-15 12:30:41 +08:00
Gabriel Horner
8d40c4667b Node test runner improvements
- Print stacktrace when exception occurs!
- No longer depend on old test runner
- AND multiple test selections
- Add -v for compatibility with old test runner
2022-03-15 12:30:41 +08:00
Gabriel Horner
669a56911e Document logging setup and bump to latest devtools 2022-03-03 13:31:58 -05:00
Gabriel Horner
50e5764369 Fix --exclude option
Subtle annoying bug with symbol. Also allos multiple exclude options
2022-02-28 16:27:22 +08:00
Gabriel Horner
35d2023e24 Add shadow test runner that provides most test-runner like options 2022-02-24 22:45:52 +08:00
Gabriel Horner
e353738c67 Improve develop docs based on onboarding with Jakob 2022-02-24 00:32:30 +08:00
Gabriel Horner
163d31005f Add testing library and document workflow
Also moved testing instruction to dev-practices as it didn't make sense
to have them split
2022-02-24 00:32:30 +08:00
Gabriel Horner
a3ff4442e8 Add large vars linter to dev practices 2022-02-07 10:18:43 -05:00
Gabriel Horner
821ebcb888 Add docs 2022-01-27 15:26:14 -05:00
Gabriel Horner
2f86f6859e Remove unnecessary additional target thanks to cmdline option 2022-01-22 00:01:11 +08:00
Gabriel Horner
558784a8bd Add shadow build for auto testing 2022-01-22 00:01:11 +08:00
Gabriel Horner
2b46cc4938 Fix kondo invocation and output progress 2022-01-16 12:42:34 +08:00
Gabriel Horner
8b0026f34b Tweak lint docs 2022-01-16 12:42:34 +08:00
Gabriel Horner
38d9cb7fbd Add dev practices doc to explain current state of linting 2022-01-12 17:00:11 -05:00