# js-auto-configuration-for-rule-management

> the purpose is to have a way to write [Rules](https://github.com/Megamanjoker/js-rule-management/blob/main/src/rule.js) to add to a [Rule Manager](https://github.com/Megamanjoker/js-rule-management/blob/main/src/rule-manager.js)

Latest version **1.0.1** (published 2023-06-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install js-auto-configuration-for-rule-management
pnpm add js-auto-configuration-for-rule-management
yarn add js-auto-configuration-for-rule-management
bun add js-auto-configuration-for-rule-management
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-06-18 |
| First published | 2023-06-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 37.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | megamanjoker |

## Links

- npm: https://www.npmjs.com/package/js-auto-configuration-for-rule-management
- Repository: https://github.com/Megamanjoker/js-auto-configuration-for-rule-management
- Homepage: https://github.com/Megamanjoker/js-auto-configuration-for-rule-management#readme
- Issues: https://github.com/Megamanjoker/js-auto-configuration-for-rule-management/issues
- npm.io page: https://npm.io/package/js-auto-configuration-for-rule-management

## Dependencies (2)

- [glob](https://npm.io/package/glob.md) ^10.2.7
- [js-rule-management](https://npm.io/package/js-rule-management.md) ^1.0.7

## Recent versions

- 1.0.1 (latest) — 2023-06-18
- 1.0.0 — 2023-06-18

## README

# js-auto-configuration-for-rule-management

## What is the purpose of this project?
the purpose is to have a way to write [Rules](https://github.com/Megamanjoker/js-rule-management/blob/main/src/rule.js) to add to a [Rule Manager](https://github.com/Megamanjoker/js-rule-management/blob/main/src/rule-manager.js)

## How do I use this project?
1. Create a rule.config.json at the root directory
2. Add a json with a rulePaths property
   1. This can be a String or Array of Strings
   2. The string must be formatted like [Glob](https://github.com/isaacs/node-glob)
      1. Example - "**/rules"
   2. The string will have "../" prefixed to the path for the require()
   3. The string will have "/*.js" suffixed to the path for the require()
4. create a new AutoConfiguration
5. run the AutoConfiguration.generateRuleManager to get a [Rule Manager](https://github.com/Megamanjoker/js-rule-management/blob/main/src/rule-manager.js)

---
_Source: https://npm.io/package/js-auto-configuration-for-rule-management · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._