2023-04-21 16:06:21 +00:00
|
|
|
#!/usr/bin/env sh
|
|
|
|
|
. "$(dirname -- "$0")/_/husky.sh"
|
|
|
|
|
|
add docs for TLShapeUtil (#1215)
This PR adds docs for the methods in the TLShapeUtil class.
I think that it's a good page to have docs on, as it shows people what's
possible with the custom shape API.
Currently, our docs are not showing `@param` info for lots of methods,
including the ones added in this PR.
I'll do fix for that in a follow-up PR, so that it's easier to review.
---
Note: Moving forward, we probably want to consider **_where_** these
docs are shown, and how we achieve that.
For example, do we put the docs for these methods in:
* The docs page for the `TLShapeUtil` class?
* The docs pages for the handler types, eg:
[`OnResizeHandler`](http://localhost:3000/gen/editor/OnResizeHandler-type)?
* Both?
Right now, I opted for putting them in the the TLShapeUtil class, as it
keeps them all in one place, and it's what we already do for some
others.
We should consider both - what works best for the docs? and what works
best for code editors?
---
This PR also includes a fix to our pre-commit step that @SomeHats did.
2023-05-05 14:05:25 +00:00
|
|
|
# if the folder we're in is called "bublic", set YARN_RC_FILENAME:
|
|
|
|
|
if [ "$(basename "$(pwd)")" = "bublic" ]; then
|
|
|
|
|
export YARN_RC_FILENAME=.yarnrc-private.yml
|
|
|
|
|
fi
|
|
|
|
|
|
2023-05-04 09:25:31 +00:00
|
|
|
npx lazy run build-api
|
2023-04-21 16:06:21 +00:00
|
|
|
git add packages/*/api-report.md
|
2023-05-04 09:25:31 +00:00
|
|
|
npx lint-staged
|