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

  1. git init (optional, bebbi-scripts will install pre-commit hooks)

  2. 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

kcd-scripts
react-scripts

๐Ÿ’ก Bugs and Features

Help us by adding pull requests to issues!

Contributors

amaster507
verneleem
bebbi

License

MIT