# marech-core

Latest version **1.0.0** (published 2021-02-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install marech-core
pnpm add marech-core
yarn add marech-core
bun add marech-core
```

## 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.0 |
| Published | 2021-02-11 |
| First published | 2019-01-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Gabriel Rodrigues |
| Maintainers | antunesrodrigues |

## Links

- npm: https://www.npmjs.com/package/marech-core
- Repository: https://github.com/guesant/marech
- Homepage: https://github.com/guesant/marech#readme
- Issues: https://github.com/guesant/marech/issues
- npm.io page: https://npm.io/package/marech-core

## Dependencies (5)

- [domutils](https://npm.io/package/domutils.md) ^2.4.4
- [css-select](https://npm.io/package/css-select.md) ^3.1.2
- [domhandler](https://npm.io/package/domhandler.md) ^4.0.0
- [htmlparser2](https://npm.io/package/htmlparser2.md) ^6.0.0
- [dom-serializer](https://npm.io/package/dom-serializer.md) ^1.2.0

## Recent versions

- 1.0.0 (latest) — 2021-02-11
- 0.3.0 — 2019-02-03
- 0.2.1 — 2019-01-23
- 0.2.0 — 2019-01-23
- 0.1.3 — 2019-01-22
- 0.1.2 — 2019-01-22
- 0.1.1 — 2019-01-22
- 0.1.0 — 2019-01-22

## README

# marech

Ultimate, simple, powerful and extensible precompiler.

## Install & Usage

### CLI

#### Install CLI

```sh
npm install marech-cli
```

#### Setup the `marech.config.js` file

```ts
// marech.config.js

const { generateConfig } = require("marech-cli");

module.exports = generateConfig(__dirname, {
  output: "./build",
  input: { path: "./src/website", match: "**/*.html" },
  // rules: {
  //   // prettier: { enabled: false, options: {} },
  //   // htmlMinifier: { enabled: false, options: {} },
  //   // mappedPaths: { "@/(**)": join(__dirname, "./src/$1") },
  // },
});
```

#### Build the project

```sh
npx marech build [-p marech.config.js]
```

#### watch mode

```sh
npx marech build --watch [-p marech.config.js]
```

Use the flag `--watchConfig` to watch the `marech.config.js` file.

Have fun!

## Features

### Core

- AbstractFileSystem.

- AbstractTransformer.

### Command-Line Interface

- Follows [marech.config.js](#cli).

- `marech build` and `marech build --watch`.

## See also

Greats projects used or that have inspired the marech project:

- [Sergey](https://github.com/trys/sergey)

- [Webpack](https://webpack.js.org)

- [Prettier](https://prettier.io)

## License

- MIT - see [LICENSE.mit.txt](LICENSE.mit.txt) or <https://opensource.org/licenses/MIT>

## Author

- Gabriel Rodrigues - <https://github.com/guesant>

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