add justfile, remove coveralls, tweak ESLint #2249
Conversation
xavdid-stripe
requested review from
prathmesh-stripe
and removed request for
a team
| # ⭐ run unit tests | ||
| [positional-arguments] | ||
| test *args: build | ||
| mocha "$@" |
There was a problem hiding this comment.
This was surprisingly tricky get right! By default, just groups all the args you pass to *args, so it wasn't correctly preserving -g "some thing". This works as expected for mixed content
There was a problem hiding this comment.
why not use *args? or are the args represented in both *args and $@? and if thats true, what happens if test is called from another just rule?
There was a problem hiding this comment.
Because of the way just expands input args. It treats them as one big group for quoting purposes, unless told otherwise. It becomes an issue when some of your args are quoted with spaces and some aren't. You can't quote the whole thing, but you also can't leave them unquoted. This is important when wanting to call mocha someFile.js -g "match this name". If the args aren't grouped correctly when passing through just, you call -g match and then this and name are extra args.
I did some testing with the following:
[positional-arguments]
arg-test *args:
bash -c 'while (( "$#" )); do echo - $1; shift; done' -- "{{ args }}"
Which should print each arg (respecting spaces) on their own line.
"{{ args }}":
% .j arg-test a b "c d" e
- a b c d e
{{ args }}:
- a
- b
- c
- d
- e
"$@":
% .j arg-test a b "c d" e
- a
- b
- c d
- e
I mostly pulled from the docs: https://github.com/casey/just?tab=readme-ov-file#positional-arguments
| @@ -4,6 +4,15 @@ import {FAKE_API_KEY} from './testUtils.js'; | |||
| const nodeVersion = parseInt(process.versions.node.split('.')[0], 10); | |||
|
|
|||
| describe('Integration test', function() { | |||
| // these tests are expensive and start processes they don't clean up | |||
There was a problem hiding this comment.
This is why your CPU goes to 100% when running the test suite locally!
There was a problem hiding this comment.
is there a fix we can make here? or is it more complicated than can be fixed as part of this PR?
There was a problem hiding this comment.
It's fixable, but IMO out of scope of this PR. I didn't want to get too distracted. Plus we don't care if we're leaking on CI, since it all gets shut down when the job completes
* add justfile, remove coveralls * fix ci * fix ci * better CI Logging * now come on * clean up CI and make more reliable * update readme instructions * update justfile import * try pinning to ubuntu 24.04 * clean up CI * split out recipes
* add justfile, remove coveralls * fix ci * fix ci * better CI Logging * now come on * clean up CI and make more reliable * update readme instructions * update justfile import * try pinning to ubuntu 24.04 * clean up CI * split out recipes
Why?
In an effort to modernize and simplify our local tooling, we're moving our dev commands from makefiles to justfiles. This is intended to be mostly a drop-in replacement, but some command names may change per standardization efforts.
To be in line with our other SDKs, I removed most of the scripts in
package.json. But, if we find that potential contributors are having trouble with muscle memory, we can re-add common ones (test,lint, etc) that call intojust.In order to untangle formatting and linting (which Prettier recommends keeping separate, I removed
plugin:prettierfrom the eslint config. This mean the formatting-related lint rules are disabled, deferring toprettierinstead. This has the added bonus of formatting violations not showing up as linting errors in-editor!Lastly, I've moved the integration test suite out of the main test suite. It starts a bunch of processes that don't get canceled (eating up CPU locally). So now they're run only in CI by default (and via the
just integrations-test, if you really want).What?
justfile.gitignore)See Also
DEVSDK-2325