# @hybrbase/jest-config

> A shareable jest configuration for projects.

Latest version **0.0.0** (published 2024-01-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @hybrbase/jest-config
pnpm add @hybrbase/jest-config
yarn add @hybrbase/jest-config
bun add @hybrbase/jest-config
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.0 |
| Published | 2024-01-15 |
| First published | 2024-01-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Toby Bui |
| Maintainers | tobybuicom |
| Keywords | jest-config |

## Links

- npm: https://www.npmjs.com/package/@hybrbase/jest-config
- Repository: https://github.com/hybrbase/hb-next-boilerplate
- Homepage: https://github.com/hybrbase/hb-next-boilerplate/tree/master/packages/jest-config
- Issues: https://github.com/hybrbase/hb-next-boilerplate/issues
- npm.io page: https://npm.io/package/@hybrbase/jest-config

## Dependencies (3)

- [ts-jest](https://npm.io/package/ts-jest.md) 29.1.0
- [jest-watch-typeahead](https://npm.io/package/jest-watch-typeahead.md) 2.2.2
- [jest-environment-jsdom](https://npm.io/package/jest-environment-jsdom.md) 29.5.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.0.0 (latest) — 2024-01-15

## README

# Shareable Secretlint Config

## 📄 About

Shareable configuration for [Secretlint](https://github.com/secretlint/secretlint) — a tool for linting and fixing secrets in your codebase.

The configuration provides a set of rules and settings that can be easily shared and reused across different projects, reducing the amount of boilerplate code needed to set up [Secretlint](https://github.com/secretlint/secretlint) in each project.

### → Purpose

Simplify the process of setting up Secretlint in a project by providing a pre-configured set of rules and settings. This package can be useful for developers who want to:

- Use Secretlint in their project but don't want to spend time configuring it from scratch
- Share Secretlint configuration across multiple projects
- Avoid maintaining and updating Secretlint configuration in every project manually

The configuration includes a set of preconfigured rules, such as `@secretlint/secretlint-rule-preset-recommend`, that check for common mistakes and prevent secrets from being accidentally committed to the repository.

<br>

## 💿 Installation

To use Secretlint with `@hybrbase/secretlint-config` in a mono-repository, you can install them at the root level and configure it to lint only the packages that require it. Follow these steps:

1. Install `secretlint` and `@hybrbase/secretlint-config` as development dependencies at the root of your mono-repository using the package manager of your choice (`npm`, `yarn`, `pnpm`, etc.). For example, using `pnpm`:

   ```bash
   pnpm add -Dw secretlint @hybrbase/secretlint-config
   ```

2. Create a `.secretlintrc.json` configuration file in the root of your mono-repository with the following content:

   ```json
   {
     "rules": {},
     "rulesConfig": {},
     "plugins": [],
     "processor": "",
     "noDefaultConfig": true,
     "configs": {
       "@hybrbase/secretlint-config": true
     },
     "ignore": [],
     "include": ["packages/*/**", "apps/*/**"]
   }
   ```

   In this example, Secretlint is configured to use the `@hybrbase/secretlint-config` package as its configuration, and to lint only the directories in the `packages` and `apps` folders of the mono-repository.

   You can adjust the `include` and `exclude` patterns to match your specific mono-repository structure and exclude files or directories that don't need to be linted.

3. Add a linting script to the `scripts` section of the `package.json` file at the root of your mono-repository:

   ```bash
   pnpm pkg set scripts.lint:secrets="secretlint"
   ```

   This will add the `lint:secrets` script to the `scripts` section of your `package.json`.

That's it! You can now run the `lint:secrets` script to lint the relevant packages in your mono-repository.

---
_Source: https://npm.io/package/@hybrbase/jest-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._