https://microsoft.github.io/boll/

monorepo linting tool
https://microsoft.github.io/boll/

lint monorepo nodejs

Last synced: about 2 months ago
JSON representation

monorepo linting tool

• Host: GitHub
• URL: https://microsoft.github.io/boll/
• Owner: microsoft
• License: mit
• Created: 2020-08-24T21:42:36.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-19T05:38:13.000Z (7 months ago)
• Last Synced: 2024-11-05T10:44:04.746Z (2 months ago)
• Topics: lint, monorepo, nodejs
• Language: TypeScript
• Homepage: https://microsoft.github.io/boll/
• Size: 4.59 MB
• Stars: 15
• Watchers: 4
• Forks: 9
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# boll

Lint the whole repo.

## Getting started

### Install

To install, add `@boll/cli` as a dev dependency to your package with

your package manager of choice.

```sh

npm install --save-dev @boll/cli

```

### Configure

Next, run the `init` command to generate a configuration file that

will be used when boll runs.

```sh

npx boll init

```

This command will create a configuration file called `.boll.config.js`

in your current directory, implementing the recoommended configuration

by default. It should look like the following.

```js

"use strict";

module.exports = {

  extends: "boll:recommended"

};

```

### Run

To run `boll`, simply pass the `run` command.

```sh

npx boll run

```

If everything is configured successfully and your project contains no

boll violations, the command will exit with no output and an exit

status of `0`.

### Next steps

Learn about configuring, tweaking, or adding rules in [the docs](https://microsoft.github.io/boll/).

## Contributing

This project welcomes contributions and suggestions.  Most contributions require you to agree to a

Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us

the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide

a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions

provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).

For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or

contact [[email protected]](mailto:[email protected]) with any additional questions or comments.