Skip to content
main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 

gro

opinionated webdev toolkit

pre-alpha: suitable only for the curious and reckless

Windows is not yet supported. WSL works well enough

heads up: For now, consider Gro's free software free as in puppy, meaning you're aware it's a lot of work to maintain, and you're inviting it into your home anyway. Docs are lacking, some things are in progress, and it might pee on your stuff. (caveat emptor: it's cute and quickly becomes a member of the family) SvelteKit and Vite are probably what you're looking for, but! you might find some interesting or useful things here! Please open issues for questions or discussion and see contributing.md for more.

about

Gro is an opinionated webdev toolkit that complements SvelteKit for making web frontends, servers, and libraries. It includes:

docs

install

depends on node >= 16.6

Normally you'll want to install Gro as a dev dependency:

npm i -D @feltcoop/gro

It's handy to install globally too:

npm i -g @feltcoop/gro
gro # prints available tasks - defers to the project's locally installed version of Gro

usage

gro # print all available tasks with the pattern `*.task.ts`
gro help # same as `gro`
gro --help # same as `gro`
gro some/dir # list all tasks inside `src/some/dir`
gro some/file # run `src/some/file.task.ts`
gro some/file.task.ts # same as above
gro test # run `src/test.task.ts` if it exists, falling back to Gro's builtin
gro test --help # print info about the "test" task; works for every task

Gro has a number of builtin tasks that you can run with the CLI. To learn more see the task docs and the generated task index.

gro dev # start developing in watch mode
gro dev -- svelte-kit --port 3003 # forward args by separating sections with --
gro build # build everything for production

Testing with uvu:

gro test # run all tests for `*.test.ts` files with `uvu`, forwarding CLI args

Check all the things:

gro check # does all of the following:
gro typecheck # typecheck JS/TypeScript and Svelte
gro test # run tests
gro gen --check # ensure generated files are current
gro format --check # ensure everything is formatted
gro lint # eslint

Formatting with prettier:

gro format # format all of the source files using Prettier
gro format --check # check that all source files are formatted

Codegen with gen:

gro gen # run codegen for all `*.gen.*` files
gro gen --check # error if any generated files are new or different

To deploy: (also see src/docs/deploy.md)

gro deploy # build and push to the `deploy` branch

To publish: (also see src/docs/publish.md)

gro publish patch # bump version, publish to npm, and git push
gro publish major --and args --are forwarded --to 'npm version'

Etc:

gro clean # delete all build artifacts from the filesystem
gro clean --svelte --nodemodules --git # also deletes dirs and prunes git branches
gro --version # print the Gro version

develop

npm i
npm run bootstrap # build and link `gro` - needed only once
gro test # make sure everything looks good - same as `npm test`

# development
gro dev # start SvelteKit and other plugins, like API servers; usually you'll keep this running
gro build # update the `gro` CLI locally

# use your development version of `gro` locally in another project
cd ../otherproject
npm link ../gro

# release
gro build # build for release and update the `gro` CLI

contributing

see contributing.md🌄

credits 🐢🐢🐢

Gro builds on TypeScriptSvelteSvelteKitesbuilduvumrifs-extraPrettiersvelte-checkJSON Schemajson-schema-to-typescript & more

license 🐦

MIT

About

opinionated webdev toolkit 🌰 work in progress

Topics

Resources

License

Stars

Watchers

Forks

Languages