README.md
November 19, 2024 ยท View on GitHub
bebbi-scripts ๐ ๐ฆ
CLI toolbox for common project scripts
What
Maintain library projects.
Commands for init, validate, test, lint, format, build.
Like kcd-scripts, but
โ
written in TS
โ
tsc builds
โ
outputs esm, cjs, types
โ
handles ERR_UNSUPPORTED_DIR_IMPORT issues
โ
yarn berry
โ
yarn workspace
โ
customize
๐ซ yarn pnp
๐ซ npm
โ ๏ธ Windows: not working on Powershell/scoop.sh, your support appreciated
How
Inside your new module folder, run
-
git init(optional, bebbi-scripts will install pre-commit hooks) -
yarn dlx bebbi-scripts init
The script assumes that your input is src, outDir is dist
Overriding Config
tsconfig.json
{
"extends": "bebbi-scripts/tsconfig.json",
"others_are_optional": "..."
}
eslint
You can extend the react-scripts eslint config which ships with this package.
Example package.json section:
{
"eslintConfig": {
"extends": ["react-app"],
"other": "..."
}
}
Customizing bebbi-scripts
To fully customize bebbi-scripts, make it a dependency of your own script.
Check out gig-utils for a module that extends bebbi-scripts with a config for babel and storybook.
Note that if you have a typecheck script (normally set to bebbi-scripts typecheck)
that will be run as part of the validate script (which is run as part of the pre-commit script as well).
Inspiration
๐ก Bugs and Features
Help us by adding pull requests to issues!
Contributors
License
MIT